stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fulfillment/202309/images/upload
#§2 Method: [POST]
#§3 Function Description
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, orJPG. - The image size can not exceed 5MB.
§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 |
| category_asset_cipher | query | string | N | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API. |
§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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| data | file | Y | BWWCusFdYKa4W1wlphrbBWWCusFdYKaxtOawMj5ftPCQAAAABJRU5ErkJggg== | 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, orPNG. - Image resolution must be between 100 x 100px and 20000 x 20000px.
- Image size must not exceed 5MB. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fulfillment/202309/images/upload?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
§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 | |
| ^url | string | https://p-pbe38.byted.org/tos-ppdi18n-i-0euhj0x6u9/0a119a90d90b41e3838608bc384 | The URL returned from uploading the image that can be directly opened in a browser. |
| ^height | int | 256 | The image height returned from uploading the image. This height refers to the processed image height, not the original image height. |
| Units: pixels. | |||
| ^width | int | 256 | The image width returned from uploading the image. This width refers to the processed image width, not the original image width. |
| Units: pixels. |
§9 Response Sample
{"code":0,"data":{"url":"https://p-pbe38.byted.org/tos-ppdi18n-i-0euhj0x6u9/0a119a90d90b41e3838608bc384","height":256,"width":256},"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 |
|---|---|
| 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. |