Documentation
Product Attributes
MANAGING PRODUCT ATTRIBUTESDocument Revision: v1.0
OVERVIEW
Attributes define reusable product specification labels (for example, "Screen
Size", "Weight", or "Battery Life"). Each attribute has a name (one per store
language), belongs to an attribute group (for example, "Specifications" or
"Dimensions"), and has a sort order that controls how it appears within that
group on the product form and on the storefront. Attributes do not store
product values themselves; values are entered per product when you edit a
product under Catalog > Products.
Before creating attributes, ensure at least one attribute group exists under
Catalog > Attributes > Attribute Groups (see "Product Attribute Groups").
REQUIRED PERMISSION
The signed-in admin user must have modify permission on catalog/attribute.
ADD/CREATE NEW: STEP-BY-STEP
1. Go to Catalog > Attributes > Attributes.
2. Click the Insert button (top right).
3. On the form, for each enabled store language:
a. Enter the Attribute Name (required, 3 to 64 characters).
Each language has its own input field with a flag icon.
4. Choose an Attribute Group from the dropdown (populated from existing
groups created under Catalog > Attributes > Attribute Groups).
5. Enter a Sort Order (optional integer; defaults to 0 on create). Lower
numbers appear first among attributes in the same group on the product
form and storefront.
6. Save the attribute using one of these buttons:
- Save Saves the attribute and returns to the attribute list.
- Apply Saves the attribute and re-opens the updated form to continue.
- Cancel Discards changes and returns to the list.
EXAMPLE: CREATE AN ATTRIBUTE — "Screen Size"
Goal: add a technical specification attribute under the "Specifications"
group (create that group first if it does not exist).
Attribute Name (English): Screen Size
Attribute Group: Specifications
Sort Order: 1
Steps:
1. Catalog > Attributes > Attribute Groups — ensure "Specifications" exists
(Sort Order 1). If not, create it first.
2. Catalog > Attributes > Attributes > Insert
3. English: enter "Screen Size"
4. Attribute Group = Specifications
5. Sort Order = 1
6. Click Save
Result: the list shows "Screen Size" in the Specifications group with Sort
Order 1. The attribute is available when adding attributes to products under
Catalog > Products.
EDIT: STEP-BY-STEP
1. Go to Catalog > Attributes > Attributes.
2. Locate the attribute in the list.
3. Click Edit in the Action column for that attribute.
4. Update the Attribute Name for any language, change the Attribute Group,
and/or change the Sort Order.
5. Click Save, Apply, or Cancel as when creating.
EXAMPLE: EDIT THE "Screen Size" ATTRIBUTE
Goal: rename for clarity, move to the Dimensions group, and adjust sort order.
1. Catalog > Attributes > Attributes
2. Find "Screen Size" > Edit
3. Attribute Name (English): Display Size
4. Attribute Group: Dimensions
5. Sort Order: 4
6. Click Save
Result: the list shows "Display Size" under Dimensions with Sort Order 4.
Products that already had a value for this attribute keep their stored values;
only the attribute definition (name, group, order) changes.
DELETE: STEP-BY-STEP
1. Go to Catalog > Attributes > Attributes.
2. Check the box(es) next to the attribute or attributes to delete.
(Use the header checkbox to select all attributes on the current page.)
3. Click the Delete button.
4. Confirm the dialog when prompted ("Delete/Uninstall cannot be undone!
Are you sure you want to do this?").
5. If deletion succeeds, a success message is shown and the list refreshes.
Important: an attribute cannot be deleted while it is still assigned to one
or more products. If products use the attribute, the warning "This attribute
cannot be deleted as it is currently assigned to X products!" is displayed
and no rows are removed. Remove the attribute from those products first under
Catalog > Products, then delete the attribute definition.
EXAMPLE: DELETE AN UNUSED ATTRIBUTE
Goal: remove a test attribute "Depth" that is not assigned to any product.
1. Catalog > Attributes > Attributes
2. Check the box for "Depth"
3. Click Delete > Confirm
Result: the Depth attribute and its language descriptions are removed from
the database.
EXAMPLE: DELETE BLOCKED WHEN PRODUCTS USE THE ATTRIBUTE
Goal: attempt to delete "Screen Size" which is assigned to 5 products.
1. Catalog > Attributes > Attributes
2. Check the box for "Screen Size"
3. Click Delete > Confirm
Result: deletion fails with a warning such as "Warning: This attribute cannot
be deleted as it is currently assigned to 5 products!" To proceed:
a. Go to Catalog > Products.
b. Edit each product that uses "Screen Size" and remove that attribute
from the product form (or clear its values).
c. Return to Catalog > Attributes > Attributes and delete "Screen Size"
again.
USING ATTRIBUTES ON PRODUCTS
After an attribute exists:
1. Open Catalog > Products and edit or create a product.
2. On the product form, add attributes (autocomplete is available via the
catalog/attribute/autocomplete JSON endpoint).
3. Enter the attribute value per language for that product (stored in
product_attribute.text).
4. Save the product.
Attributes are grouped on the product form and storefront according to their
attribute group. Sort order on the attribute controls ordering within the
group; attribute group sort order controls ordering among groups.
RELATED DOCUMENTATION
Product Attribute Groups — create and manage groups before or alongside attributes.