stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /return_refund/202601/decision_eligibility
#§2 Method: [GET]
#§3 Function Description
Use this API to evaluate which seller decisions are currently allowed for the specified aftersales request. The API returns one result per requested decision, including whether the decision is currently eligible and any rejection reasons that are applicable for an eligible reject decision.
§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 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. |
| return_or_cancel_id | string | Y | 4035319218955782461 | The TikTok Shop return or cancellation request ID to evaluate. Pass the request identifier for the target cancellation, refund, return, or other supported aftersales flow. Do not pass an order ID or order line ID in this field. |
| check_decisions | []string | N | APPROVE_REFUND,REJECT_RETURN | The seller decisions to evaluate for the specified aftersales request. Possible Values: |
APPROVE_REQUEST_CANCELAPPROVE_REFUNDAPPROVE_RETURNAPPROVE_RECEIVED_PACKAGEAPPROVE_REPLACEMENTISSUE_REPLACEMENT_REFUNDDIRECT_REFUNDREJECT_REQUEST_CANCELREJECT_REFUNDREJECT_RETURNREJECT_RECEIVED_PACKAGEREJECT_REPLACEMENT-ISSUE_EXCHANGE_REFUNDNote: When omitted, the API evaluates all supported seller decisions for the request and returns one result per decision. | locale |string |N |en-US |The BCP-47 locale codes for displaying the return reason, delimited by commas. Default: en-US Refer to Locale codes for the list of supported locale codes. |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/return_refund/202601/decision_eligibility?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&return_or_cancel_id=4035319218955782461&check_decisions=APPROVE_REFUND,REJECT_RETURN&locale=en-US
§7 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 | |
| ^decisions | []object | Decision list | |
| ^^decision | string | APPROVE_REFUND | One eligibility result for one evaluated seller decision. Possible Values: |
APPROVE_REQUEST_CANCELAPPROVE_REFUNDAPPROVE_RETURNAPPROVE_RECEIVED_PACKAGEAPPROVE_REPLACEMENTISSUE_REPLACEMENT_REFUNDDIRECT_REFUNDREJECT_REQUEST_CANCELREJECT_REFUNDREJECT_RETURNREJECT_RECEIVED_PACKAGEREJECT_REPLACEMENT-ISSUE_EXCHANGE_REFUND| ^^eligible |bool |true |Use this field to recognize whether an decision is eligible for an return or cancellation:- TRUE
- FALSE | ^^ineligible_code |int |25001001 |The reason code for an ineligible decision. | ^^ineligible_reason |string |the return is already completed, you can't approve again. |The reason for an ineligible decision. | ^^available_reject_reasons |[]object | |The reject reason name seller can use to reject buyer's return or cancellation request. | ^^^name |string |seller_reject_apply_product_has_been_packed |The reject reason name seller can use to reject buyer's return or cancellation request. | ^^^text |string |Product shipped. Tracking updates will be available soon. |The display text for the reject reason. |
§8 Response Sample
{"code":0,"data":{"decisions":[{"decision":"APPROVE_REFUND","eligible":true,"ineligible_code":25001001,"ineligible_reason":"the return is already completed, you can't approve again.","available_reject_reasons":[{"name":"seller_reject_apply_product_has_been_packed","text":"Product shipped. Tracking updates will be available soon."}]}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§9 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|
