Interface ProductProjectionPagedSearchResponse

The response returned to a Product Projection Search request. The object contains the query results with Product Projections where at least one ProductVariant matches the search query, as well as the facet results, if requested.

interface ProductProjectionPagedSearchResponse {
    count: number;
    facets?: FacetResults;
    limit: number;
    offset: number;
    results: ProductProjection[];
    total?: number;
}

Properties

count: number

Actual number of results returned.

facets?: FacetResults

Facet results for each facet expression specified in the search request.

Only present if at least one `facet` parameter was provided with the search request.
limit: number

The maximum number of results returned on a page.

offset: number

The starting point for the retrieved paginated result.

ProductProjections where at least one ProductVariant matches the search query, provided with the text.{language} and/or filter.query or filter query parameter. If the query parameter markMatchingVariants=true was provided with the request, the matching variants are marked as such.

total?: number

Total number of results matching the query.