Get Category Attributes

GET

/product/202309/categories/{category_id}/attributes

Retrieve the standard built-in product and sales attributes for listing a product in a particular category based on your shop’s location. 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 product. Note: It must be a leaf category that corresponds to the category tree type specified in the category_version property.

Authorizations

• accessToken

Parameters

Path Parameters

category_id

required

string

The ID of the category of this product. It must be a leaf category.

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

locale

string

Allowed 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

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

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

is_live_quick

boolean

False — NORMAL products true — LIVE_QUICK products. Only seller with the required permissions can creat LIVE_QUICK products. Default: false

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

attributes

The list of standard built-in product and sales attributes that are bound to the specified category, based on your shop’s location.

Array<object>

object

id

The ID of the built-in attribute.

string

name

The name of the built-in attribute.

string

type

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.

string

Allowed values: SALES_PROPERTY PRODUCT_PROPERTY

is_requried

A flag to indicate if the product attribute is always required when creating or editing a product.

• true: The attribute is always required.
• false: The attribute is not required, or required only if certain conditions are met. Refer to requirement_conditions for the specific requirements.

Applicable only if type=PRODUCT_PROPERTY.

boolean

values

A list of selectable values for the attribute.

Array<object>

object

id

The ID of the built-in attribute value.

string

name

The name of the built-in attribute value.

string

icon_url

The icon url value of the built-in attribute value.

string

value_data_format

The data format for a free-form attribute value.

Returned for customizable numeric attributes.

Possible values:

• POSITIVE_INT_OR_DECIMAL: Positive integers or decimal numbers.

string

Allowed values: POSITIVE_INT_OR_DECIMAL

is_customizable

A flag indicating whether sellers can enter a custom value for the attribute when creating or editing a product.

boolean

requirement_conditions

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 - CAT-PRE-HAZMAT.

Applicable only if type=PRODUCT_PROPERTY and is_requried=false.

Array<object>

object

condition_type

The type of condition. Possible values:

• VALUE_ID_MATCH: The condition is true when the seller selects a value whose ID matches the one specified in this condition.

string

Allowed values: VALUE_ID_MATCH

attribute_id

The ID of the product attribute that is being evaluated by the condition.

string

attribute_value_id

The ID of the product attribute value that must match the seller’s input for the condition to be true.

string

is_multiple_selection

A flag indicating whether sellers can select multiple values for the attribute when creating or editing a product.

boolean

metric_standards

Defines the measurement template information used to describe the measurement standards and metric values configured for the product.

Array<object>

object

id

The unique ID of the measurement template. Use this ID to identify which measurement standard template applies to the product.

string

name

The name of the measurement template.

string

metric_value_modules

Metric value modules.

Array<object>

object

id

The unique ID of a metric item within the measurement template. This ID identifies which metric the submitted value belongs to.

string

name

The seller-provided value for the specified metric item in the measurement template.

string

input_type

Metric value modules input type.

string

data_types

Metric value modules data type.

Array<string>

default_values

Metric value modules default values.

Array<object>

object

id

Metric value modules default value id.

string

name

Metric value modules default value name.

string

units

Metric value modules units.

Array<object>

object

id

Unit id.

string

name

Unit name.

string

value_limit

Metric value value limit.

object

num_limit

Metric value num limit.

object

min_value

Metric value num limit min value.

integer format: int64

max_value

Metric value num limit max value.

integer format: int64

length_limit

Metric value length limit.

object

min_length

Metric value min length.

integer format: int64

max_length

Metric value max length.

integer format: int64

prefix

Metric value prefix.

string

suffix

Metric value suffix.

string

shading_word

Metric value shading word.

string

Example

{
  "data": {
    "attributes": [
      {
        "type": "SALES_PROPERTY",
        "value_data_format": "POSITIVE_INT_OR_DECIMAL",
        "requirement_conditions": [
          {
            "condition_type": "VALUE_ID_MATCH"
          }
        ]
      }
    ]
  }
}