Products Categories Brands Shipments & Orders Returns Exchanges Promotions & Coupons Logistics Info Customer Service Settlement CGF / CGF lite Rocket Growth

Shipments & Orders

POST/v2/providers/openapi/apis/api/v1/vendors/{vendorId}/orders/directIntegration/arrangeShipment2609170000

[For Taiwan Only]Arrange shipment for directly integrated courier

# 01

Summary

# 02

Details

Available buyer market: Taiwan

Arrange shipment to change the order status from product in preparation(INSTRUCT) to Shipped(DEPARTURE). This api doesn’t support splitting shipment yet, use Wing for splitting shipment.

Note: If the order status is not product in preparation(INSTRUCT) , this request will fail with error INVOICE NUMBER GENERATION FAILED.

There are currently four courier companies available.

Company Name	Type	deliveryCompanyCode
HomeDelivery-Kerry	Home delivery	TWL_KERRY
HomeDelivery-Hsin Chu	Home delivery	TWL_HCT
CVS-Familymart	CVS	TWL_FM
CVS-7-11	CVS	TWL_711

Path

POST/v2/providers/openapi/apis/api/v1/vendors/{vendorId}/orders/directIntegration/arrangeShipment

Example endpoint

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v1/vendors/A158000ABC/orders/directIntegration/arrangeShipment

URL API Name

UPDATE_ORDER_ARRANGE_SHIPMENT_FOR_DIRECT_INTEGRATED_COURIER

# 03

Path parameters

Name	Type	Description
vendorId*	string	Vendor ID Unique code Coupang issues to vendors e.g. A158000ABC

# 04

Response body

Response message

Name	Type	Description
success	boolean	True if arrange shipment completed successfully for this entry
errorKey	string	Text status for the per-item operation (e.g.“OK”).
errorMessage	string	Supplementary description of success/failure.
invoiceNumber	string	Waybill number
shipmentBoxId	number	Shipment No. (bundled shipment No.)
validationCode	string	Additional code required by certain couriers (only for 7-11)
invoiceNumberInvalidTim e	string	Expiration date time for the issued invoiceNumber (Requires ISO-8601 Compliance) e.g. 2025-09-02T13:54:39+08:00 or 2025-09-02T05:54:39Z

Response Example

{
  "12345": {
    "success": true,
    "errorKey": "",
    "errorMessage": "",
    "invoiceNumber": "12345556",
    "shipmentBoxId": 12345,
    "validationCode": "",
    "invoiceNumberInvalidTime": "2025-09-02T13:54:39+08:00"
  }
}

# 05

Error codes

HTTP	Code	Message
400	HTTP_400	Bad Request

Error specification

HTTP	Type	Error message	Solution
400	400	Invalid vendor ID	vendorId in path or header (X-Requested-By) is invalid or doesn’t equal, pls check and keep the same vendorId.
400	400	Only one type of express is supported for bulk delivery	deliveryCompanyCode in all item of request must be the same one.
400	400	illegal shipment box id	shipmentBoxId should be greater than 0
400	400	illegal delivery company code	deliveryCompanyCode is not supported
400	400	returnCenterCode cannot be empty for deliveryCompanyCode: {deliveryCompanyCode}	For CVS delivery, returnCenterCode is necessary
400	400	invalid outboundShippingPlaceCode for deliveryCompanyCode: {deliveryCompanyCode}	For Home delivery, outboundShippingPlaceCode is necessary