stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /return_refund/202405/returns/shipping_documents
#§2 Method: [POST]
#§3 Function Description
Use this API to upload return shipping documents, tracking numbers, and carriers for buyers.
§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 | multipart/form-data | Allowed type: multipart/form-data |
§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_ids | []string | Y | 4035309948547270559 | The identifier of a specific return. |
| return_id_type | string | N | RMA | Specifies what kind of ID type was passed in the related return_ids field. (If the id type is not specified, the default value will be SKU_RETURN_ORDER.) |
| Possible values: |
- RMA
- SKU_RETURN_ORDER |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| return_shipping_label | file | N | Return shipping label. | |
| return_qr_code | file | N | Return QR code. | |
| tracking_number | string | Y | TTHERMES2882481596119090868 | The return shipping tracking number provided by the seller to the buyer. |
| return_provider_id | string | Y | 6599541761693270018 | The return shipping provider ID provided by the seller to the buyer. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/return_refund/202405/returns/shipping_documents?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&return_ids=4035309948547270559&return_id_type=RMA
§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 |
§9 Response Sample
{"code":0,"data":{},"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 |
|---|---|
| 25021022 | The return order has already uploaded the shipping document. Please do not upload it again. |
| 25021023 | Return document formatting error. Please check the document format, only PDFs can be uploaded. |
| 25023001 | Invalid return IDs. |
| 25023002 | Return ID does not belong to this seller. Please do not upload it again. |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |