Skip to main content

Custom Attributes

Custom Attributes let you extend the default data model for Customers, Carts, and Lines with company-specific fields.

Go to Configuration β†’ Company β†’ Custom Attributes in Owner. Use the tabs at the top to switch between the three categories.

The main list shows:

ColumnDescription
Name & API Name (Slug)Display name and technical identifier
TypeData format stored in the field
DescriptionInternal notes about the attribute's purpose
ActionsIcons to view details, edit, or remove attributes

Creating a New Attribute​

Click + New attribute and fill in:

FieldRequiredDescription
NameYesLabel shown in the UI
API Name (slug)YesTechnical identifier used in integrations and APIs (e.g. loyalty_points)
TypeYesData format β€” see table below
DescriptionNoInternal note explaining the attribute's purpose

Available Data Types​

TypeDescriptionExample
StringPlain textCustomer's occupation
NumberNumerical valuesCredit score or points
Array - StringList of multiple text values["VIP", "Eco-friendly"]
Array - NumberList of multiple numbersList of preferred store IDs
BooleanTrue / False toggle"Is subscribed to newsletter"
DateSpecific calendar dayBirthday or anniversary
Date & timeSpecific day and exact timeLast activity timestamp

Marking an Attribute as Personal Data (PII)​

Every new attribute has the Contains personal data toggle ON by default. This means the value is treated as PII and masked for users who don't have access to personal data.

SettingMeaningWho sees the value
Contains personal data ON (default)Value is treated as personal dataOnly users with PII access see the real value; others see it masked
Contains personal data OFFNot personal dataAll users see the real value

To change the PII setting on an existing attribute: open it with the Edit (pencil) icon β†’ scroll to the Personally Identifiable Information (PII) section β†’ toggle as needed β†’ click Update attribute.

Attributes marked as personal data show a lock icon next to their name in the list view.

warning

Disabling the PII toggle on a field that actually contains personal data will make those values visible to all users. This is recorded in the activity log.

For more details on how masking works across the platform, see Role-Based Data Masking.

Draft Mode and Saving​

While adding attributes they remain in Draft state. Before clicking Save you can edit any field (including Type and Slug) or delete the draft.

danger

Once you click Save, attributes are permanently locked:

  • You cannot delete the attribute
  • You cannot change the Type or the API Name (slug)
  • You can only modify the display Name and Description

Make sure all technical details are correct before saving.