Tag

Represents a Tag entity in your store. Unlike Attributes, Tags are structured with a predefined set of selectable values (e.g., Brand, Color, Size) used primarily for filtering and categorization.

Tag Definition

Property	Type	Description
id	string (UUID)	Unique identifier of the tag.
name	string	Internal name of the tag.
label	string | null	Front-end display label.
type	string	Data type (e.g., string, color, image).
format	string | null	Specific format if applicable.
sortable	boolean	If true, the catalog can be sorted by this tag.
relevant	boolean	If true, it is displayed in the main product information.
icon	string | null	Reference to the associated icon.
position	number	Display order of the tag.
values	TagValue[]	Array of available values for this tag.

---

TagValue

Represents an individual value assigned to a specific Tag.

Property	Type	Description
id	string (UUID)	Unique identifier of the specific value.
value	string	The actual value (e.g., "Nike").
alias	string | null	Alternative name or SEO alias for the value.
position	number	Display order of this value within the tag.

Object Example

{
  "id": "bbbdb0e1-0829-43a6-867d-2f26b2b2186f",
  "name": "Brand",
  "label": null,
  "type": "string",
  "format": null,
  "sortable": false,
  "relevant": true,
  "icon": null,
  "position": 0,
  "values": [
    {
      "id": "05b3701e-c6ba-44b1-afd9-a7f0e168b031",
      "value": "Nike",
      "alias": null,
      "position": 0
    },
    {
      "id": "b4a03a7e-8194-47e1-8dce-b03895aa639e",
      "value": "Adidas",
      "alias": null,
      "position": 0
    }
  ]
}

Filtering

Tag values are essential for catalog filtering. If you set a tag as filterable, you can use it for targeted searches. Using the right number of tags will also improve text-based search results.