Documentation
Product Filters
MANAGING PRODUCT FILTERSDocument Revision: v1.0
OVERVIEW
Product Filters allow customers to narrow down catalog search results on the
storefront by specific attributes — for example, filtering by Brand, Material,
or Size. Filters are organised into Filter Groups: a group acts as the label
(e.g. "Brand") and contains one or more individual filter values (e.g.
"Adidas", "Nike", "Puma").
Each group and its filter values have a name per store language and a sort
order. Once created, filter groups and their values can be assigned to
categories and to individual products, making them available on the storefront
filter panel.
REQUIRED PERMISSION
The signed-in admin user must have modify permission on catalog/filter.
ADD/CREATE NEW: STEP-BY-STEP
1. Go to Catalog > Filters.
2. Click the Insert button (top right).
3. For each enabled store language, enter the Group Name (required, 1 to 64
characters). This is the label customers see on the storefront filter panel.
4. Enter a Sort Order for the group to control its position relative to other
filter groups (default: 0).
5. Add at least one filter value:
a. Click Add Filter.
b. For each store language, enter the Filter Name (required, 1 to 64
characters).
c. Enter a Sort Order for this filter value.
d. Repeat for each additional value.
e. To remove a filter row before saving, click Remove on that row.
6. Save using one of these buttons:
- Save Saves and returns to the filter list.
- Apply Saves and re-opens the updated form to continue.
- Cancel Discards changes and returns to the list.
EXAMPLE: CREATE A FILTER GROUP — "Brand"
Goal: create a Brand filter group with three values.
Group Name (English): Brand
Sort Order: 1
Filter Values:
Value 1: Adidas | Sort Order: 1
Value 2: Nike | Sort Order: 2
Value 3: Puma | Sort Order: 3
Steps:
1. Catalog > Filters > Insert
2. Group Name: Brand, Sort Order: 1
3. Click Add Filter — enter "Adidas", Sort Order 1
4. Click Add Filter — enter "Nike", Sort Order 2
5. Click Add Filter — enter "Puma", Sort Order 3
6. Click Save
Result: the list shows "Brand" with Sort Order 1. The group and its values are
now available to assign to categories under Catalog > Categories and to
products under Catalog > Products > [product] > Links tab.
EDIT: STEP-BY-STEP
1. Go to Catalog > Filters.
2. Locate the filter group and click Edit in the Action column.
3. Update the Group Name, Sort Order, and/or filter values as needed:
- To rename a value, update its name inline.
- To add a new value, click Add Filter.
- To remove a value, click Remove on that row.
4. Click Save, Apply, or Cancel.
EXAMPLE: EDIT THE "Brand" FILTER GROUP
Goal: add a fourth brand and update the group sort order.
1. Catalog > Filters > Edit on "Brand"
2. Sort Order: change to 2
3. Click Add Filter
4. Enter "Reebok", Sort Order 4
5. Click Save
Result: the Brand group now has four filter values. Any products or categories
already assigned this filter group will immediately reflect the new value.
DELETE: STEP-BY-STEP
1. Go to Catalog > Filters.
2. Check the box(es) next to the filter group(s) to delete.
3. Click the Delete button.
4. Confirm the dialog when prompted.
5. If deletion succeeds, a success message is shown and the list refreshes.
Note: deleting a filter group also removes all of its filter values. Products
and categories that referenced those filters will have the assignments cleared
automatically.
EXAMPLE: DELETE A FILTER GROUP
Goal: remove an unused "Brand" filter group.
1. Catalog > Filters
2. Check the box for "Brand"
3. Click Delete > Confirm
Result: the Brand group and all its filter values are removed from the
database. Product and category links to those filters are also cleared.
USING FILTERS ON PRODUCTS AND CATEGORIES
After a filter group exists:
Categories:
1. Open Catalog > Categories and edit a category.
2. On the Data tab, locate the Filters field.
3. Begin typing the filter name and select the desired values from the
suggestions (displayed as "Group > Value", e.g. "Brand > Adidas").
4. Save the category.
Products:
1. Open Catalog > Products and edit a product.
2. Open the Links tab, locate the Filters field.
3. Begin typing and select the relevant filter values.
4. Save the product.
Filters are shared definitions; renaming a group or value here is reflected
everywhere it is assigned on the next page load.