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

    Interface PagedQueryResponse

    Each query endpoint returns a paged query response containing the actual resources matching the query predicate plus information about pagination. This documents the fields all query responses have in common, for specific response types, see the respective API reference pages.

    interface PagedQueryResponse {
        count: number;
        limit: number;
        meta?: any;
        offset: number;
        results: BaseResource[];
        total?: number;
    }
    Index

    Properties

    count: number

    Actual number of results returned.

    limit: number

    Number of results requested.

    meta?: any

    Object containing supplementary information about the results.

    offset: number

    Number of elements skipped.

    results: BaseResource[]

    The resources matching the query predicate. Each query endpoint returns resources of its specific type.

    total?: number

    Total number of results matching the query. This number is an estimation that is not strongly consistent. This field is returned by default. For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. When the results are filtered with a Query Predicate, total is subject to a limit.