GET Get Brands
Get Brands Shop Required scope: seller.product.basic Retrieve all available brands for your shop, including the built-in brands and any custom brands created using the Create Custom Brands API
. Pass the returned brand ID when creating or editing a product to associate the brand with the product.
- To check if a brand is fully authorized for use in a specific product category, specify the category ID.
- To obtain the full list of brands that your shop can potentially use and their authorization status, omit the category ID. We recommend that you specify the brand name to narrow down the list of brands returned. Key concept Whether you can select and display a brand depends on the brand's authorization status, the categories authorized for the brand, and whether the brand is classified as T1 (internationally renowned brands that require prior brand authorization).
- Brand selection rules: You can only select the following types of brands during product creation/editing.
- Authorized brands which contain the desired category (authorized_status=AUTHORIZED and brand_status=AVAILABLE)
- Unauthorized non-T1 brands (authorized_status=UNAUTHORIZED and is_t1_brand=false)
- Brand display rules: Note however that brands will only appear on the product display page if the brand is authorized (authorized_status=AUTHORIZED) and available in the desired category (brand_status=AVAILABLE). This means that you need to obtain brand authorization for unauthorized non-T1 brands before they can be displayed. Obtain brand authorization or add categories to an authorized brand through TikTok Shop Seller Center > Qualification Center > Brand qualification. For Tokopedia sellers: You can select and display any returned brand on Tokopedia regardless of these rules. Version 202309
GET/product/202309/brands
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. |
| category_id | string | Specify a category ID to show the availability of authorized brands in the category.Note: Specify this value to obtain an accurate list of brands that you can use in a category. |
| is_authorized | bool | Filter results by the brand authorization status.Possible values:- 1: Returns only authorized brands- 0: Returns all brands |
| brand_name | string | Filter results to include brand names that begin with the specified value. |
| page_size Required | int | The number of results to be returned per page.Valid range: [1-100] |
| page_token | string | An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page. |
| 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 |
| 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 | | --- | --- | | 12019108 | page number is invalid | | 12019109 | page size is invalid | | 12019123 | product of pageSize and pageNumber exceeds the maximum limit | | 12019124 | pageSize and pageNumber need to be used together | | 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