stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /product/202309/images/upload
#§2 Method: [POST]
#§3 Function Description
Upload local images to TikTok Shop for use as product images, variant images, size charts, certification images and so on. Note:
- All images used in TikTok Shop products must be uploaded through this API. You will not be able to use any image URLs that are not hosted by TikTok Shop.
- You must store the response body to retrieve the ID or URL required to associate the image with a product during product creation or editing.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| 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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| data | file | Y | The local image file to be uploaded. |
Note:
- Supported formats: JPG, JPEG, PNG, WEBP, HEIC, BMP
- Max size: 10MB
- Dimensions: [100x100 px, 20000x20000 px]
- For
use_case=MAIN_IMAGE, the dimensions must be between 300x300 px and 4000x4000 px. - For
use_case=SIZE_CHART_IMAGE, the dimension must be at least 1024 px on the shorter side. | use_case |string |N |MAIN_IMAGE |The usage scenario of the image. Possible values: - MAIN_IMAGE: An image displayed in the product image gallery.
- ATTRIBUTE_IMAGE: An image that represents a product variant (e.g. color).
- DESCRIPTION_IMAGE: An image used within the product description.
- CERTIFICATION_IMAGE: An image to provide supporting information to meet TikTok Shop requirements for listing restricted products (e.g., images of certifications, product packaging, labeling).
- SIZE_CHART_IMAGE: An image that displays the product's measurement details.
- CUSTOMIZATION_IMAGE: Images used for POD product customization, such as background images, mask images, or default images configured for customizable areas. These images are used to render or preview consumer-customizable product content.
Note: Images for use cases MAIN_IMAGE and ATTRIBUTE_IMAGE that do not fit within the 3:4 to 4:3 aspect ratio range will be automatically converted to 1:1. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/product/202309/images/upload?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268
§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 | |
| ^uri | string | tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe | The URI to identify the image in API requests and responses. |
| Pass this value when creating or editing a product to associate the image with the product. | |||
| ^url | string | https://p-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe | |
| The URL to access and view the image. | |||
Use this URL in product descriptions by embedding it within an HTML <img> tag. | |||
| ^height | int | 720 | The height of the image after aspect ratio adjustment. |
| ^width | int | 720 | The width of the image after aspect ratio adjustment. |
| ^use_case | string | MAIN_IMAGE | The usage scenario specified during upload. |
| Possible values: |
- MAIN_IMAGE
- ATTRIBUTE_IMAGE
- DESCRIPTION_IMAGE
- CERTIFICATION_IMAGE
- SIZE_CHART_IMAGE
- CUSTOMIZATION_IMAGE |
§9 Response Sample
{"code":0,"data":{"uri":"tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe","url":"https://p-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe\n","height":720,"width":720,"use_case":"MAIN_IMAGE"},"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 |
|---|---|
| 11050001 | invalid param |
| 12019116 | The image dimensions exceed the allowed limits. |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 12038002 | Invalid upload file. Please ensure you are passing the correct file data. |
| 12038004 | Failed to process the image. The format or content is not supported. |
| 12038005 | The file size exceeds the maximum allowed size. |
| 12038014 | The image dimensions exceed the allowed limits. Allowed dimensions (width x height in pixels): {{min_width}} x {{min_height}} to {{max_width}} x {{max_height}} |
| 12038015 | Failed to process the image. The format or content is not supported. Supported formats: {{formats}} |