<aside>
💡 * 품고나우에 등록된 마감된 송장내역을 조회합니다.
</aside>
Header
curl -X GET "<https://api.poomgo.com/open-api/invoice>"
-H "Content-Type: application/json"
-H "accept: application/json"
-H "Authorization: KEY"
Request
필드명 |
타입 |
설명 |
page |
number |
요청 페이지(기본값1) |
pageSize |
number |
요청 페이지 사이즈(기본값20) |
closedAtGte |
date |
송장 마감일시 시작일시 |
closedAtLte |
date |
송장 마감일시 종료일시 |
ids |
object[] |
송장 ID |
codes |
object[] |
송장번호 |
Response
필드명 |
타입 |
설명 |
page |
number |
현재 페이지 |
pageSize |
number |
현재 페이지 사이즈 |
order |
string |
정렬 기준 |
totalPage |
number |
전체 페이지수 |
rowCount |
number |
현재 행 수 |
total |
number |
전체 행 수 |
data |
object[] |
실제 데이터 |
Response - Data
필드명 |
타입 |
설명 |
invoiceId |
number |
송장ID |
invoiceSerial |
number |
송장번호 |
courierName |
string |
택배사명 |
partnerName |
number |
고객사명 |
brandName |
number |
브랜드명 |
trackingNumber |
number |
추적번호 |
origin |
object |
출발 정보 |
origin.countryCode |
string |
출발 국가코드 |
origin.administrativeArea |
string |
출발 State/Province/광역시/도 |
destination |
object |
도착 정보 |
destination.countryCode |
string |
도착 국가코드 |
destination.administrativeArea |
string |
도착 State/Province/광역시/도 |
recipient |
object |
수취인 정보 |
recipient.name |
string |
수취인명 |
items |
object[] |
상품 정보 |
items.name |
string |
상품명 |
items.code |
string |
바코드 |
items.itemNumber |
string |
관리번호 |
items.option |
string |
옵션명 |
items.quantity |
number |
수량 |
items.isGift |
boolean |
사은품여부 |
items.lot |
string |
로트명 |
items.expiry |
date |
소비기한 |
items.width |
number |
가로(x) |
items.depth |
number |
세로(y) |
items.height |
number |
높이(z) |
items.weight |
number |
무게(g) |
order |
object |
주문정보 |
order.orderId |
number |
주문ID |
order.channelName |
string |
판매처명 |
order.channelOrderId |
string |
주문번호 |
createdAt |
date |
생성일시 |
closedAt |
date |
마감일시 |
{
page: 1,
pageSize: 20,
order: string,
totalPage: 3,
rowCount: 20,
total: 50,
data: [{
"invoiceId": 1111,
"invoiceSerial": "123456789",
"courierName": "한진택배",
"partnerName": "고객사",
"brandName": "브랜드",
"trackingNumber": "987654321",
"origin": {
"countryCode": "KR",
"administrativeArea": null
},
"destination": {
"countryCode": "JP",
"administrativeArea": null
},
"recipient": {
"name": "수취인"
},
"items": [{
"name": "상품명",
"code": "바코드",
"itemNumber": "관리번호",
"option": "옵션값1 + 옵션값2",
"quantity": 2,
"isGift": false,
"lot": "로트명",
"expiry": "소비기한",
"width": 10,
"depth": 15,
"height": 20,
"weight": 300
}],
"order": {
"orderId" : 1234,
"channelName": "판매처",
"channelOrderId": "주문번호",
},
"createdAt": "2024-01-01T01:00:00Z",
"closedAt": "2024-01-02T02:00:00Z",
}]
}