Skip to main content

GET Get Aftersale Eligibility

Get Aftersale Eligibility Shop Required scope: seller.return_refund.basic Use this API to check eligible aftersale solutions for an order, including whether the seller or buyer can initiate a refund, return, or cancel a specific order. Version 202602

GET/return_refund/202602/orders/{order_id}/aftersale_eligibility

Request

Path

PropertiesTypeDescription
order_id RequiredstringThe unique identifier for a TikTok Shop order.

Header

PropertiesTypeDescription
content-type RequiredstringAllowed type: application/json
x-tts-access-token RequiredstringThe seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

PropertiesTypeDescription
app_key RequiredstringEvery single app will have a unique key. Please use the specific key assigned to your app.
sign RequiredstringSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp RequiredintUnix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
initiate_aftersale_userstringThe type of user you would like to check aftersale options for.Default: SELLERPossible values:- SELLER- BUYER
request_types[]stringOptional. Specifies which request types to query. If omitted, the API returns all request types currently available for the specified initiator. Possible values:-CANCEL-REFUND-RETURN_AND_REFUND
shop_cipher RequiredstringUse 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

Response Parameters

PropertiesTypeDescription
codeintThe success or failure status code returned in API response.
messagestringThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstringRequest log
dataobjectSpecific return information

Example

JSONEnable word wrap

Error Code

View common error codes

| Code | Message | | --- | --- | | Empty. No business logic error codes. |

Is this content helpful?Helpful

Not Helpful

PreviousNext