Path
POST
/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/orders/invoices
Example Endpoint
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/orders/invoices
Request Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
Vendor ID
Unique code Coupang issues to vendors
e.g. A00012345 |
||||
Body Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
Vendor ID
Unique code Coupang issues to vendors
e.g. A00012345
|
||||
| orderSheetInvoiceApplyDtos | O | Object |
List of orders to be changed to Shipped
|
||||
| shipmentBoxId | O | Number |
Delivery number (=bundled delivery number)
shipmentBoxId of product already shipped is changed for split deliveries.
(check with
orderId via single PO query API)
The ID is required, otherwise uploading will fail.
|
||||
| orderId | O | Number |
Order number
|
||||
| deliveryCompanyCode | O | String |
Courier code
Please input the right courier code otherwise the request would fail.
Please Go to Courier Code
|
||||
| invoiceNumber | O | String |
Waybill (invoice) number
Selected for split delivery. If not, enter blank "" .
For split deliveries enter either the waybill number or the estimated shipment date (one of the two).
For direct courier deliveries (DIRECT), only random numbers can be entered. Delivery tracking is not supported. |
||||
| vendorItemId | O | Number |
optionId
Enter the option ID of the product that the waybill is to be uploaded for.
For split shipping, submit each
vendorItemId of the
shipmentBoxId.
|
||||
| splitShipping | O | Boolean |
Split shipping Y/N
● false (single shipping)
Shipping all items in 1 order with 1 waybill number ● true (split shipping) If splitting items in 1 order and shipping them separately with several waybill numbers |
||||
| preSplitShipped | O | Boolean |
Split-shipped Y/N
● false
If not split-shipped (=splitshipping false)
If processing split shipping for the order number for the first time ● true If there is already a split-shipped item in the order number |
||||
| estimatedShippingDate | O | String |
(Split shipping) estimated shipping date
Enter in YYYY-MM-DD format for split shipping (optional)
if date is not entered, enter blank as "".
Enter either the waybill number or the estimated shipping date.
|
||||
Request Example
{
"vendorId": "A00034612",
"orderSheetInvoiceApplyDtos": [
{
"shipmentBoxId": 123456789012345678,
"orderId": 4000019469460,
"vendorItemId": 3823839899,
"deliveryCompanyCode": "KDEXP",
"invoiceNumber": "20180731040123",
"splitShipping": false,
"preSplitShipped": false,
"estimatedShippingDate": ""
},
{
"shipmentBoxId": 123456789012345679,
"orderId": 4000019469460,
"vendorItemId": 3834780191,
"deliveryCompanyCode": "KDEXP",
"invoiceNumber": "20180731040123",
"splitShipping": false,
"preSplitShipped": false,
"estimatedShippingDate": ""
}
]
}Response Message
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | Number |
Server response code
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| message | String |
Server response message
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| data | Array |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| responseCode | Number |
Status message on the total request result
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| responseMessage | String |
Status message on the total request result
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| responseList | Array |
Result set for individual cases
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shipmentBoxId | Number |
Delivery 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": {
"responseCode": 0,
"responseMessage": "SUCCESS",
"responseList": [
{
"shipmentBoxId": 123456789012345678,
"succeed": true,
"resultCode": "OK",
"retryRequired": false,
"resultMessage": null
}
]
}
}Error Spec
| HTTP status code (error type) | Error message | Solution |
|---|---|---|
| 400 (check request variable) |
Incorrect waybill (invoice) number format for CJ Logistics. [6255*****632] |
Check if you have entered the correct waybill number. |
| 400 (check request variable) |
CJ Logistics waybill number must be digits only. InvoiceNumber must be number. [6257-6**2-10***] |
Check if you have entered the correct waybill number. Make sure the number does not include anything other than numbers. |
| 400 (check request variable) |
Waybill number (invoice number) of Direct Courier Delivery (DIRECT) orders must be digits only. [***] |
Enter the waybill number of Direct Courier Delivery (DIRECT) orders in digits. e.g. 202002031830 |
| 400 (check request variable) | invalid courier code: |
Check if you have entered the correct courier code (deliveryCompanyCode). |
| 400 (check request variable) | Incorrect waybill (invoice) number format for OO Logistics. [956****734] | Check if you have entered the correct waybill number. |
URL API Name
UPDATE_ORDER_SHIPPING_INFO