Skip to content

Allowed filters

Allowed filters are used to specify which filters can be used by the following entities:

Only fields that are in the ingested SKU and product data or ingested content data can be selected as allowed filters.

Note

User-facing filter fields must be included in the allowed filters. However, not all allowed filters need to be exposed as customer-facing facets. Fields intended solely for service-level filtering should not be added as facets.

Built-in identifier fields

In addition to custom fields from ingested data, the following built-in identifier fields can be added as allowed filters:

Field Description
ProductNumber The business product number
ProductId The internal product identifier
SkuNo The business SKU number
SkuEAN The SKU EAN code
SkuId The internal SKU identifier

These fields are available for service-level filtering only and cannot be used as customer-facing facets. They are useful when a backend service or integration needs to look up or filter products by their identifiers without creating redundant custom fields.

Filtering by business product number

A common use case is looking up products by their business product number. For example, if your system ingests products where ProductNumber contains the business identifier (e.g., "NIS-12345"), you can add ProductNumber as an allowed filter and use it in search requests:

1
2
3
4
5
6
7
8
{
    "filters": {
        "ProductNumber": {
            "values": [ "NIS-12345" ],
            "match": "any"
        }
    }
}

This avoids the need to create a separate custom field that duplicates the product number data.