핸디봇에 출고 요청된 주문 건의 목록과 주문별 부여받은 송장번호를 조회합니다.
curl -X POST "https://api.poomgo.com/open-api/oms/orders"
-H "Content-Type: application/json"
-H "accept: application/json"
-H "Authorization: KEY"
-d ""
Shell
복사
{
"page": 1,
"pageSize": 10,
"createdAtFrom": "2020-12-07", // optional
"createdAtTo": "2020-12-09", // optional
"confirmAtFrom": "2020-12-07", // optional
"confirmAtTo": "2020-12-09", // optional
"closeAtFrom": "2020-12-07", // optional
"closeAtTo": "2020-12-09", // optional
}
JSON
복사
호출 파라미터 예시 1 - 기간 검색
{
"orderCode": "20201208_000001"
}
JSON
복사
호출 파라미터 예시 2 - 주문번호가 일치하는 건만 검색
{
"rows": [
{
"id": 435858,
"channelName": "스마트스토어",
"orderCode": "20201208_000001",
"code": null,
"subsidiaryCode": null,
"releaseCode": null,
"receiverData": {
"name": "김지민",
"phone": null,
"mobile": "01033445566",
"address": "서울특별시 마포구 양화로 147 4층",
"postcode": "03995"
},
"dealName": "열린 통신 12월 선물 세트",
"dealOptionName": null,
"createdAt": "2020-12-07T22:51:19.198Z",
"invoices": null,
"originalData": null
}
],
"total": "1"
}
JSON
복사
출고 지시 후 마감 전 결과 예시
1.
포장이 완료되어 송장번호가 부여되면 invoices 속성에 배열로 송장번호 N개가 담깁니다.
invoices 배열 안에 다음과 같이 송장정보가 담깁니다.
"invoices": [
{
"invoiceId": 456000,
"invoiceCode": "380424004285",
"isPrinted": true,
"isClosed": true,
"cargoStatusCodeKey": "INVOICE_CARGO_STATUS_DELIVERYCOMPLETED",
"logisticsPartnerName": "CJ대한통운"
}
],
JavaScript
복사
1.
invoiceCode: 택배사 송장번호
2.
isPrinted: 품고에서 송장 출력 여부
3.
isClosed: 품고에서 포장 마감 여부
4.
cargoStatusCodeKey: 배송 상태
a.
품고에서 포장 마감해도 택배사 전산에 연동되기까지 시간 간격이 있어서 cargoStatusCodeKey 값이 null일 수 있습니다. 스케줄러의 통신에 의해 아래 값이 일정 간격으로 갱신됩니다.
i.
미입력 (null)
ii.
집하지시
iii.
미집하
iv.
집하처리
v.
간선상차
vi.
간선하차
vii.
미배송
viii.
배송출발
ix.
배송완료
배송상태 코드 (cargoStatusCodeKey)
INVOICE_CARGO_STATUS_DELIVERYCOMPLETED 배송완료
INVOICE_CARGO_STATUS_UNDELIVERED 미배송
INVOICE_CARGO_STATUS_STARTDELIVERY 배송출발
INVOICE_CARGO_STATUS_GETOUTTRUNK 간선하차
INVOICE_CARGO_STATUS_GETONTRUNK 간선상차
INVOICE_CARGO_STATUS_UNCOLLECTED 미집하
INVOICE_CARGO_STATUS_COLLECTIONPROCESSING 집하처리
INVOICE_CARGO_STATUS_COLLECTIONDIRECTION 집하지시