POST Upload Shipping Document And Tracking Info
Upload Shipping Document And Tracking Info Shop Required scope: Use this API to upload return shipping documents, tracking numbers, and carriers for buyers.
Version 202405
POST/return_refund/202405/returns/shipping_documents
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: multipart/form-data |
| 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. |
| return_ids Required | []string | The identifier of a specific return. |
| return_id_type | string | 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 |
| 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 |
|---|---|---|
| return_shipping_label | file | Return shipping label. |
| return_qr_code | file | Return QR code. |
| tracking_number Required | string | The return shipping tracking number provided by the seller to the buyer. |
| return_provider_id Required | string | The return shipping provider ID provided by the seller to the buyer. |
Example
CurlGoNode.jsJavaEnable word wrap
12345678curl-X POST 'https://open-api.tiktokglobalshop.com/return_refund/202405/returns/shipping_documents?app_key=38abcd&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1623812664&shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3&return_ids=4035309948547270559&return_id_type=RMA' -H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' -H 'content-type: multipart/form-data' -F 'return_qr_code=@"file"' -F 'return_shipping_label=' -F 'tracking_number=TTHERMES2882481596119090868' -F 'return_provider_id=6599541761693270018'
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
{"code":0,"data":{},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
Error Code
View common error codes
| 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. |
Is this content helpful?Helpful
Not Helpful
PreviousNext