POST Search Cancellations
Search Cancellations Shop Required scope: seller.return_refund.basic Use this API to search and retrieve one or more order cancellations. Version 202602
POST/return_refund/202602/cancellations/search
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 Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | 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 Required | int | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| sort_field | string | The returned results will be sorted by the specified field. Default: create_timePossible values:- create_time- update_timeSpecify the order for sorting the returned results by using the sort_order parameter. |
| sort_order | string | The sort order for the sort_field parameter. Default: ASCPossible values:- ASC: Ascending order- DESC: Descending order |
| page_size | string | The number of results to be returned per page. Default: 10. Valid range: [1-50]. |
| page_token | string | An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page. |
| 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 |
|---|---|---|
| cancel_ids | []string | List of order cancellations IDs. |
| order_ids | []string | List of TikTok Shop order IDs. |
| buyer_user_ids | []string | List of TikTok Shop buyer user IDs. |
| cancel_types | []string | List of order cancellation types.Possible values:- CANCEL: Cancel by seller or system.- BUYER_CANCEL: Cancel by buyer. Need to be approved by seller or system. |
| cancel_status | []string | List of order cancellation statuses.Possible values:- CANCELLATION_REQUEST_PENDING- CANCELLATION_REQUEST_SUCCESS- CANCELLATION_REQUEST_CANCEL- CANCELLATION_REQUEST_COMPLETEPlease see "API Overview" for more information about these statuses. |
| create_time_ge | int | Filter cancellations to show only orders that have been created after a specified date and time. Unix timestamp. |
| create_time_lt | int | Filter cancellations to show only orders that have been created before a specified date and time. Unix timestamp. |
| update_time_ge | int | Filter cancellations to show only orders that have been updated after a specified date and time. Unix timestamp. |
| update_time_lt | int | Filter cancellations to show only orders that have been updated before a specified date and time. Unix timestamp. |
| locale | string | The BCP-47 locale codes for displaying the order, delimited by commas. Default: en-USRefer to Locale codes for the list of supported locale codes. |
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. | | 25020005 | No permission to process this order | | 25020008 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. | | 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