stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /return_refund/202602/orders/{order_id}/aftersale_eligibility
#§2 Method: [GET]
#§3 Function Description
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.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | 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 | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| order_id | string | Y | 577087614418520388 | The unique identifier for a TikTok Shop order. |
§6 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | 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 | Y | 1623812664 | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| initiate_aftersale_user | string | N | BUYER | The type of user you would like to check aftersale options for. |
| Default: SELLER | ||||
| Possible values: |
- SELLER
- BUYER | request_types |[]string |N |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|
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/return_refund/202602/orders/577087614418520388/aftersale_eligibility?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&initiate_aftersale_user=BUYER&request_types=REFUND
§8 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^sku_eligibility | []object | The eligible aftersale options for a given SKU. | |
| ^^sku_id | string | 1729385144994206632 | SKU ID. |
| ^^line_item_eligibility | []object | The eligible aftersale options based on order line item. | |
| ^^^request_type | string | REFUND | Aftersale request type. |
| Possible values: |
CANCELRETURNRETURN_AND_REFUND| ^^^order_line_items_ids |[]string |["576469648086306000"] |Specifies the order line IDs. Note: This is a legacy field for new integrations useorder_line_listinstead. | ^^^eligible |bool |true |Use this field to recognize whether an item is eligible for an aftersale request:TRUEFALSE| ^^^ineligible_code |int |25001001 |The reason code for an ineligible aftersale request. | ^^^ineligible_reason |string |invalid order status |The reason for an ineligible aftersale request. | ^^^available_reason_names |[]string |available reason names |A list of reason names that can be used when creating a follow-up aftersale request. | ^^^order_line_list |[]object | |Specifies the order line items. Note: This field is completely backward compatible with the previousorder_line_items_idsfield. | ^^^^order_line_item_id |string |576469648086306986 |The corresponding order line ID | ^^^^sub_order_line_item_id |string |576469648086306987 |The sub-order-line ID inside a bundle product- Required for bundle products
- Not required for non-bundle products |
§9 Response Sample
{"code":0,"data":{"sku_eligibility":[{"sku_id":"1729385144994206632","line_item_eligibility":[{"request_type":"REFUND","order_line_items_ids":["576469648086306000"],"eligible":true,"ineligible_code":25001001,"ineligible_reason":"invalid order status","available_reason_names":"available reason names","order_line_list":[{"order_line_item_id":"576469648086306986","sub_order_line_item_id":"576469648086306987"}]}]}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§10 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|