来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /product/202309/brands
#§2 Method: [GET]
#§3 Function Description
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=AUTHORIZEDandbrand_status=AVAILABLE) - Unauthorized non-T1 brands (
authorized_status=UNAUTHORIZEDandis_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.
§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. |
| category_id | string | N | 600006 | 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 | N | false | Filter results by the brand authorization status. |
| Possible values: |
- 1: Returns only authorized brands
- 0: Returns all brands | brand_name |string |N |Teas |Filter results to include brand names that begin with the specified value. | page_size |int |Y |100 |The number of results to be returned per page. Valid range: [1-100] | page_token |string |N |b2Zmc2V0PTAK |An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the
next_page_tokenfrom a previous response. It is not needed for the first page. | category_version |string |N |v1 |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 |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/product/202309/brands?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&category_id=600006&is_authorized=false&brand_name=Teas&page_size=100&page_token=b2Zmc2V0PTAK&category_version=v1
§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 | |
| ^brands | []object | The list of brands that meet the query conditions. | |
| ^^id | string | 7082427311584347905 | The brand ID. |
| ^^name | string | Teas | The brand name. |
| ^^authorized_status | string | AUTHORIZED | A status to indicate whether the seller has obtained prior authorization to sell goods bearing the brand's trademark, name, or logo. |
| Possible values: |
- UNAUTHORIEZD
- AUTHORIZED
Note: If the brand is unauthorized, check is_t1_brand to determine if you can use it during product creation. |
^^is_t1_brand |bool |true |A flag to indicate whether the brand is a T1 brand, which refers to internationally renowned brands that may have compliance risks and require sellers to obtain brand authorization.
Note:
- You cannot create products with unauthorized T1 brands.
- You can create products with unauthorized non-T1 brands, but the brand information will not appear on the product display page. You can obtain authorization by submitting the required qualifications through TikTok Shop Seller Center > Qualification Center > Brand qualification. | ^^brand_status |string |AVAILABLE |The availability of an authorized brand in the requested category. Possible values:
- AVAILABLE
- UNAVAILABLE
Note: Not applicable if you did not specify the category ID, or the brand is unauthorized. |
^total_count |int |10000 |The total count of brands that meet the query conditions. |
^next_page_token |string |b2Zmc2V0PTAK |An opaque token used to retrieve the next page of a paginated result set. Provide this value in the page_token parameter of your request if the current response does not return all the results. |
§8 Response Sample
{"code":0,"data":{"brands":[{"id":"7082427311584347905","name":"Teas","authorized_status":"AUTHORIZED","is_t1_brand":true,"brand_status":"AVAILABLE"}],"total_count":10000,"next_page_token":"b2Zmc2V0PTAK"},"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 |
|---|---|
| 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. |
