차량 목록조회
- REQUSET (CURL / GET)
curl --request GET \
--url https://apis.openapi.sk.com/tms/vehicleList \
--header 'Accept: application/json' \
--header 'appKey: My Project의 Project Key'
- RESPONSE (200 | application/json)
{
"resultCode": "200",
"resultCount": 2,
"resultMessage": "success",
"resultData":[
{
"vehicleName": "12가1234",
"updateDate": "2019-08-23 15:49:39",
"startAddress": "",
"weight": 10,
"endLatitude": 0,
"speed": 0,
"volume": 0,
"costPerHour": 0,
"startLatitude": 0,
"waitcostPerHour": 0,
"endLongitude": 0,
"vehicleId": "vehicle01",
"startLongitude": 0,
"costPerKm": 0,
"seq": 557,
"endAddress": "",
"vehicleType": "01",
"zoneCode": ""
},
{
"vehicleName": "56너5678",
"updateDate": "2019-08-23 15:49:39",
"startAddress": "",
"weight": 10,
"endLatitude": 0,
"speed": 0,
"volume": 0,
"costPerHour": 0,
"startLatitude": 0,
"waitcostPerHour": 0,
"endLongitude": 0,
"vehicleId": "vehicle02",
"startLongitude": 0,
"costPerKm": 0,
"seq": 558,
"endAddress": "",
"vehicleType": "01",
"zoneCode": ""
}
]
}
- RESPONSE (PARAMETERS)
| Name | Type | Mandatory | Example | Description |
|---|---|---|---|---|
| resultCode | String | Y | 200 | HTTP Status Code |
| resultCount | Number | Y | 1 | 차량 목록의 카운트 정보입니다. |
| resultMessage | String | Y | success | 결과 메시지 정보 입니다. |
| resultData | Node | Y | 차량 목록 정보입니다. | |
| seq | Number | Y | 1 | 순번 |
| vehicleId | String | Y | vehicle01 | 차량 아이디 |
| vehicleName | String | N | 12가1234 | 차량 이름 |
| weight | Number | Y | 10 | 최대 적재량 (단위 : ton) |
| vehicleType | String | Y | 01 | 차량 유형(01:상온, 02: 냉장/냉동, 99:기타) 차량정보와 배송지정보의 차량유형을 기준으로 배차 시 유형이 같은 배송지와 차량으로 배차 됩니다. |
| zoneCode | String | N | 0001 | 권역 코드 |
| updateDate | String | Y | 2019-08-27 15:49 | 저장 일시 |
| endLongitude | Number | Y | 127.062395 | 차량 도착지 경도 (설정 시 최종 도착 지점이 센터가 아닌 설정한 좌표로 이동 됩니다.) |
| endLatitude | Number | Y | 37.54468 | 차량 도착지 위도 (설정 시 최종 도착 지점이 센터가 아닌 설정한 좌표로 이동 됩니다.) |
| inputYn | String | Y | 1 | 차량 투입 여부 (1 : 투입 - default, 0 : 투입안함, 0 설정 시 해당 차량은 배차에서 제외 됩니다.) |
| skillPer | Number | Y | 100 | 차량의 숙련도(100 - default, 90, 80 ~ 10 까지 10단위로 설정 가능, 100보다 낮게 설정 시 설정한 % 만큼적은 배송지를 배차 받습니다.) |
| volume | Number | N | 27 | 최대 적재 부피 (단위 : cbm) ex)가로 3m, 세로 3m, 높이3m 3 3 3 = 27 cbm |
차량 추가
- REQUSET (CURL / GET)
curl --request GET \
--url 'https://apis.openapi.sk.com/tms/vehicleInsert?vehicleType=01&inputYn=1&skillPer=100' \
--header 'Accept: application/json' \
--header 'appKey: My Project의 Project Key'
- RESPONSE (200 | application/json)
{
"resultCode": "200",
"resultCount": 0,
"resultMessage": "성공적으로 반영 되었습니다."
}
- RESPONSE (PARAMETERS)
| Name | Type | Mandatory | Example | Description |
|---|---|---|---|---|
| resultCode | String | Y | 200 | HTTP Status Code |
| resultCount | Number | Y | - | |
| resultMessage | String | Y | 성공적으로 반영 되었습니다. | 결과 메시지 정보 입니다. |
차량 여러건 추가
- REQUEST (CURL / POST)
curl --request POST \
--url https://apis.openapi.sk.com/tms/vehicleListInsert \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'appKey: My Project의 Project Key' \
--data '
"{ \t\t \"vehicleId\":\"\", \t\t \"vehicleName\":\"\", \t\t \"weight\":\"\", \t\t \"vehicleType\":\"\", \t\t \"zoneCode\":\"\" \t }, \t { \t\t \"vehicleId\":\"\", \t\t \"vehicleName\":\"\", \t\t \"weight\":\"\", \t\t \"vehicleType\":\"\", \t\t \"zoneCode\":\"\" \t }, \t { \t\t \"vehicleId\":\"\", \t\t \"vehicleName\":\"\", \t\t \"weight\":\"\", \t\t \"vehicleType\":\"\", \t\t \"zoneCode\":\"\" \t } ] }"
'
- REQUEST (SAMPLE CODE)
{
"vehicleId":"vehicle01",
"vehicleName":"12%EA%B0%801234",
"weight":"8",
"vehicleType":"01",
"zoneCode":"0001"
},
{
"vehicleId":"vehicle02",
"vehicleName":"12%EA%B0%805678",
"weight":"10",
"vehicleType":"01",
"zoneCode":"0001"
},
{
"vehicleId":"vehicle03",
"vehicleName":"12%EA%B0%809012",
"weight":"15",
"vehicleType":"01",
"zoneCode":"0001"
}
]
}
- RESPONSE (200 | application/json)
{
"resultCode": "200",
"resultCount": 0,
"resultMessage": "성공적으로 반영 되었습니다."
}
- RESPONSE (PARAMETERS)
| Name | Type | Mandatory | Example | Description |
|---|---|---|---|---|
| resultCode | String | Y | 200 | HTTP Status Code |
| resultCount | Number | Y | - | |
| resultMessage | String | Y | 성공적으로 반영 되었습니다. | 결과 메시지 정보 입니다. |
차량 수정
- REQUSET (CURL / GET)
curl --request GET \
--url 'https://apis.openapi.sk.com/tms/vehicleUpdate?vehicleType=01&inputYn=1&skillPer=100' \
--header 'Accept: application/json' \
--header 'appKey: My Project의 Project Key'
- RESPONSE (200 | application/json)
{
"resultCode": "200",
"resultCount": 0,
"resultMessage": "성공적으로 반영 되었습니다."
}
- RESPONSE (PARAMETERS)
| Name | Type | Mandatory | Example | Description |
|---|---|---|---|---|
| resultCode | String | Y | 200 | HTTP Status Code |
| resultCount | Number | Y | ||
| resultMessage | String | Y | 성공적으로 반영 되었습니다. | 결과 메시지 정보 입니다. |
차량 삭제
- REQUSET (CURL / GET)
curl --request GET \
--url https://apis.openapi.sk.com/tms/vehicleDelete \
--header 'Accept: application/json' \
--header 'appKey: My Project의 Project Key'
- RESPONSE (200 | application/json)
{
"resultCode": "200",
"resultCount": 0,
"resultMessage": "성공적으로 반영 되었습니다."
}
- RESPONSE (PARAMETERS)
| resultCode | String | Y | 200 | HTTP Status Code |
| resultCount | Number | Y | - | |
| resultMessage | String | Y | 성공적으로 반영 되었습니다. | 결과 메시지 정보 입니다. |