배송지 목록 조회
- REQUSET (CURL / GET)
curl --request GET \
--url https://apis.openapi.sk.com/tms/orderList \
--header 'Accept: application/json' \
--header 'appKey: My Project의 Project Key'
- RESPONSE (200 | application/json)
{
"resultCode": "200",
"resultCount": 2,
"resultMessage": "success",
"resultData":[
{
"updateDate": "2019-08-23 15:49:50",
"address": "경기 안산시 단원구 와동 837-2.302호",
"orderId": "order01",
"latitude": 37.332643,
"serviceTime": 10,
"deliveryWeight": 100,
"closeTime": "",
"adminCode": "",
"postCode": "",
"deliveryVolume": 0,
"openTime": "",
"deliveryCount": 0,
"seq": 18700,
"vehicleType": "01",
"zoneCode": "",
"orderName": "안산지점01",
"longitude": 126.819828
},
{
"updateDate": "2019-08-23 15:49:50",
"address": "경기 안산시 단원구 선부1동 주공11단지아파트 1122동 205호",
"orderId": "order02",
"latitude": 37.331764,
"serviceTime": 10,
"deliveryWeight": 100,
"closeTime": "",
"adminCode": "",
"postCode": "",
"deliveryVolume": 0,
"openTime": "",
"deliveryCount": 0,
"seq": 18701,
"vehicleType": "01",
"zoneCode": "",
"orderName": "안산지점02",
"longitude": 126.812044
}
]
}
- 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 | 순번 |
orderId | String | Y | order01 | 배송지 아이디 |
orderName | String | N | 마포지점01 | 배송지 이름 |
address | String | N | 서울특별시 마포구 독막로 291 | 배송지 주소 |
latitude | Number | Y | 37.54468 | 배송지 위도 |
longitude | Number | Y | 126.945455 | 배송지 경도 |
vehicleType | String | N | 01 | 차량 유형(01:상온, 02: 냉장/냉동, 99:기타)차량정보와 배송지정보의 차량유형을 기준으로 배차 시 유형이 같은 배송지와 차량으로 배차 됩니다. |
serviceTime | Number | N | 10 | 서비스 타임(배송 시 배송지에서 걸리는시간, 단위 : 분) |
zoneCode | String | N | 0001 | 권역 코드 |
deliveryWeight | Number | Y | 15 | 배송 무게 (단위 : Kg) |
updateDate | String | Y | 2019-08-27 15:49 | 저장 일시 |
deliveryVolume | Number | N | 0.027 | 배송부피 (단위 : cbm) ex)가로 30cm, 세로 30cm, 높이30cm 0.3 0.3 0.3 = 0.027 cbm |
배송지 추가
- REQUSET (CURL / GET)
curl --request GET \
--url 'https://apis.openapi.sk.com/tms/orderInsert?vehicleType=01' \
--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/orderListInsert \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'appKey: My Project의 Project Key'
- REQUEST (SAMPLE CODE)
{
"reqDatas": [
{
"orderId": "order01",
"orderName": "%EC%A3%BC%EB%AC%B81",
"address": "%EC%84%9C%EC%9A%B8%EC%8B%9C+%EB%A7%88%ED%8F%AC%EA%B5%AC+%EC%99%80%EC%9A%B0%EC%82%B0%EB%A1%9C29%EA%B0%80%EA%B8%B8+69",
"latitude": "37.557607",
"longitude": "126.925516",
"deliveryWeight": "10"
},
{
"orderId": "order02",
"orderName": "%EC%A3%BC%EB%AC%B82",
"address": "%EC%84%9C%EC%9A%B8%EC%8B%9C+%EB%A7%88%ED%8F%AC%EA%B5%AC+%EC%99%80%EC%9A%B0%EC%82%B0%EB%A1%9C29%EA%B0%80%EA%B8%B8+69",
"latitude": "37.557607",
"longitude": "126.926252",
"deliveryWeight": "10"
}
]
}
- 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/orderUpdate?vehicleType=01&serviceTime=10' \
--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 | String | Y | - | |
resultMessage | String | Y | 성공적으로 반영 되었습니다. | 결과 메시지 정보 입니다. |
배송지 삭제
- REQUSET (CURL / GET)
curl --request GET \
--url https://apis.openapi.sk.com/tms/orderDelete \
--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 | 성공적으로 반영 되었습니다. | 결과 메시지 정보 입니다. |