stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /return_refund/202606/aftersales/review
#§2 Method: [POST]
#§3 Function Description
API used to review (approve, reject, or offer alternatives to) a buyer's return request.
§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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| aftersales_request_decisions | []object | N | Decisions to apply to aftersales requests. | |
| ^request_id | string | Y | 4035319218955782461 | Identifies the object upon which this decision is made. |
| ^request_id_type | string | N | AFTERSALES | Type of identifier provided in request_id. |
| Possible values: |
AFTERSALESRMA| ^line_item_decisions |[]object |Y | |Decisions applied at the line item level. | ^^line_items |[]object |Y | |Line items for which this decision applies. Decision details apply to each line item individually (e.g. a partial refund amount of $1.00 for 3 line items will result in a total partial refund amount of $3.00). | ^^^return_line_item_id |string |Y |4035227657962164811 |Unique identifier for this item in the return. In the case of virtual bundle, this corresponds to the id of the original parent item bundle. | ^^^sub_return_line_item_id |string |N |4035227657962164815 |Unique identifier for this item in the return. In the case of virtual bundle, this corresponds to the id of the current child item being returned. | ^^action |string |Y |APPROVE_REQUEST |Action/decision to be applied. Possible values:APPROVE_REQUESTAPPROVE_RETURN_PACKAGEREJECT_REQUESTREJECT_RETURN_PACKAGEREFUND_INSTEADOFFER_PARTIAL_REFUNDOFFER_PARTIAL_REFUND_AFTER_RECEIVING_PKG| ^^alternative_solution_details |object |N | |Details for an alternative resolution (if applicable). | ^^^partial_refund_amount |string |N |12.34 |Proposed refund amount. | ^^^currency |string |N |USD |Currency of the refund amount (ISO 4217). Must match the currency of the forward order. | ^^reason |object |N | |To justify the action/decision (generally required for rejection). | ^^^reason_id |string |N |seller_reject_apply_package_has_not_exceeded_estimated_delivery_time |Seller's reason for rejecting the aftersales request. Use the Get Decision Eligibility endpoint to retrieve the currently available rejection options for the same request, and submit the returned rejection reason name in this field. Note: The available decisions and rejection reasons can change depending on the current request status, so fetch eligibility again before calling this API. | ^^^text |string |N |I have reached an agreement with the buyer |Additional explanation for the decision. | ^^^media |object |N | |Supporting evidence (such as images). | ^^^^uri |string |N |tos-maliva-i-o3syd03w52-us/57a1c8908fe74572861ea5e50887d8d1 |Image URI obtained from the Upload Product Image API. | ^^^^mime_type |string |N |image/png |MIME type of the media (such as image/jpeg). | ^action_unix_time |int |N |1774486592 |The timestamp at which the decision/action was made (in unix seconds). | ^idempotency_key |string |N |40b456b1-78e7-412d-9fe6-82181496e1bd&app_key=38abcd |The idempotency key is a unique value generated by the client which the server uses to recognize the same request. How you create unique keys is up to you, but we suggest using UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/return_refund/202606/aftersales/review?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"aftersales_request_decisions":[{"request_id":"4035319218955782461","request_id_type":"AFTERSALES","line_item_decisions":[{"line_items":[{"return_line_item_id":"4035227657962164811","sub_return_line_item_id":"4035227657962164815"}],"action":"APPROVE_REQUEST","alternative_solution_details":{"partial_refund_amount":"12.34","currency":"USD"},"reason":{"reason_id":"seller_reject_apply_package_has_not_exceeded_estimated_delivery_time","text":"I have reached an agreement with the buyer","media":{"uri":"tos-maliva-i-o3syd03w52-us/57a1c8908fe74572861ea5e50887d8d1","mime_type":"image/png"}}}],"action_unix_time":1774486592,"idempotency_key":"40b456b1-78e7-412d-9fe6-82181496e1bd\u0026app_key=38abcd"}]}
§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 | |
| ^errors | []object | Lists errors for partially failed requests. For example, if a request reviews multiple orders or items and only some fail, individual error details are returned here. | |
| IMPORTANT: Partial failures still return a top-level success code (0), so clients must also check this field to detect partial errors. For complete failures (e.g. validation errors), the top-level response code and message will indicate a failure, but this field will remain empty. | |||
| ^^code | string | 98001004 | Error code. |
| ^^message | string | Invalid parameters. Please verify your input before retrying | Error description. |
§9 Response Sample
{"code":0,"data":{"errors":[{"code":"98001004","message":"Invalid parameters. Please verify your input before retrying"}]},"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 |
|---|---|
| 11050001 | invalid param |
| 25001001 | An invalid request parameter was passed. Please check that you have the correct parameter type(s) and format. |
| 25001003 | Invalid order status. |
| 25001028 | reverse lock failed |
| 25001044 | ConfirmReceive fulfillment order failed |
| 25001058 | reverse downstream data load error |
| 25007006 | Order not found. |
| 25007007 | ReverseOrderExistNegotiate |
| 25011010 | request has been transferred to platform operator |
| 25011012 | reverse status cannot approve application |
| 25011013 | reverse status cannot approve receive |
| 25011023 | forbid process authentic guarantee order |
| 25011026 | forbid process receive for FBT order |
| 25011032 | ReverseInvalidStatusPartialRefund |
| 25020004 | decision not match reverse type |
| 25020005 | No permission to process this order |
| 25020008 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 25020009 | reverse already cancelled |
