Get Aftersale Eligibility

GET

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

Use this API to check whether a seller or buyer can initiate refund-only, return-and-refund, or cancellation requests for an order. The response groups eligibility by SKU, order line item, and aftersale request type.

Authorizations

• accessToken

Parameters

Path Parameters

order_id

required

string

The unique identifier for a TikTok Shop order.

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

initiate_aftersale_user

string

Allowed values: SELLER BUYER

The type of user you would like to check aftersale options for. Default: SELLER Possible values:

• SELLER
• BUYER

request_types

Array<string>

Allowed values: CANCEL REFUND RETURN_AND_REFUND

Optional. 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

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

sku_eligibility

The eligible aftersale options for a given SKU.

Array<object>

object

sku_id

SKU ID.

string

line_item_eligibility

Eligibility results for order line items in this SKU, grouped by aftersale request type. A request type can include separate entries for eligible and ineligible order line items. Eligible entries can include available_reason_names, while ineligible entries include ineligible_code and ineligible_reason.

Array<object>

object

request_type

Aftersale request type. Possible values:

• CANCEL
• REFUND
• RETURN_AND_REFUND

string

Allowed values: CANCEL REFUND RETURN_AND_REFUND

order_line_items_ids

Specifies the order line IDs. Note: This is a legacy field for new integrations use order_line_list instead.

Array<string>

eligible

Indicates whether the order lines in this entry are eligible for the entry’s aftersale request type:

• true: The order lines are eligible for the request type.
• false: The order lines are ineligible for the request type.

boolean

ineligible_code

The reason code for an ineligible aftersale request.

integer format: int64

ineligible_reason

The reason for an ineligible aftersale request.

string

available_reason_names

A list of reason names that can be used when creating a follow-up aftersale request.

Array<string>

order_line_list

Specifies the order line items. Note: This field is completely backward compatible with the previous order_line_items_ids field.

Array<object>

object

order_line_item_id

The corresponding order line ID

string

sub_order_line_item_id

The sub-order-line ID inside a bundle product

• Required for bundle products
• Not required for non-bundle products

string

Example

{
  "data": {
    "sku_eligibility": [
      {
        "line_item_eligibility": [
          {
            "request_type": "CANCEL"
          }
        ]
      }
    ]
  }
}