GET Get Categories
Get Categories Shop Required scope: seller.product.basic Retrieve the list of product categories available for your shop. Product categories are updated frequently, so it's recommended to call the API in real time to ensure you are using the latest category data. Caching category data locally may result in using outdated information, leading to errors when creating products. 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. Please call this API twice to identify the overlapping categories. Version 202309
GET/product/202309/categories
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. |
| locale | string | The 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 |
| keyword | string | Filter categories by this keyword in local_name. |
| category_version | string | Filter 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_platform | string | Filter categories by the specified platform.Possible values:- TIKTOK_SHOP- TOKOPEDIADefault: TIKTOK_SHOPApplicable only for sellers that migrated from Tokopedia. |
| include_prohibited_categories | bool | A flag to indicate whether to include categories that are prohibited on TikTok Shop. Set this to true to identify which are the product categories that you can't list on TikTok Shop in any circumstances.Applicable only for BR, MX, EU and SEA markets. |
| 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 |
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 | | --- | --- | | 12019210 | publish param invalid | | 12052023 | Category does not exist | | 12052217 | All region shops must use V2 categories. Check the documentation for further details. | | 12052230 | Category version and categoryID are not matched. | | 12052700 | The seller is inactive. | | 12052704 | seller id not exist | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
Is this content helpful?Helpful
Not Helpful
PreviousNext