You are reading the documentation for v7.x and earlier, which is no longer the latest version. Switch to v8.x
GetAllCartsProps
Parameters for getting user carts.
export interface GetAllCartsProps extends BaseProps, BaseUserId {
currentPage?: number;
pageSize?: number;
savedCartsOnly?: boolean;
sort?: string;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
currentPage | Optional | number | Optional pagination parameter. Has effect only if savedCartsOnly is set to true. Defaults to 0. |
pageSize | Optional | number | Number of carts to return. Has effect only if savedCartsOnly is set to true. Defaults to 20. |
savedCartsOnly | Optional | boolean | If provided, only saved carts will be returned. |
sort | Optional | string | Carts sorting rule. Has effect only if savedCartsOnly is set to true. |