POST Calculate Refund

Calculate Refund Shop Required scope: seller.return_refund.basic Use this API to estimate the refundable amount for a cancellation, refund, or return-and-refund request. The estimate depends on the selected request_type, reason_name, and targeted items. For return-and-refund scenarios, the estimate can also depend on the selected return shipping method. Version 202602

POST/return_refund/202602/refunds/calculate

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.
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.
request_type Required	string	Request type- CANCEL- REFUND- RETURN_AND_REFUNDNote: different request types are used for different aftersales scenarios. Also, different request types might have different refund amounts, because the refund amount calculation policy is different.
shipment_type	string	How buyer ships items to seller when in a return request, could be:- PLATFORM- BUYER_ARRANGE
handover_method	string	Which handover method buyer chooses to use when returning goods to seller by platform- DROP_OFF: buyer drops off the parcel in logistics service collect point.- PICKUP: logistics service picks up the buyer package.
reason_name Required	string	Seller's reason to create a return. Use the Get Aftersale Eligibility endpoint to retrieve the currently available reasons, and submit the returned reason name in this field.
order_line_item_ids	[]string	TikTok Shop order line item ids.
skus	[]object	skus
order_line_list	[]object	This new parameter is completely backward compatible with the previous order_line_items_ids field and in addition this supports bundle order splitting, use the sub items accordingly

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. | | 25007006 | Order not found. |

Is this content helpful?Helpful

Not Helpful

PreviousNext