Skip to main content

POST Recommend Category

Recommend Category Shop Required scope: seller.product.basic Retrieve the recommended category for a candidate product based on its title, description, and images. If you are syncing product catalogs from an external system to TikTok Shop, use this API to facilitate product categorization. Note: The language used in text fields such as descriptions and titles must align with the target market's language (e.g. don't use Chinese). Version 202309

POST/product/202309/categories/recommend

Request

Header

PropertiesTypeDescription
content-type RequiredstringAllowed type: application/json
x-tts-access-token RequiredstringThe seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

PropertiesTypeDescription
app_key RequiredstringEvery single app will have a unique key. Please use the specific key assigned to your app.
sign RequiredstringSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp RequiredintUnix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
shop_cipher RequiredstringUse 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

PropertiesTypeDescription
product_title RequiredstringThe product title. Title length:- DE, ES, FR, IE, IT, JP, UK, US: [1, 255] - BR, MX: [1, 300]- Other regions: [25, 255]
descriptionstringThe 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.- Image guidelines: You must use TikTok Shop image URLs. Max 30 tags, each under 4000px with 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.
images[]objectProduct images, including gallery images, images that appear in the description, product variant images.
category_versionstringFilter categories by the category tree version.Possible values based on region:- US, EU and SEA: v2, represents the 7-level category tree. Important: For US, EU and SEA shops, you must pass v2 when using this API.- Other regions: v1, represents the 3-level category tree.Default: v1
listing_platformstringRecommend categories that belong to the specified platform.Possible values:- TIKTOK_SHOP- TOKOPEDIADefault: TIKTOK_SHOPApplicable only for sellers that migrated from Tokopedia.
include_prohibited_categoriesboolA flag to indicate whether to include matching categories that are prohibited on TikTok Shop. Set this to true to identify if the product falls under a category that you can't list on TikTok Shop in any circumstances.Note:- Applicable only for BR and MX markets.- Default: false
localestringThe BCP-47 locale codes for displaying category information.Default: The default locale of your shop.Possible values:- cs-CZ- de-AT- de-BE- de-DE- el-GR- en-GB- en-IE- en-US- es-ES- es-MX- fr-FR- fr-BE- hu-HU- id-ID- it-IT- ja-JP- ms-MY- nl-NL- nl-BE- pl-PL- pt-BR- pt-PT- th-TH- vi-VN- zh-CN

Example

CurlGoNode.jsJavaEnable word wrap

Response Parameters

PropertiesTypeDescription
codeintThe success or failure status code returned in API response.
messagestringThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstringRequest log
dataobjectSpecific return information

Example

JSONEnable word wrap

Error Code

View common error codes

| Code | Message | | --- | --- | | 12019006 | product description is invalid | | 12019009 | product image list is invalid | | 12019064 | No matching categories. Provide the full name of your product, edit its product properties, and try again. | | 12052013 | The product description cannot exceed maximum characters | | 12052051 | The product name exceed max limit characters | | 12052056 | The num of image in description cannot exceed max limit | | 12052217 | All region shops must use V2 categories. Check the documentation for further details. | | 12052230 | Category version and categoryID are not matched. | | 12052261 | product name is empty | | 12052262 | Chinese characters are not supported in product name | | 12052266 | The product name contains non-English characters. | | 12052300 | product main image uri illegal | | 12052301 | Width and length of main image must be at least {{min_limit}}, check uri {{uri}} | | 12052305 | The main images aspect ratio cannot exceed max limit. | | 12052306 | main product images count exceed limit | | 12052340 | product description image uri illegal | | 12052341 | The description images size cannot exceed limit. | | 12052343 | Product description image format not support. | | 12052345 | The product description html tag not support. | | 12052346 | The product description has Chinese characters | | 12052348 | The product description html tag required attribute is miss. | | 12052349 | The product description html tag not support nest. | | 12052350 | The product description html tag contain illegal attribute. | | 12052351 | The product description contains non-English characters. | | 12052352 | The product description nest exceeding limit | | 12052700 | The seller is inactive. | | 12052704 | seller id not exist | | 12052722 | The image URI does not exist in TikTok Shop. | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. | | 12052912 | No matching category found within your account's main category. Check your main category in the seller profile on Seller Center and ensure your product falls within its scope. | | 12052931 | The title must follow these formatting rules: it cannot contain HTML escape characters (e.g.,  ), emojis, or ASCII control characters (e.g., \u007F). It also cannot consist solely of symbols (e.g., //// or !@#$$$&), nor can it have more than 9 consecutive repeated characters (e.g., aaaaaaaaa or 111111111). |

Is this content helpful?Helpful

Not Helpful

PreviousNext