Interface GetProductsQuery

Query parameters for sb.shop.products.list().

interface GetProductsQuery {
    categoryRef?: string;
    id?: string;
    limit?: number;
    locationRef?: string;
    nextPageToken?: string;
}

Properties

categoryRef?: string

UUID of the shop category.

id?: string

Comma-separated product UUIDs, e.g. uuid1,uuid2. Up to 25 ids per request.

limit?: number

Maximum number of products per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

locationRef?: string

UUID of the location.

nextPageToken?: string

Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page.