POST Fulfillment Upload Delivery File
Fulfillment Upload Delivery File Shop Required scope: seller.fulfillment.basic This API is used for the seller to upload the proof of delivery file for a package, and to generate the URL of the corresponding file. The generated URL is used for the Update Package Delivery Status API
.
This API only supports uploading qualification files in PDF format. The file size can not exceed 10MB.
Note: Only sellers utilizing the SOF (Seller Own Fleet) capability can use this API. Version 202309
POST/fulfillment/202309/files/upload
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. |
| 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 |
| category_asset_cipher | string | The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API. |
Body
| Properties | Type | Description |
|---|---|---|
| data Required | file | PDF file data to be uploaded to TikTok Shop. Prerequisites：- Only PDF file format is supported.- Original file size must not exceed 10MB. |
| name Required | string | The name of the uploaded file. The file name must include the file type. |
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 | | --- | --- | | 12038002 | Invalid upload file. Please ensure you are passing the correct file data. | | 12038004 | Invalid file type. Please ensure you are providing a PDF file. | | 12038005 | Invalid file size. Please ensure your file is smaller than 10MB. |
Is this content helpful?Helpful
Not Helpful
PreviousNext