取消訂單

API 適用的买方用户區域：韓國、台灣

取消處於【已付款】或【商品準備中】狀態訂單時使用的API。(用於其它狀態時會發生錯誤）

該API會立即取消[已付款]狀態的訂單，並停止發貨[商品準備中]狀態的商品。

如果一個訂單號中含不同的捆綁配送編號(shipmentBoxId)，則須分別申請取消shipmentBoxId。

※使用訂單取消API會降低賣家分數（訂單履行），因此請管理您的庫存和價格，儘量避免使用該功能。

路徑

POST

/v2/providers/openapi/apis/api/v5/vendors/{vendorId}/orders/{orderId}/cancel

例子

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v5/vendors/A00012345/orders/2000006593044/cancel

請求引數

路徑引數

請求體引數

請求體例子

{
"orderId": 2000006593044,
"vendorItemIds": [
3145181064,
3145181065,
3145181067
],
"receiptCounts": [
1,
2,
1
],
"bigCancelCode": "CANERR",
"middleCancelCode": "CCTTER",
"userId": "wing_login_id_123",
"vendorId": "A00123456"
}

返回訊息

返回訊息例子1

{
"code": "200",
"message": "[요청번호] 43b97579-bcb5-4260-84cb-9a4a9063db71 \r\n",
"data": {
"receiptMap": {
"181627233": {
"receiptId": 181627233,
"receiptType": "CANCEL",
"vendorItemIds": [
70071284034
],
"totalCount": 1
}
},
"orderId": 23000059824637,
"failedVendorItemIds": []
}
}

返回訊息例子2

{
"code": "200",
"message": "[요청번호] cdea5b4b-34e9-4bec-bbd9-061e358e46a0 \r\n[3145181064]<= 취소 가능한 개수보다 요청한 개수가 더 많습니다.",
"data": {
"receiptMap": {
"44698107": {
"receiptId": 44698107,
"receiptType": "STOP_SHIPMENT",
"vendorItemIds": [
3145181065,
3145181067
],
"totalCount": 3
}
},
"orderId": 2000006593044,
"failedVendorItemIds": [
3145181064
]
}
}

返回訊息例子3

{
"code": "400",
"message": "[요청번호] 5d803ea1-e61d-44bd-a56d-44f3528f5136 \r\n [3145181067, 3145181065, 3145181064]<= 취소 가능한 개수보다 요청한 개수가 더 많습니다",
"data": {
"receiptMap": {},
"orderId": 23000059824637,
"failedVendorItemIds": [
3145181067,
3145181065,
3145181064
]
}
}

錯誤程式碼

介面名稱

CANCEL_ORDER_PROCESSING