Filters

Introduction

You can add filtering options on some of the store app pages. This facilitates the preparation process by selecting only items from certain brands, certain shelves or certain delivery modes.

Open

A default configuration is applied in the pages, but this configuration can be overridden. To do this, go to the Configuration > Store App > Pages > {Page name} > Filters section.

Open

Configuration structure

The structure is an array of objects, each object corresponding to 1 filter, with the following fields:

• name (string - mandatory) - Key used to translate the filter, which appears in the format 'filter.{name}.title'.

• field (string - mandatory) - Path used to access the filter value in the entity structure (ex: order.delivery.type)

• filter_type (string- optional) - Choice of one of the following three specific filter types.

  • filter_sub_entity - Filters on path sub-entities. If the field is an array, it must be used.

  • different_value_count_is - Filters according to a specific number of values in the field. Is often used for single-line orders.

  • order_type_is - Specific filter for filtering by order type. For this, it is necessary to specify the possible values in the ‘possible_values’ field, the others will be ignored.

• possible_values(array of objects - optional) Restricts the filter to specific values. All others will be ignored.

  • value (string - mandatory) - One of the filter values.

  • translation key (string - optional) - Translation key for displaying the value.

• do_not_translate - Display the raw filter value instead of the translation key

Default configuration and overlays examples by page

The pages below provide a default configuration, but they may be overloaded. Examples are given to help.