stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /product/202405/products/diagnoses
#§2 Method: [GET]
#§3 Function Description
Diagnose multiple existing live (status: ACTIVATE) 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. Note: 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.
§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 | application/json | Allowed type: application/json |
§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. |
| product_ids | []string | Y | 12345678,123456 | The list of product IDs that you want to diagnose. |
Note:
- Max number of IDs: 200
- The product must be live (status:
ACTIVATE) |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/product/202405/products/diagnoses?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&product_ids=12345678,123456
§7 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 | |
| ^products | []object | The list of requested products and the corresponding diagnosis results. | |
| ^^id | string | 123456 | The product ID. |
| ^^listing_quality | object | Product listing quality information. | |
| ^^^current_tier | string | POOR | The current quality tier of this product listing. The quality tier of a product listing depends on the quality of the content in its product fields such as the title, image, attributes etc. |
Possible values:
- POOR
- FAIR
- GOOD
Note: Available only for the US market. |
^^^remaining_recommendations |int |3 |The remaining number of recommendations (see diagnosis_results) that must be implemented for the product to reach the highest tier.
Note:
- To reach the highest tier, you must implement all recommendations listed in
diagnosis_results. - Available only for the US market. | ^^diagnoses |[]object | |Product diagnosis and optimization information. | ^^^field |string |TITLE |The product field being diagnosed. Possible values:
- TITLE: Product title
- DESCRIPTION: Product description
- IMAGE: Product image (
main_imagesin the product entity) - ATTRIBUTE: Product attribute
- SIZE_CHART: Product size chart | ^^^diagnosis_results |[]object | |The results of diagnosing the specified field. | ^^^^code |string |TITLE_LESS_THAN_40_CHARACTERS |A machine-readable code that represents an identified issue. Refer to Listing quality diagnosis for the full list of diagnosed issues and the corresponding recommendations. | ^^^^how_to_solve |string |Names must be at least 40 characters long and contain product-identifying information, such as "hiking boots" or "lipstick". |The recommendation for resolving the identified issue, returned in the default locale language of the shop. Refer to Listing quality diagnosis for the full list of recommendations. | ^^^^quality_tier |string |GOOD |The listing quality tier you can reach by implementing the recommendation. Possible values:
- FAIR
- GOOD
Note:
- To reach a higher tier, you must implement all recommendations from the destination tier and all preceding tiers. For example, a product will reach the "GOOD" tier once all "FAIR" and "GOOD" recommendations are addressed or implemented.
- Available only for the US market. | ^^^suggestion |object | |Optimization suggestions that are auto-generated by the system to improve the effectiveness of the specified field. | ^^^^seo_words |[]object | |The SEO keyword suggestions for product titles. | ^^^^^text |string |dress |The suggested SEO keyword. | ^^^^smart_texts |[]object | |The list of optimized product title or description. | ^^^^^text |string |this is a good title |The optimized text. | ^^^^images |[]object | |The optimized image. Only the first image in the
main_imagesset will be optimized. | ^^^^^height |int |600 |The image height after optimization. | ^^^^^width |int |600 |The image width after optimization. | ^^^^^uri |string |tos-maliva-i-o3syd03w52-us/53b55d6e8cdf1f315affa7e70b45707d |The original URI of the image. | ^^^^^url |string |https://p16-graph-va.ibyteimg.com/tos-maliva-i-1por3rr4fy-us/v2/53b55d6e8cdf1f315affa7e70b45707d~tplv-1por3rr4fy-image.webp |The original URL of the image. | ^^^^^optimized_uri |string |tos-maliva-i-o3syd03w52-us/0266127022264e54ad2f639f5e0fb5e6 |The URI of the image after optimization. | ^^^^^optimized_url |string |https://p16-graph-va.ibyteimg.com/tos-maliva-i-1por3rr4fy-us/v2/0266127022264e54ad2f639f5e0fb5e6~tplv-1por3rr4fy-image.webp |The URL of the image after optimization. |
§8 Response Sample
{"code":0,"data":{"products":[{"id":"123456","listing_quality":{"current_tier":"POOR","remaining_recommendations":3},"diagnoses":[{"field":"TITLE","diagnosis_results":[{"code":"TITLE_LESS_THAN_40_CHARACTERS","how_to_solve":"Names must be at least 40 characters long and contain product-identifying information, such as \"hiking boots\" or \"lipstick\".","quality_tier":"GOOD"}],"suggestion":{"seo_words":[{"text":"dress"}],"smart_texts":[{"text":"this is a good title"}],"images":[{"height":600,"width":600,"uri":"tos-maliva-i-o3syd03w52-us/53b55d6e8cdf1f315affa7e70b45707d","url":"https://p16-graph-va.ibyteimg.com/tos-maliva-i-1por3rr4fy-us/v2/53b55d6e8cdf1f315affa7e70b45707d~tplv-1por3rr4fy-image.webp","optimized_uri":"tos-maliva-i-o3syd03w52-us/0266127022264e54ad2f639f5e0fb5e6","optimized_url":"https://p16-graph-va.ibyteimg.com/tos-maliva-i-1por3rr4fy-us/v2/0266127022264e54ad2f639f5e0fb5e6~tplv-1por3rr4fy-image.webp"}]}}]}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§9 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 12009014 | seller no permission for product error |
| 12019114 | Seller has no permission |
| 12019120 | The number of provided product IDs exceeds the limit. |
| 12052260 | The product ID does not exist |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
