stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /return_refund/202309/returns/{return_id}/approve
#§2 Method: [POST]
#§3 Function Description
Use this API to approve a buyer's return request. The exact effect depends on the return type and return status. Before calling this API, make sure the return is still awaiting a seller action that matches the decision you are sending.
§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 |
|---|---|---|---|---|
| return_id | string | Y | 4035319218955782461 | The unique identifier of the return request to be approved by the seller. |
§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. |
| idempotency_key | string | N | 40b456b1-78e7-412d-9fe6-82181496e1bd | 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 Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| decision | string | Y | APPROVE_REFUND | Seller's decision for the return request, available values: |
APPROVE_REFUND: seller approve a refund-only requestAPPROVE_RETURN: seller approve the initial return-and-refund requestAPPROVE_RECEIVED_PACKAGE: seller approve return-and-refund request after the buyer has already shipped or handed over the item.APPROVE_REPLACEMENT: seller approve replacement requestISSUE_REPLACEMENT_REFUND: seller decline the replacement request and directly refund the buyer instead.OFFER_PARTIAL_REFUND: seller offers a partial refund amount to the buyer without requiring the item(s) to be returned.DIRECT_REFUND: seller issues a returnless refund, meaning the buyer receives a full refund and keeps the item | buyer_keep_item |bool |N |true |Optional. Use this field only when decision is set toAPPROVE_RETURN. If set totrue, the seller issues a returnless refund, which means the buyer receives a full refund and keeps the item. | partial_refund |object |N | |Required. when decision is set toOFFER_PARTIAL_REFUNDOmit this field for all other decisions. | ^currency |string |N |IDR |Refund currency must match the currency of the current return request. | ^amount |string |N |10 |The partial refund amount seller would like to offer to the buyer |
§8 Request Sample
Query
https://open-api.tiktokglobalshop.com/return_refund/202309/returns/4035319218955782461/approve?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&idempotency_key=40b456b1-78e7-412d-9fe6-82181496e1bd
Body
{"decision":"APPROVE_REFUND","buyer_keep_item":true,"partial_refund":{"currency":"IDR","amount":"10"}}
§9 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 |
§10 Response Sample
{"code":0,"data":{},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§11 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 |