Interface ProductSelectionProductPagedQueryResponse

PagedQueryResult containing an array of AssignedProductReference.

interface ProductSelectionProductPagedQueryResponse {
    count: number;
    limit: number;
    offset: number;
    results: AssignedProductReference[];
    total?: number;
}

Properties

count limit offset results total?

Properties

Readonly count

count: number

Actual number of results returned.

Readonly limit

limit: number

Number of results requested.

Readonly offset

offset: number

Number of elements skipped.

Readonly results

results: AssignedProductReference[]

References to Products that are assigned to the ProductSelection.

Optional Readonly total

total?: number

Total number of results matching the query. This number is an estimation that is not strongly consistent. Unlike other endpoints, the Product Selection endpoint does not return this field by default. To get total, pass the query parameter withTotal set to true. When the results are filtered with a Query Predicate, total is subject to a limit.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc