Interface InputSearchBoost

Boost products that match the provided filter. Parameter groups are sent based on match type that you are using.

Numeric field match - boosts products based on numeric value stored. Example - boost products with higher price:

{
"field": "price",
"weight": 0.1
}

Other boost matches use filter format. Send filter parameters together with weight param, to boost matched products. Check InputSearchFilter type for more info on filter format.

Example - use value filter to match red products and boost their score by 2:

{
"field": "customFields.color",
"value": [ "red" ],
"weight": 2
}
interface InputSearchBoost {
    all?: InputSearchFilter[];
    any?: InputSearchFilter[];
    field?: string;
    hasValue?: boolean;
    not?: InputSearchFilter[];
    prefix?: string[];
    range?: InputSearchRangeFilter[];
    value?: string[];
    weight: number;
}

Properties

Joins nested filters with logical AND

Joins nested filters with logical OR

field?: string

Product field to apply filter on

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.

Joins nested filters with logical AND and inverts match

prefix?: string[]

List of prefixes to match

List of range filters to apply

value?: string[]

List of values to filter by, joined by OR operator

weight: number

boost weight