※ If the list includes orders that have been partially canceled and being refunded, the message "Unable to change the delivery status. Check the order history." will be returned.
After the refund has been completed, orders that include non-canceled items can be changed to Product in Preparation.
<Note> After changing the status to Product in Preparation, YOU MUST look up and update individual orders to see if the shipping address has been changed, in case the customer has changed it while at Payment Complete.
Path
PATCH PUT
/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/ordersheets/acknowledgement
Example Endpoint
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/ordersheets/acknowledgement
Request Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
Vendor ID
Unique code Coupang issues to seller
e.g.
A00012345
|
||||
Body Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
Vendor ID
Unique code Coupang issues to seller
e.g.
A00012345
|
||||
| shipmentBoxIds | O | Array |
List of bundled shipping numbers to be changed to Product in Preparation state
Request up to 50 at a time
|
||||
Request Example
{
"vendorId": "A00012345",
"shipmentBoxIds": [
123456789012345679,
123456789012345678
]
}Response Message
| Name | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | Number |
Server response code
|
||||||||||||||
| message | String |
Server response message
|
||||||||||||||
| data | OrderSheetResponse |
Ordersheet state change api call result
|
||||||||||||||
| responseKey | Number |
Distinct value for request
System meta data
|
||||||||||||||
| responseCode | Number |
Status code for the entire request result
|
||||||||||||||
| responseMessage | String |
Status message for the entire request result
|
||||||||||||||
| responseList | Array |
Result set for individual case
|
||||||||||||||
| shipmentBoxId | Number |
Bundled shipping number
|
||||||||||||||
| succeed | Boolean |
Success Y/N
|
||||||||||||||
| resultCode | String |
Result code
|
||||||||||||||
| resultMessage | String |
Result message
|
||||||||||||||
| retryRequired | Boolean |
Retry Y/N
|
||||||||||||||
Response Example
{
"code": "200",
"message": "OK",
"data": {
"responseKey": -7326489997410940000,
"responseCode": 1,
"responseMessage": "apply instructStatus result - Partial errors.",
"responseList": [
{
"shipmentBoxId": 123456789012345678,
"succeed": true,
"resultCode": "OK",
"retryRequired": false,
"resultMessage": "request succeeded."
},
{
"shipmentBoxId": 123456789012345679,
"succeed": false,
"resultCode": "NOT_FOUND_SHIPMENT_BOX",
"retryRequired": true,
"resultMessage": "shipmentBoxId (123456789012345679) is not found."
}
]
}
}Error Spec
| HTTP status code (error type) | Error message | Solution |
|---|---|---|
| 200 (check request variable) |
"responseCode":99, "resultMessage": "Unable to change delivery status. Check order history." |
Message shown when the request includes orders that are being refunded due to full or partial cancellation. After the refund has been completed, orders that include non-canceled items can be changed to Product in Preparation. |
| 200 (check request variable) | "responseCode":99, "resultMessage": "Unable to change delivery status. Check order history." |
Only orders at Payment Complete can be changed to Product in Preparation. Check the order status via single PO query API to see if it has already been changed to Product in Preparation or Shipped. |
| 200 (check request variable) | "OK Failed shipmentBoxIds: [1241***103, 124***0026, 1241***223]" |
Check if the bundled shipping number (shipmentBoxIds) displayed is at Product in Preparation of Shipped. |
| 500 (sever error) | "code":500, "message" : "com.coupang.apigateway.pylon.ApiPreconditionException: Timeout waiting for connection from pool" |
This is a temporary error due to an increase in the internal system load. Request again after a certain period of time. |
| 504 (sever error) | "code" : "ERROR", "message" : "Request timed out, if the situation continues consider applying timeout extension." |
This is a temporary error due to an increase in the internal system load. Check whether the order has been changed to Product in Preparation with the single PO query API, and if there is no change, retry after a certain period of time. |
| 521 (sever error) | "code" : "ERROR", "message" : "connection timed out: aws-openapi.coupang.net/10.211.51.172:80" | This is a temporary error due to an increase in the internal system load. Check whether the order has been changed to Product in Preparation with the single PO query API, and if there is no change, retry after a certain period of time. |
URL API Name
UPDATE_ORDERSHEET_STATUS