Description
Request URL
/rest/sc_api/order/cancel
Request Method
Content-Type
Request Body
| Name |
Data Type |
Mandatory |
Description |
| order_no |
String |
Y |
order no which is generated by Sales Channel system. |
| cancelled_by |
String |
N |
who cancelled order. Available values: Buyer/Upstream System/Seller. |
| cancelled_reason |
String |
N |
The reason of cancel. |
| cancelled_time |
Long |
N |
Cancelled time. |
| items |
Object[] |
N |
For partial cancel case, require to provide cancel items detail with reason. |
| ├──orig_order_item_id |
String |
Y |
original order no which is generated by Upstream system. |
| ├──cancelled_by |
String |
N |
who cancelled order. Available values: Buyer/Upstream System/Seller. |
| ├──cancelled_reason |
String |
N |
The reason of cancel. |
| ├──cancelled_time |
Long |
N |
Cancelled time. |
Request Example
{
"items": [{
"orig_order_item_id": "item123",
"cancelled_by": "Buyer",
"cancelled_reason": "Buyer changed mind",
"cancelled_time": 1630454400000
}
],
"order_no": "order123",
"cancelled_by": "Buyer",
"cancelled_reason": "Buyer changed mind",
"cancelled_time": 1630454400000
}
Success Response Example
{
"code": "200",
"message": "success",
"data":null,
"request_id": "2d48f902-7efa-4718-8b88-9686803a8a02"
}
