@gradientedge/commercetools-utils
    Preparing search index...

    Interface ProductSearchRequest

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

    Properties

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

    Properties

    facets?: ProductSearchFacetExpression[]

    Set this field to request facets.

    limit?: number

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

    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.

    offset?: number

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

    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.

    productProjectionParameters?: ProductSearchProjectionParams

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

    query?: _SearchQuery

    The search query against searchable Product fields.

    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