POST Create Return
Create Return Shop Required scope: seller.fulfillment.basicor seller.return_refund.basic Use this API to create a seller-initiated aftersales request for an order on behalf of the buyer. Supported request types are REFUND and RETURN_AND_REFUND. Before submitting the request, confirm that the order is eligible for the selected aftersales type and return method. After the request is created, use the relevant search, status, or review API to continue the aftersales workflow. Version 202602
POST/return_refund/202602/returns
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. |
| idempotency_key | string | Idempotency Key |
| 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 | Skus |
| order_line_item_ids | []string | Specifies the order line IDs to include in the return request. If the order has been split into multiple packages, use order line IDs to create the return request. If neither order_line_item_ids nor skus is provided, the default is all order lines in the order. Note: This is a legacy field for new integrations use order_line_list instead. |
| return_reason Required | string | Seller's reason to create a return |
| return_type Required | string | Which type to create: - REFUND- RETURN_AND_REFUND |
| refund_total | string | Total refund amount to the buyer. The total refund amount can not exceed the refundable amount |
| currency | string | Currency for refund which should be same as currency in TikTok Ship Order. |
| shipment_type | string | Specifies the return shipping method the buyer uses to send items back to the seller in a return request. Supported values:- PLATFORM- BUYER_ARRANGE |
| handover_method | string | Optional. Only applicable when shipment_type is PLATFORM. Specifies the handover method the buyer uses to return the item through platform-supported shipping. Supported values:- DROP_OFF- PICKUP |
| order_line_list | []object | Specifies the line items to include in the return request and supports bundle order splitting. In one request, use either order_line_item_id for normal order lines or sub_order_line_item_id for bundle sub-items. 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. | | 25001003 | Invalid order status. | | 25001010 | A return request has already been completed, or the order has already been cancelled. | | 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 | | 25001042 | Return package creation has failed due to internal error. | | 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 | | 25005005 | Refund total amount is larger than the refundable amount. | | 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