Search the delivery status history of an order.
Path
GET
/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/ordersheets/{shipmentBoxId}/history
Example Endpoint
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/ordersheets/{shipmentBoxId}/history
Request Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
Vendor ID
Unique code Coupang issues to seller
e.g.
A00012345
|
||||
| shipmentBoxId | O | Number |
Bundled shipping number
Available through PO list search API
|
||||
Request Example
not require body
Response Message
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | Number |
Server response code
|
||||||||||||||||||
| message | String |
Server response message
|
||||||||||||||||||
| data | Array |
Payment complete list
|
||||||||||||||||||
| shipmentBoxId | Number |
Bundled shipping number
|
||||||||||||||||||
| details | Array |
History details
|
||||||||||||||||||
| deliveryStatus | String |
Delivery status
|
||||||||||||||||||
| deliveryStatusDesc | String |
Delivery status description
|
||||||||||||||||||
| updatedAt | String |
Time changed
yyyy-MM-dd'T'hh:mm:ss
|
||||||||||||||||||
Response Example
{
"shipmentBoxId": 396844285,
"details": [
{
"deliveryStatus": "FINAL_DELIVERY",
"deliveryStatusDesc": "배송완료",
"updatedAt": "2017-06-08T14:03:06"
},
{
"deliveryStatus": "DELIVERING",
"deliveryStatusDesc": "배송중",
"updatedAt": "2017-06-07T10:12:56"
},
{
"deliveryStatus": "DEPARTURE",
"deliveryStatusDesc": "배송지시",
"updatedAt": "2017-06-07T09:52:30"
},
{
"deliveryStatus": "INSTRUCT",
"deliveryStatusDesc": "상품준비중",
"updatedAt": "2017-06-02T16:17:04"
},
{
"deliveryStatus": "ACCEPT",
"deliveryStatusDesc": "결제완료",
"updatedAt": "2017-06-02T15:36:31"
}
]
}Error Spec
| HTTP Status code (error type) | Error message | Solution |
|---|---|---|
| 400 (check request variable) | Invalid vendor ID |
Check if the vendor ID (vendorId) has been entered correctly. |
| 500 (check request variable) | Internal Exception |
Check if the bundled shipping number (shipmentBoxId) has been entered correctly. |
URL API Name
GET_ORDERSHEET_HISTORY