Properties & Attributes
Properties and Attributes are used to enrich products with additional data and characteristics.
They provide flexibility, allowing you to define custom information that fits your specific business and industry needs.
- A Property defines a category of information (e.g., Color, CO2 Emission, Documentation Link).
- An Attribute is the value assigned to that property for a specific product (e.g., Blue, 120 g/km, https://docs.example.com).
Every product can have any number of attributes, and you can create as many properties as you need.
Creating Properties
Properties are created independently and can then be assigned to products.
Fields
| Field | Description | Example |
|---|---|---|
| Active | Toggle to enable or disable the property in the system. | Active |
| Name | The display name of the property. | Color, CO2 Emission |
| Slug | Unique identifier used internally. | color, co2_emission |
| Description | Rich-text description of the property, optionally with documentation. | Defines the product’s emission value per km. |
| Type | Data type for the property: String, Number, or Boolean. | String (e.g., Blue) |
Property Types
When creating a property, you must select its type:
- String – Text-based values.
- Example: Color = Blue, Documentation Link = https://docs.example.com
- Number – Numeric values.
- Example: CO2 Emission = 120 g/km
- Boolean – True/False values.
- Example: ISO Certified = Yes/No
Adding Attributes to Products
Once properties exist, you can assign attributes (property values) to products.
Examples:
- Property: Color → Attribute: Black
- Property: CO2 Emission → Attribute: 120 g/km
- Property: Documentation Link → Attribute: https://example.com/manual.pdf
Attributes are flexible and can be applied across multiple products, ensuring consistency and enabling rules, filters, and logic in configurators.
Use Cases
- Technical data: CO2 Emission, Wattage, Dimensions
- Commercial data: Campaign Reference, Product Line
- Links: Documentation Link, CAD File URL
- Boolean flags: ISO Certified = Yes/No, Available in EU = Yes/No
Best Practices
- Use consistent property names to avoid duplication (e.g., always use Color, not Colour).
- Keep slugs lowercase and underscored for easy referencing in rules and APIs (e.g.,
co2_emission). - Use numbers for measurable values and booleans for flags to ensure data integrity.
- Add descriptions to clarify how a property should be used across your team.
- Regularly review properties to keep your catalog clean and relevant.