v2.order.cancel_order
POST /api/v2/order/cancel_order
Use this api to cancel an order. This action can only be performed before the order has been shipped.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/order/cancel_order
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| order_sn | string | True | 201020SQQ5K2EP | Shopee's unique identifier for an order. |
| cancel_reason | string | True | OUT_OF_STOCK | The reason seller want to cancel this order. Applicable values: OUT_OF_STOCK CUSTOMER_REQUEST UNDELIVERABLE_AREA (Note: Only apply for TW and MY) COD_NOT_SUPPORTED |
| item_list | object[] | False | Required when cancel_reason is OUT_OF_STOCK. | |
| item_id | int32 | True | 1680783 | Id of item. |
| model_id | int64 | True | 327890123 | Id of the model that belongs to the same item. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | 2ead12d461c34e7c9275c42c2f70fa7d | The identifier for an API request for error tracking. |
| error | string | common.error_auth | Indicate error type if hit error. Empty if no error happened. |
| message | string | Invalid access_token. | Indicate error details if hit error. Empty if no error happened. |
| response | object | Detail informations you are querying. | |
| update_time | timestamp | 1603184533 | The time when the order is updated. |