You are reading the documentation for v7.x and earlier, which is no longer the latest version. Switch to v8.x
GetUserOrderHistoryProps
Properties for getting current user order history.
export interface GetUserOrderHistoryProps extends BaseProps, BaseUserId {
currentPage?: number;
pageSize?: number;
sort?: string;
statuses?: keyof typeof ORDER_STATUSES | string;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
currentPage | Optional | number | The current result page requested. |
pageSize | Optional | number | The number of results returned per page. |
sort | Optional | string | Sorting method applied to the return results. |
statuses | Optional | keyof typeof ORDER_STATUSES | string | Order statuses to filter the returned results by. For example, statuses: CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID. |