POST Approve Return
Approve Return Shop Required scope: seller.return_refund.basic 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. Version 202309
POST/return_refund/202309/returns/{return_id}/approve
Request
Path
| Properties | Type | Description |
|---|---|---|
| return_id Required | string | The unique identifier of the return request to be approved by the seller. |
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | 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 | 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. |
| shop_cipher Required | string | 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 |
Body
| Properties | Type | Description |
|---|---|---|
| decision Required | string | Seller's decision for the return request, available values:- APPROVE_REFUND: seller approve a refund-only request- APPROVE_RETURN: seller approve the initial return-and-refund request- APPROVE_RECEIVED_PACKAGE: seller approve return-and-refund request after the buyer has already shipped or handed over the item.- APPROVE_REPLACEMENT: seller approve replacement request- ISSUE_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 | Optional. Use this field only when decision is set to APPROVE_RETURN. If set to true, the seller issues a returnless refund, which means the buyer receives a full refund and keeps the item. |
| partial_refund | object | Required. when decision is set to OFFER_PARTIAL_REFUND Omit this field for all other decisions. |
Example
CurlGoNode.jsJavaEnable word wrap
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
Error Code
View common error codes
| 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 |
Is this content helpful?Helpful
Not Helpful
PreviousNext