Interface ProductSearchRequest

interface ProductSearchRequest {
    facets?: ProductSearchFacetExpression[];
    limit?: number;
    markMatchingVariants?: boolean;
    offset?: number;
    postFilter?: _SearchQuery;
    productProjectionParameters?: ProductSearchProjectionParams;
    query?: _SearchQuery;
    sort?: SearchSorting[];
}

Properties

facets? limit? markMatchingVariants? offset? postFilter? productProjectionParameters? query? sort?

Properties

Optional Readonlyfacets

facets?: ProductSearchFacetExpression[]

Set this field to request facets.

Optional Readonlylimit

limit?: number

The maximum number of search results to be returned in one page.

Optional ReadonlymarkMatchingVariants

markMatchingVariants?: boolean

If query specifies an expression for a Product Variant field, set this to true to get additional information for each returned Product about which Product Variants match the search query. For details, see matching variants.

Optional Readonlyoffset

offset?: number

The number of search results to be skipped in the response for pagination.

Optional ReadonlypostFilter

postFilter?: _SearchQuery

Specify an additional filter on the result of the query after the API calculated facets. This feature assists you in implementing faceted search.

Optional ReadonlyproductProjectionParameters

productProjectionParameters?: ProductSearchProjectionParams

Controls data integration with Product Projection parameters. If not set, the result does not include the Product Projection.

Optional Readonlyquery

query?: _SearchQuery

The search query against searchable Product fields.

Optional Readonlysort

sort?: SearchSorting[]

Controls how results to your query are sorted. If not provided, the results are sorted by relevance score in descending order.

Settings

Member Visibility

On This Page

Properties