POST Cancel Order

Cancel Order Shop Required scope: seller.return_refund.basic Use this API to cancel an order on behalf of a seller. In the US and UK markets, when an item is out of stock, partial cancellation on the single item level is supported by this API. Version 202602

POST/return_refund/202602/cancellations

Request

Header

Properties	Type	Description
content-type Required	string	Allowed type: application/json
x-tts-access-token Required	string	The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

Properties	Type	Description
app_key	string	Every single app will have a unique key. Please use the specific key assigned to your app.
sign	string	Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp	int	Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
shop_cipher Required	string	Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. Get by API Get Authorization Shop

Body

Properties	Type	Description
order_id Required	string	TikTok Shop order id
skus	[]object	List of SKU to cancel
order_line_item_ids	[]string	List of order line item ids to cancel. In the US and UK markets, when an item is out of stock, partial cancellation on the single item level is supported. To initiate a partial cancellation, specify the item's order line id. Note: This is a legacy field for any new integrations please use order_line_items field instead.
cancel_reason Required	string	Reason to cancel the order Please see "Return API Overview" for a list of reasons a seller can select to cancel the order.
order_line_list	[]object	List of order-lines/sub order-lines to cancel. In the US and UK markets, when an item is out of stock, partial cancellation on the single item level is supported. Note: This field is completely backward compatible with the previous order_line_items_ids field.

Example

CurlGoNode.jsJavaEnable word wrap

Response Parameters

Properties	Type	Description
code	int	The success or failure status code returned in API response.
message	string	The success or failure messages returned in API response. Reasons of failure will be described in the message.
request_id	string	Request log
data	object	Specific return information

Example

JSONEnable word wrap

Error Code

View common error codes

| Code | Message | | --- | --- | | 25001001 | An invalid request parameter was passed. Please check that you have the correct parameter type(s) and format. | | 25001011 | A return request is already in process, or the order has already been cancelled. | | 25001014 | Unknown return reason. Please ensure you are passing a valid return reason. | | 25001015 | The provided return reason cannot be used by the seller. Please select a valid return reason and try again. | | 25001020 | The provided return reason is currently offline. Please select a different return reason. | | 25001021 | Reason not match order status | | 25001028 | reverse lock failed | | 25001045 | The order has already been shipped and we are unable to cancel shipment with the courier. | | 25001046 | Return request has failed due to an interception by TikTok risk control. | | 25001051 | Not allowed to return or cancel since order is completed or cancelled | | 25005010 | Unable to cancel individual line items within this request. | | 25005011 | The requested line item(s) for return or refund exceeds the allowable limit. | | 25020005 | No permission to process this order | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |

Is this content helpful?Helpful

Not Helpful

PreviousNext