取消处于【已付款】或【商品准备中】状态商品时使用的API。(用于其它状态时会发生错误）
该API会立即取消[已付款]状态的商品，并停止发货[商品准备中]状态的商品。
如果一个订单号中含不同的捆绑配送编号(shipmentBoxId)，则须分别申请取消shipmentBoxId。
※使用订单取消API会降低卖家分数（订单履行），因此请管理您的库存和价格，尽量避免使用该功能。
路径
POST
/v2/providers/openapi/apis/api/v5/vendors/{vendorId}/orders/{orderId}/cancel
示例
请求参数
|
Name |
|
Required |
Type |
Description |
|
vendorId |
O |
|
String |
卖家ID 酷澎提供给卖家的固有代码 ex) A00012345 |
|
orderId |
O |
|
Number |
订单号 ex) 2000006593044 |
请求体参数
|
Name |
Required |
Type |
Description |
|
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强制取消”。 |
|
ㄱ |
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"
}返回消息
|
Name |
Type |
Description |
||
|
code |
String |
响应代码 200 - 全部/部分取消成功, 400 - 取消失败 |
||
|
message |
String |
失败原因及错误信息 |
||
|
data |
CancelResponse |
取消成功/失败订单的详细信息 |
||
|
|
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