POST Fulfillment Upload Delivery Image
Fulfillment Upload Delivery Image Shop Required scope: seller.fulfillment.basic This API is used for the seller to upload the proof of delivery image for a package, and to generate the URL of the corresponding file. The generated URL is used in the Update Package Delivery Status API
to indicate that the parcel has been delivered.
Usage requirements:
- The image format must be JPEG, PNG, or JPG.
- The image size can not exceed 5MB. Version 202309
POST/fulfillment/202309/images/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 | Image file data to be uploaded to TikTok Shop. The picture file is a string generated by base64 encoding.Prerequisites：- Image format must be JPG, JPEG, or PNG.- Image resolution must be between 100 x 100px and 20000 x 20000px.- Image size must not exceed 5MB. |
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 | | --- | --- | | 12019116 | Invalid image resolution. Please ensure your image is between 100 x 100 pixels and 20000 x 20000 pixels. | | 12038002 | Invalid upload file. Please ensure you are passing the correct file data. | | 12038004 | Invalid image file type. Please ensure your image is in JPG, JPEG, or PNG format. | | 12038005 | Invalid image file size. Please ensure your image file size does not exceed 5MB. |
Is this content helpful?Helpful
Not Helpful
PreviousNext