Coupang Developer Center

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

請求引數

路徑引數

名稱

是否必須

型別

描述

vendorId

String

賣家ID

酷澎提供給賣家的固有程式碼

ex) A00012345

orderId

Number

訂單號

ex) 2000006593044

請求體引數

名稱	是否必須	型別	描述
orderId	O	Number	訂單號也須輸入path variable
vendorItemIds	O	Array	要取消的商品屬性ID (vendorItemId) 陣列與receiptCounts成對輸入
receiptCounts	O	Array	要取消的商品數陣列, 數值始終大於0 與vendorItemIds成對輸入
bigCancelCode	O	String	訂單取消原因高階程式碼 CANERR
middleCancelCode	O	String	訂單取消原因中級程式碼 CCTTER // 庫存聯動錯誤：因庫存問題取消時 CCPNER // 合作網站錯誤：因網站問題無法建立顧客收貨地址而導致的訂單取消 CCPRER // 價格登記錯誤：兩公司間發生商品價格錯誤而導致的訂單取消在商品準備中狀態下取消商品（已停止發貨）時，原因類別分別固定設定為“配送不滿意”和“售罄”，與輸入值無關。取消詳細原因將記載為“合作方API強制取消”。
vendorId	O	String	賣家ID, 也須輸入path variable
userId	O	String	賣家的酷澎Wing登入ID

請求體例子

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

返回訊息

名稱			型別	描述
code			String	響應程式碼 200 - 全部/部分取消失敗, 400 - 取消失敗
message			String	失敗原因及錯誤資訊
data			Object	取消失敗/失敗訂單的詳細資訊
	ReceiptMap		Object
		receiptId	Number	受理ID
		receiptType	String	CANCEL時，立即取消的受理ID STOP_SHIPMENT時，已停止發貨的受理編號
		vendorItemIds	Array	受理ID的取消商品編號陣列
		totalCount	Number	受理ID的取消商品總數
	orderId		Number	訂單號
	failedItemIds		Array	取消失敗的VendorItemId

返回訊息例子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
]
}
}

錯誤程式碼

HTTP狀態程式碼（錯誤型別）	錯誤資訊	解決方案
400 (確認請求引數)	請輸入訂單號。	請確認您輸入的訂單號(orderId)是否正確。
400 (確認請求引數)	請輸入要取消的賣家單品ID陣列。	請確認您輸入的商品編號陣列(vendorItemIds)數值是否正確。
400 (確認請求引數)	請輸入要取消的單品數量陣列。	請確認您輸入的要取消的商品數陣列是否正確。
400 (確認請求引數)	請確認所申請的商品數量及取消數量。	請確認商品編號陣列 (vendorItemIds)中的屬性數量是否與商品取消數量陣列中的數量一致。
400 (確認請求引數)	請輸入取消理由的高階程式碼。	請確認取消理由高階程式碼(bigCancelCode)是否輸入為了 "CANERR."
400 (確認請求引數)	請輸入取消理由的中級程式碼。	請確認取消理由中級程式碼(middleCancelCode)是否輸入為了"CCTTER," "CCPNER" 或 "CCPRER"。
400 (確認請求引數)	請輸入賣家ID.	請確認您輸入的賣家ID(vendorId)是否正確。
400 (確認請求引數)	請輸入與賣家ID相匹配的使用者ID。	請確認您輸入的Wing使用者ID是否與賣家ID準確匹配。
400 (確認請求引數)	訂單資訊不存在。	該錯誤資訊是指您申請的訂單號 (orderId) 和商品編號全都沒有付款資訊。請確認各訂單號下的商品狀態。
400 (確認請求引數)	您的申請數量超過了可取消數量。	請確認您申請的取消數量是否超過了特定屬性商品的可取消數量（訂單數量 - 正在取消中的數量 - 已完成的取消數量）。
400 (確認請求引數)	該賣家單品不是已付款/商品準備中狀態。	請確認您申請取消的商品是否為已付款或商品準備中狀態。
400 (確認請求引數)	該商品的賣家與您申請的不一致。	請確認您申請取消的商品是否為該賣家的商品。
400 (確認請求引數)	申請取消時出現錯誤。	處於已付款狀態的訂單取消失敗。請在已付款頁面再次確認訂單狀態。
400 (確認請求引數)	部分取消失敗。	部分取消失敗。請確認商品編號陣列(vendorItemIds)中的屬性數量及商品取消數量陣列數量是否正確。
400 (確認請求引數)	已停止發貨處理失敗。	未能成功將“商品準備中”狀態的商品處理為“已停止發貨”狀態。請檢視屬性的訂單狀態，並確認是否重複提交了該屬性的取消申請。
400 (確認請求引數)	申請停止發貨roll back失敗。[受理ID]	未能成功將“商品準備中”狀態的商品處理為“已停止發貨”狀態，且申請停止發貨roll back也失敗的情況。請確認屬性商品的處理狀態。
400 (確認請求引數)	出現內部錯誤。請向酷澎諮詢。錯誤程式碼：%s	請再次確認輸入的數值，稍後重試。

介面名稱

CANCEL_ORDER_PROCESSING

取消訂單

簡介

詳細內容