POST Approve Cancellation
Approve Cancellation Shop Required scope: seller.return_refund.basic Use this API to approve a buyer-initiated cancellation request identified by cancel_id. Call this API only when the cancellation request is still waiting for seller action. Version 202309
POST/return_refund/202309/cancellations/{cancel_id}/approve
Request
Path
| Properties | Type | Description |
|---|---|---|
| cancel_id Required | string | The cancellation request ID to approve. Use the cancel_id returned by Search Cancellations. Do not pass the order ID here. |
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. |
| idempotency_key | string | The idempotency key is a unique value generated by the client which the server uses to recognize a request. You may choose your own method of creating unique keys. We suggest using UUIDs, or another random string with enough entropy, to avoid collisions. Idempotency keys can be up to 255 characters long. |
| 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 |
Example
CurlGoNode.jsJavaEnable word wrap
12345curl-X POST 'https://open-api.tiktokglobalshop.com/return_refund/202309/cancellations/98001001/approve?idempotency_key=40b456b1-78e7-412d-9fe6-82181496e1bd&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1623812664&app_key=38abcd&shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3' -H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' -H 'content-type: application/json' -d '{}'
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
{"code":0,"data":{},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
Error Code
View common error codes
| Code | Message | | --- | --- | | 11050001 | invalid param | | 25001001 | An invalid request parameter was passed. Please check that you have the correct parameter type(s) and format. | | 25001003 | Invalid order status. | | 25001028 | reverse lock failed | | 25001045 | The order has already been shipped and we are unable to cancel shipment with the courier. | | 25001058 | reverse downstream data load error | | 25007002 | db access error | | 25007006 | Order not found. | | 25011012 | reverse status cannot approve application | | 25020003 | decision not match reverse status | | 25020004 | decision not match reverse type | | 25020005 | No permission to process this order | | 25020009 | reverse already cancelled | | 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