Interface InputSearchTopLevelFilter

Same as InputSearchFilter type, but accepts an additional optional parameter excludeFacets

interface InputSearchTopLevelFilter {
    all?: InputSearchFilter[];
    any?: InputSearchFilter[];
    excludeFacets?: string[];
    field?: string;
    hasValue?: boolean;
    not?: InputSearchFilter[];
    prefix?: string[];
    range?: InputSearchRangeFilter[];
    value?: string[];
}

Properties

all? any? excludeFacets? field? hasValue? not? prefix? range? value?

Properties

Optionalall

all?: InputSearchFilter[]

Joins nested filters with logical AND

Optionalany

any?: InputSearchFilter[]

Joins nested filters with logical OR

OptionalexcludeFacets

excludeFacets?: string[]

List of facet ID's to which this filter should not be applied. (default: all facets with the same field as filter if filter contains field, otherwise empty)

Optionalfield

field?: string

Product field to apply filter on

OptionalhasValue

hasValue?: boolean

If true, matches all products which have the value on selected field. If false, matches all products which have no value in selected field.

Optionalnot

not?: InputSearchFilter[]

Joins nested filters with logical AND and inverts match

Optionalprefix

prefix?: string[]

List of prefixes to match

Optionalrange

range?: InputSearchRangeFilter[]

List of range filters to apply

Optionalvalue

value?: string[]

List of values to filter by, joined by OR operator

Settings

Member Visibility

On This Page

Properties