Interface SearchProducts

interface SearchProducts {
    categoryId?: string;
    categoryPath?: string;
    collapse?: string;
    facets?: SearchFacet[];
    from?: number;
    fuzzy?: boolean;
    hits: SearchProduct[];
    size?: number;
    total: number;
}

Properties

categoryId? categoryPath? collapse? facets? from? fuzzy? hits size? total

Properties

OptionalcategoryId

categoryId?: string

Unmodified request parameter categoryId

OptionalcategoryPath

categoryPath?: string

Unmodified request parameter categoryPath

Optionalcollapse

collapse?: string

Returns only one result for each unique value for provided field. Can be used to group product variations (e.g. different colors)

Optionalfacets

facets?: SearchFacet[]

Facet list

Optionalfrom

from?: number

Unmodified request parameter from to be used for further pagination

Optionalfuzzy

fuzzy?: boolean

If main search query returned no results and fuzzy search was triggered

hits

hits: SearchProduct[]

Product list

Optionalsize

size?: number

Unmodified request parameter size to be used for further pagination

total

total: number

How many products were found

Settings

Member Visibility

On This Page

Properties