POST Diagnose and Optimize Product
Diagnose and Optimize Product Shop Required scope: serller.product.optimize Diagnose products to obtain information that helps you to improve the product content, enhancing product visibility and customer trust. The returned information includes:
- Listing quality information (available only for the US market).
- Issues with the current product details and the overall recommendations
- Auto-generated optimization suggestions targeted for specific product fields, including the title, description, and image. This API enables you to diagnose both live products (status: ACTIVATE) and brand-new products not yet listed in TikTok Shop.
- To diagnose a live product, provide the product_id and category_id and leave all other product details blank.
- To diagnose a brand-new product not yet listed in TikTok Shop, omit the product_id and provide the product details as necessary.
- To diagnose a product similar to an existing one, provide the product_id and category_id, along with any new details. The diagnosis will combine the existing product's information with the new details you provide. For example, if you provide a new title, the diagnosis will use the new title instead of the existing one while keeping the other values from the product ID. Note:
- To diagnose multiple live products, use the Product Information Issue Diagnosis API
.
- This API focuses solely on optimizing product visibility and does not evaluate whether your product meets listing requirements. Quality issues identified by this API do not block your product from being listed. To verify listing requirements, use the Check Product Listing API
. Version 202411
POST/product/202411/products/diagnose_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 | |||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| product_id | string | The product ID of an existing product in TikTok Shop.- Omit this if you are diagnosing a brand-new product not yet listed in TikTok Shop.- Provide this ID if the product is similar to an existing one, and you want the diagnosis to consider both the existing product's details and the new information in this request. | |||||||||||||||||||||||||||||||||
| category_id Required | string | The ID of the category of this product. It must be a leaf category that corresponds to the category tree type specified in the category_version property. Use the Get Categories API to find out if a category is a leaf category in a particular category_version.Note:- For the US market, refer to TikTok Shop Restricted Products Policy for information on product category restrictions.- For the Indonesia market, to list a product on both TikTok Shop and Tokopedia, you must use only categories that are available on both platforms. | |||||||||||||||||||||||||||||||||
| description | string | The product description in HTML format.Note:- The content must conform to the HTML syntax. All HTML tags are accepted but to optimize display on the TikTok Shop product detail page, the system will automatically convert certain tags into alternative formats, such as rendering tags as images.- Max length: 10,000 characters.- Images must use TikTok Shop image URLs, not exceed 4000px, and include src, width, and height attributes.Recommendations:- If you are syncing a pre-existing description from another platform, include the full HTML source description here.- Provide a detailed description, ideally over 300 characters.- Include 3-5 key selling points, each under 250 characters, with supporting images.- Use 1600x1600 px for the image dimensions.
Example CurlGoNode.jsJavaEnable word wrap Response Parameters
Example JSONEnable word wrap Error Code View common error codes | Code | Message | | --- | --- | | Empty. No business logic error codes. | Is this content helpful?Helpful Not Helpful PreviousNext |