API 適用的买方用户區域:台灣
安排出貨,並將訂單狀態從商品準備中(INSTRUCT)修改為待寄出(DEPARTURE)。此API不支持拆分包裹,請使用Wing進行拆分包裹。
注意:如果請求中的訂單狀態不是商品準備中(INSTRUCT),此請求會失敗並返回錯誤信息:INVOICE NUMBER GENERATION FAILED.
當前可用的物流公司有:
| 物流公司名稱 | 類型 | deliveryCompanyCode |
| 宅配-嘉里 | Home delivery | TWL_KERRY |
| 宅配-新竹 | Home delivery | TWL_HCT |
| 便利商店-全家 | CVS | TWL_FM |
| 便利商店 7-11 | CVS | TWL_711 |
路徑
POST
/v2/providers/openapi/apis/api/v1/vendors/{vendorId}/orders/directIntegration/arrangeShipment
請求端點範例
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v1/vendors/A158000ABC/orders/directIntegration/arrangeShipment
請求引數
路徑引數
| 名稱 | 是否必須 | 型別 | 描述 |
| vendorId | O | String |
Vendor ID 酷澎提供給賣家的固有程式碼 ex) A158000ABC |
請求體引數
請求體是一個數組,數組中每個元素都是以下結構:
| 名稱 | 是否必須 | 型別 | 描述 |
| shipmentBoxId | O | Number |
合併配送號碼 (可以通過訂單查詢接口獲得) 此ID為必須,缺失會導致安排出貨失敗. |
| deliveryCompanyCode | O | String |
物流公司程式碼 請輸入正確的物流公司程式碼,否則請求會失敗 當前可用的物流公司有: |
| returnCenterCode | String |
退貨地址程式碼 (當deliveryCompanyCode是CVS時此項為必填) 在建立退貨地時會返回該程式碼 |
|
| outboundShippingPlaceCode | Number |
運送地點地址代碼 (當deliveryCompanyCode是Home Delivery時此項為必填) 在建立發貨地址時會返回該程式碼 |
|
| remark | String | 寄件者可提供出貨單備註,其中包含與安排和處理裝運相關的特殊說明或評論 |
請求體範例
CVS 請求範例:
[{
"shipmentBoxId":111,
"deliveryCompanyCode":"TWL_FM",
"returnCenterCode":"1100047243",
"remark":""
}]HomeDelivery 請求範例:
[{
"shipmentBoxId":111,
"deliveryCompanyCode":"TWL_KERRY",
"outboundShippingPlaceCode":1100047243,
"remark":""
}]返回訊息
返回訊息消息體是一個Map,
- Key:一個字符串,內容是shipmentBoxId
- Value: 一個有如下結構體的對象類型.
| 名稱 | 型別 | 描述 |
| success | Boolean | 如果安排出貨成功則返回true,否則返回false |
| errorKey | String | 錯誤資訊的key (例如“OK”). |
| errorMessage | String | 錯誤資訊的補充說明 |
| invoiceNumber | String | 運單號碼 |
| shipmentBoxId | Number | 合併配送號碼 |
| validationCode | String | 當物流公司是7-11時會返回這個額外的程式碼 |
|
invoiceNumberInvalidTim e |
String |
運單號碼的過期時間(格式符合 ISO-8601 Compliance) e.g. 2025-09-02T13:54:39+08:00 or 2025-09-02T05:54:39Z |
返回訊息範例
{
"12345":{
"success": true,
"errorKey": "",
"errorMessage": "",
"invoiceNumber": "12345556",
"shipmentBoxId": 12345,
"validationCode": "",
"invoiceNumberInvalidTime":"2025-09-02T13:54:39+08:00"
}
}錯誤程式碼
| HTTP狀態程式碼(錯誤型別) | 錯誤資訊 | 解決方案 |
| 400 | Invalid vendor ID | 路徑引數中的vendorId和請求頭的X-Requested-By不正確或者不相同,請保持正確且一致 |
| 400 | Only one type of express is supported for bulk delivery | 同一個請求中只允許有一種deliveryCompanyCode的請求 |
| 400 | illegal shipment box id | shipmentBoxId必須大於0 |
| 400 | illegal delivery company code | deliveryCompanyCode不支持 |
| 400 | returnCenterCode cannot be empty for deliveryCompanyCode: {deliveryCompanyCode} | 當deliveryCompanyCode時CVS時returnCenterCode為必須 |
| 400 | invalid outboundShippingPlaceCode for deliveryCompanyCode: {deliveryCompanyCode} | 當deliveryCompanyCode時Home Delivery時returnCenterCode為必須 |
API名稱
UPDATE_ORDER_ARRANGE_SHIPMENT_FOR_DIRECT_INTEGRATED_COURIER