coupang
API 文件
商品 API品類 API運輸 / 訂單 API退貨 API換貨 API物流資訊客服 / 諮詢
POST/v2/providers/openapi/apis/api/v1/vendors/{vendorId}/orders/directIntegration/arrangeShipment2609170000

[僅台灣用戶可用] 安排直接整合的快遞出貨

# 01

簡介

[僅台灣用戶可用] 安排直接整合的快遞出貨

# 02

詳細內容

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

路徑

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

範例端點

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v1/vendors/{vendorId}/orders/directIntegration/arrangeShipment
# 03

Path 參數

NameTypeDescription
vendorId*string
vendorId
# 04

請求內容

請求參數

請求內容參數

NameTypeDescription
shipmentBoxId*number
合併配送號碼 (可以通過訂單查詢接口獲得)

此ID為必須，缺失會導致安排出貨失敗.
deliveryCompanyCode*string
物流公司程式碼

請輸入正確的物流公司程式碼，否則請求會失敗

當前可用的物流公司有:
  • Home delivery: TWL_KERRY, TWL_HCT
  • CVS : TWL_FM, TWL_711
returnCenterCodestring
退貨地址程式碼

(當deliveryCompanyCode是CVS時此項為必填) 在建立退貨地時會返回該程式碼
outboundShippingPlaceCodenumber
運送地點地址代碼

(當deliveryCompanyCode是Home Delivery時此項為必填) 在建立發貨地址時會返回該程式碼
remarkstring
寄件者可提供出貨單備註，其中包含與安排和處理裝運相關的特殊說明或評論
# 05

回應內容

回應訊息

NameTypeDescription
successboolean
如果安排出貨成功則返回true,否則返回false
errorKeystring
錯誤資訊的key (例如“OK”).
errorMessagestring
錯誤資訊的補充說明
invoiceNumberstring
運單號碼
shipmentBoxIdnumber
合併配送號碼
validationCodestring
當物流公司是7-11時會返回這個額外的程式碼
invoiceNumberInvalidTim estring
運單號碼的過期時間(格式符合 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"
  }
}
# 06

錯誤碼

HTTP代碼訊息
400HTTP_400Bad Request

錯誤說明

HTTP類型錯誤訊息解決方案
400400

Invalid vendor ID

路徑引數中的vendorId和請求頭的X-Requested-By不正確或者不相同，請保持正確且一致

400400

Only one type of express is supported for bulk delivery

同一個請求中只允許有一種deliveryCompanyCode的請求

400400

illegal shipment box id

shipmentBoxId必須大於0

400400

illegal delivery company code

deliveryCompanyCode不支持

400400

returnCenterCode cannot be empty for deliveryCompanyCode: {deliveryCompanyCode}

當deliveryCompanyCode時CVS時returnCenterCode為必須

400400

invalid outboundShippingPlaceCode for deliveryCompanyCode: {deliveryCompanyCode}

當deliveryCompanyCode時Home Delivery時returnCenterCode為必須