MerchantOpsMerchantOps

Attribute Dictionary

The Attribute Dictionary defines all available product attributes for your organization. Create consistent, standardized product data.

How to create and configure attributes for your product catalog.

What are Attributes?

Attributes are the individual properties that describe a product. They represent specific characteristics like:

  • Color, Size, Material
  • Weight, Dimensions
  • Warranty, Certifications
  • Technical specifications

The Attribute Dictionary is a centralized repository where you define all attributes available across your product catalog. This ensures consistency and enables standardized data across all products.

Attribute Structure

Each attribute definition includes:

PropertyDescriptionExample
KeyUnique identifier (snake_case)shaft_flex
NameHuman-readable display nameShaft Flex
TypeData type (enum, text, number, etc.)enum
ValuesAllowed values (for enum types)Regular, Stiff, X-Stiff
CategoryGrouping for organizationGolf Equipment
RequiredWhether products must have this attributeYes/No
FacetableUsed for filtering/faceted searchYes/No
SearchableIndexed for full-text searchYes/No

Attribute Types

MerchantOps supports several attribute types:

TypeDescriptionUse Case
enumPredefined list of valuesColor, Size, Material
textFree-form textDescription, Notes
numberNumeric valuesWeight, Price, Length
booleanTrue/false valuesWaterproof, Rechargeable
dateDate valuesRelease Date, Warranty End

Tip: Use enum type whenever possible for categorical data. This ensures consistency and enables better filtering and faceted search.

Viewing the Attribute Dictionary

To access the Attribute Dictionary:

  1. Navigate to Catalog → Attributes in the sidebar
  2. Browse the list of defined attributes
  3. Use search and filters to find specific attributes
Attribute dictionary list view

Filtering Options

  • By Type: Show only enum, text, number, etc.
  • By Category: Filter by attribute category
  • By Flags: Required, Facetable, Searchable
  • Search: Search by name or key

Creating Attributes

To create a new attribute:

  1. Click "Add Attribute"
  2. Fill in the attribute details
  3. For enum types, add the allowed values
  4. Configure flags (Required, Facetable, Searchable)
  5. Click "Create"
Create attribute dialog

Enum Values

For enum type attributes, you'll need to define the allowed values:

  1. In the attribute form, scroll to Values
  2. Click "Add Value"
  3. Enter the value (e.g., "Red", "Blue", "Green")
  4. Repeat for all allowed values

Values can be:

  • Reordered by dragging
  • Edited after creation
  • Deleted (with caution - see best practices)

Attribute Detail Page

Click on any attribute to see its full details:

Attribute detail page

Detail Sections

  • Overview: Basic attribute information
  • Values: List of enum values (for enum types)
  • Product Types: Which product types use this attribute
  • Usage Stats: How many products have this attribute

Editing Attributes

To edit an existing attribute:

  1. Open the attribute detail page
  2. Click "Edit"
  3. Modify the fields as needed
  4. Click "Save Changes"

Warning:Changing an attribute's key will affect all products using this attribute. The attribute type cannot be changed after creation.

Managing Enum Values

You can add, edit, or remove enum values:

  • Add: Click "Add Value" to add new options
  • Edit: Click on a value to rename it
  • Delete: Remove values no longer needed

Caution: Deleting an enum value may affect products currently using that value. Products will show the old value until updated.

Bulk Upload (CSV)

For large attribute sets, you can upload attributes via CSV:

  1. Click "Import CSV"
  2. Download the template file
  3. Fill in your attributes
  4. Upload the completed CSV
  5. Review and confirm the import

CSV Format

ColumnRequiredDescription
keyYesUnique attribute key
nameYesDisplay name
typeYesenum, text, number, boolean, date
valuesFor enumPipe-separated values (e.g., Red|Blue|Green)
categoryNoCategory name
requiredNotrue/false
facetableNotrue/false
searchableNotrue/false
CSV upload dialog

Deleting Attributes

To delete an attribute:

  1. Open the attribute detail page
  2. Click "Delete"
  3. Confirm the deletion

Warning: Deleting an attribute removes it from all product types and products. This action cannot be undone. Consider archiving instead if you might need the data later.

Best Practices

Naming Conventions

  • Keys: Use lowercase snake_case (shaft_flex)
  • Names:Use Title Case for readability ("Shaft Flex")
  • Be specific:"Weight (oz)" is better than just "Weight"

Type Selection

  • Use enum for categories: Colors, sizes, materials work best as enums
  • Use number for measurements: Weight, dimensions, prices
  • Reserve text for descriptions: Long-form content that varies per product

Organization

  • Use categories: Group related attributes together
  • Mark facetable attributes: Enable filtering on commonly used attributes
  • Be selective with required: Only mark truly essential attributes as required

Next Steps

After setting up your attributes: