来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /product/202309/categories/{category_id}/global_attributes
#§2 Method: [GET]
#§3 Function Description
Retrieve the standard built-in product and sales attributes for listing a global product in a particular category, regardless of market variations. Products on TikTok Shop are grouped into categories predefined by TikTok Shop, and each category is associated with a standard set of product attributes and sales attributes.
- Sales attributes (e.g. size, color, length) define product variants and are optional if your product is straightforward and has no variants.
- Product attributes (e.g. manufacturer, country of origin, materials used) describe the product as a whole, regardless of variant. Some product attributes are mandatory based on listing policies. Use this API to determine the mandatory and optional attributes before listing a global product. Note: It must be a leaf category that corresponds to the category tree type specified in the
category_versionproperty.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| category_id | string | Y | 600001 | The ID of the category. It must be a leaf category. |
§6 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. |
| locale | string | N | en-GB | |
| The BCP-47 locale codes for displaying category information. | ||||
| Default: The default locale of your shop. | ||||
| Possible values: |
cs-CZde-ATde-BEde-DEel-GRen-GBen-IEen-USes-ESes-MXfr-FRfr-BEhu-HUid-IDit-ITja-JPms-MYnl-NLnl-BEpl-PLpt-BRpt-PTth-THvi-VNzh-CN| 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 |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/product/202309/categories/600001/global_attributes?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&locale=en-GB
&category_version=v1
§8 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 | |
| ^attributes | []object | The list of standard built-in product and sales attributes that are bound to the specified category. | |
| ^^id | string | 100392 | The ID of the built-in attribute. |
| ^^name | string | Occasion | The name of the built-in attribute. |
| ^^type | string | PRODUCT_PROPERTY | The attribute type. |
| Possible values: |
- SALES_PROPERTY: Indicates sales attributes that define product variants.
- PRODUCT_PROPERTY: Indicates product attributes that describe the product as a whole. | ^^is_requried |bool |false |A flag to indicate if the product attribute is required globally when creating or editing a product.
- true: The attribute is required in all regions.
- false: The attribute is required only in some regions, or if certain conditions are met. Refer to
required_regionsandrequirement_conditionsfor the specific requirements.
Applicable only if type=PRODUCT_PROPERTY. |
^^values |[]object | |A list of selectable values for the attribute. |
^^^id |string |1001533 |The ID of the built-in attribute value. |
^^^name |string |Birthday |The name of the built-in attribute value. |
^^is_multiple_selection |bool |false |A flag to indicate if multiple values can be provided for a product attribute when creating or editing a product.
Applicable only if type=PRODUCT_PROPERTY. |
^^is_customizable |bool |false |A flag to indicate if the product attribute value can be customized by sellers when creating or editing a product.
Applicable only if type=PRODUCT_PROPERTY.
|
^^requirement_conditions |[]object | |A list of conditions that determine if the product attribute is required based on the seller's inputs for other attributes. If any of the conditions is met, the attribute is required; otherwise, it is optional.
For example, there's a condition that states that the ""Battery type"" attribute is required if the seller selects the value ""Batteries"" for the attribute ""Contains Batteries or Cells?"". For more scenario-based guidance on using this parameter, refer to the Solution Guide.
Applicable only if type=PRODUCT_PROPERTY and optional_regions is not empty. |
^^^region |string |IE |The market where the attribute is required when the conditions are met.
Possible values:
- DE: Germany
- ES: Spain
- FR: France
- GB: United Kingdom
- ID: Indonesia
- IT: Italy
- IE: Ireland
- JP: Japan
- MY: Malaysia
- PH: Philippines
- SG: Singapore
- TH: Thailand
- US: United States
- VN: Vietnam
- MX: Mexico | ^^^condition_type |string |VALUE_ID_MATCH |The type of condition, such as matching values, or range comparisons. Possible values:
- VALUE_ID_MATCH: The condition is true when the seller selects a value whose ID matches the one specified in this condition. | ^^^attribute_id |string |101610 |The ID of the product attribute that is being evaluated by the condition. | ^^^attribute_value_id |string |1024358 |The ID of the product attribute value that must match the seller's input for the condition to be true. | ^^optional_regions |[]string |["US"] |The markets where the attribute is purely optional, or required only under certain conditions. Refer to
requirement_conditionsfor details on markets with conditional requirements.
Possible values:
- DE: Germany
- ES: Spain
- FR: France
- GB: United Kingdom
- ID: Indonesia
- IT: Italy
- IE: Ireland
- JP: Japan
- MY: Malaysia
- PH: Philippines
- SG: Singapore
- TH: Thailand
- US: United States
- VN: Vietnam
- MX: Mexico Applicable only if
is_requried=false. | ^^required_regions |[]string |["GB","MY","PH","SG","TH","VN"] |The markets where the attribute is required, without conditions. Possible values: - DE: Germany
- ES: Spain
- FR: France
- GB: United Kingdom
- ID: Indonesia
- IT: Italy
- IE: Ireland
- JP: Japan
- MY: Malaysia
- PH: Philippines
- SG: Singapore
- TH: Thailand
- US: United States
- VN: Vietnam
- MX: Mexico Applicable only if
is_requried=false. |
§9 Response Sample
{"code":0,"data":{"attributes":[{"id":"100392","name":"Occasion","type":"PRODUCT_PROPERTY","is_requried":false,"values":[{"id":"1001533","name":"Birthday"}],"is_multiple_selection":false,"is_customizable":false,"requirement_conditions":[{"region":"IE","condition_type":"VALUE_ID_MATCH","attribute_id":"101610","attribute_value_id":"1024358"}],"optional_regions":["US"],"required_regions":["GB","MY","PH","SG","TH","VN"]}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§10 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 12052023 | Category does not exist |
| 12052024 | Category is not final category |
| 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. |
