POST Optimized Images
Optimized Images Shop Required scope: seller.product.basic Optimize images used in your TikTok Shop by changing the background to white. This is especially useful for images displayed in the product image gallery as it enhances product visibility. Note:
- The images to be optimized must first be uploaded to TikTok Shop through the Upload Product Image API
. You will not be able to optimize any images that are not hosted by TikTok Shop.
- Images that were previously optimized will not be processed again.
- The optimization is processed asynchronously and typically completes within a few seconds. Therefore, the optimize_status returned in the first API request for an image is always PROCESSING, indicating that optimization is underway. Please call the API again after a few seconds to get the final optimization status. Version 202404
POST/product/202404/images/optimize
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| 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 |
Body
| Properties | Type | Description |
|---|---|---|
| images | []object | The list of images to be optimized. Use the Upload Product Image API to upload the images first and obtain the corresponding image URIs.Max count: 200 |
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 | | --- | --- | | 12019065 | The image URI is invalid. Please use the URI generated by the Upload Product Image API. | | 12019070 | The optimization mode is invalid. | | 12038007 | The number of image URIs exceeded the limit of 200. | | 12052722 | The image URI does not exist in TikTok Shop. |
Is this content helpful?Helpful
Not Helpful
PreviousNext