Skip to main content

Attributes

This page explains how to create and manage custom attribute definitions for products, categories, companies, contacts, customers and clusters.

Attributes overview showing the Product tab with a table of attributes, search bar and filters

Before you begin

  • You need the Configuration role to view this page.
  • You need Owner access on the Configuration role to create or delete attributes.

View attributes

Go to Admin > Attributes. The page shows tabs for each attribute class: Category, Product, Company, Contact, Customer and Cluster. Select a tab to view the attributes for that class.

ColumnDescription
IdAttribute ID
NameAttribute name (UPPERCASE_WITH_UNDERSCORES format)
DescriptionLocalized description
GroupAttribute group
TypeData type (Text, Enum, Color, DateTime, Int or Decimal)
UnitUnit of measure
SearchableWhether the attribute is searchable in filters
PublicWhether the attribute is visible in the storefront
SystemWhether it is a system attribute
HiddenWhether it is hidden from the UI
DefaultDefault value
Date CreatedWhen created (sortable)
Date UpdatedWhen last modified (sortable)

Create an attribute

  1. Select the tab for the attribute class you want (for example, Product).
  2. Click New Attribute for the selected class.
  3. Fill in the attribute details:
FieldRequiredDescription
NameYes (max 64 chars)Attribute name in UPPERCASE_WITH_UNDERSCORES format. Cannot be changed after creation.
DescriptionYesLocalized description (with language switcher)
UnitsNoUnit of measure (localized)
GroupNoGrouping label
TypeNoData type: Text, Enum, Color, DateTime, Int or Decimal. Cannot be changed after creation.
Select a valuesetConditionalOnly for Enum type. Pick the value set that provides dropdown options. Cannot be changed after creation.
Default valueNoDepends on the type: text, enum values, color picker, date/time picker, integer or decimal
SearchableNoInclude in search and filter functionality
PublicNoVisible in the storefront
tip

Mark an attribute as Searchable to let users filter products by it in the catalogue. Mark it as Public to display it on product detail pages. An attribute can be Searchable without being Public, or the other way around.

| System | No | Mark as a system attribute | | Hidden | No | Hide from the UI |

  1. Click Save.

Edit an attribute

Click any row to open the edit dialog. The Name, Type and Valueset fields cannot be changed after creation.

Edit Attribute dialog showing Name, Units, Group, Tags and checkbox fields

Delete attributes

  1. Select one or more attributes using the checkboxes.
  2. Use the delete action.
  3. Confirm the deletion.

Search and filter attributes

Use the search bar to find attributes by name. You can also apply filters:

FilterTypeDescription
NamesMulti-value chipsFilter by attribute names
TypesCheckboxesText, Enum, Color, DateTime, Int, Decimal
GroupsMulti-value chipsFilter by group names
SearchableRadioYes or No
PublicRadioYes or No
SystemRadioYes or No
HiddenRadioYes or No