핸디봇에 출고 요청된 주문 건의 목록과 주문별 부여받은 송장번호를 조회합니다.
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
복사
Request
필드명 | 타입 | 설명 | 필수 |
page | number | 요청 페이지 (기본값: 1) | X |
pageSize | number | 요청 페이지 사이즈 (기본값: 20, 최대값: 500) | X |
createdAtFrom | string | 원장 주문 생성 시작일시 (yyyy-MM-dd) | X |
createdAtTo | string | 원장 주문 생성 마지막일시 (yyyy-MM-dd) | X |
confirmAtFrom | string | 송장 할당 시작일시 (yyyy-MM-dd) | X |
confirmAtTo | string | 송장 할당 마지막 일시 (yyyy-MM-dd) | X |
closeAtFrom | string | 송장 마감 시작일시 (yyyy-MM-dd) | X |
closeAtTo | string | 송장 마감 마지막일시 (yyyy-MM-dd) | X |
orderCode | string | 주문 번호 | X |
예시
{
"page": 1,
"pageSize": 10,
"createdAtFrom": "2020-12-07",
"createdAtTo": "2020-12-09",
"confirmAtFrom": "2020-12-07",
"confirmAtTo": "2020-12-09",
"closeAtFrom": "2020-12-07",
"closeAtTo": "2020-12-09",
}
JSON
복사
호출 파라미터 예시 1 - 기간 검색
{
"orderCode": "20201208_000001"
}
JSON
복사
호출 파라미터 예시 2 - 주문번호가 일치하는 건만 검색
Response
필드명 | 타입 | 설명 |
total | string | 데이터 총 개수 |
rows | object[] |
Response.rows
필드명 | 타입 | 설명 |
id | number | 주문 원장 ID |
channelName | string | 판매처명 |
orderCode | string | 판매처 주문 번호 |
code | string | 판매처 개별 주문 번호 |
subsidiaryCode | string | 보조 주문 번호 |
releaseCode | string | 합 배송번호 |
receiverData | object | 수취인 정보 |
receiverData.name | string | 수취인명 |
receiverData.phone | string | 수취인 연락처1 |
receiverData.mobile | string | 수취인 연락처2 |
receiverData.address | string | 수취인 주소 |
receiverData.postcode | string | 수취인 우편번호 |
customerData | object | 구매자 정보 |
customerData.name | string | 구매자명 |
customerData.phone | string | 구매자 연락처1 |
customerData.mobile | string | 구매자 연락처2 |
customerData.address | string | 구매자 주소 |
dealName | string | 상품명 |
dealOptionName | string | 상품 옵션명 |
createdAt | string | 주문 원장 생성일자 |
orderAt | string | 주문 일자 |
invoices | object[] | 송장 정보 |
invoices[0].invoiceId | string | 송장 ID |
invoices[0].invoiceCode | string | 송장 정보 |
invoices[0].isPrinted | boolean | 품고 내 송장 출력 여부 |
invoices[0].isClosed | boolean | 품고 내 송장 마감 여부 |
invoices[0].cargoStatusCodeKey | string | |
invoices[0].logisticsPartnerName | string | 택배사명 |
originalData | object | 원 주문 정보 |
canceledInvoices | object[] | 취소된 송장 정보 |
items | object[] | 상품 정보 |
price | string | 주문 금액 |
settlementPrice | string | 결제 금액 |
totalPaymentAmount | string | 최종 금액 |
settlementGroupPrice | string | 총 결제 금액 |
배송 상태 코드 (cargoStatusCodeKey)
배송 상태 코드 (cargoStatusCodeKey)
예시
{
"rows": [
{
"id": 478999,
"channelName": "스마트스토어(파트너)",
"orderCode": "test-230627-0001",
"code": null,
"subsidiaryCode": null,
"releaseCode": null,
"receiverData": {
"name": "테스트123",
"email": null,
"phone": null,
"mobile": "010-5678-5678",
"address": "경기도 시흥시 정왕동 2123-3 번지 (3~7F)",
"postcode": "12345",
},
"customerData": {
"name": "주문자이름",
"phone": "010-1234-1234",
"mobile": "010-1234-1234"
},
"orderAt": "2023-06-27T02:41:11.929Z",
"dealName": null,
"dealOptionName": null,
"createdAt": "2023-06-27T02:41:12.064Z",
"invoices": [{
"invoiceId": 456000,
"invoiceCode": "380424004285",
"isPrinted": true,
"isClosed": true,
"cargoStatusCodeKey": "INVOICE_CARGO_STATUS_DELIVERYCOMPLETED",
"logisticsPartnerName": "CJ대한통운"
}],
"canceledInvoices": [
{
"invoiceId": 606849,
"invoiceCode": null,
"isCanceled": true,
"cancelAt": "2023-06-27T02:57:00.973+00:00"
}
],
"items": [
{
"resourceId": 111691,
"partnerId": 52334,
"quantity": 3,
"resource_code": "ZERO_1",
"resource_name": "ZERO_1",
"resource_item_number": null,
"resource_option1": null,
"resource_option2": null,
"brandId": null,
"brand_name": null
}
],
"originalData": {},
"price": "10000",
"settlementPrice": "10000",
"totalPaymentAmount": "10000",
"settlementGroupPrice": "10000"
}
],
"total": "1"
}
JSON
복사
출고 지시 후 마감 전 결과 예시