Home > @vsf-enterprise/sap-commerce-webservices-sdk > OrdersApi > getUserOrderHistory
OrdersApi.getUserOrderHistory() method
Returns order history data for all orders placed by a specified user for a specified base store. The response can display the results across multiple pages, if required. Get order history for user.
Signature:
getUserOrderHistory(baseSiteId: string, userId: string, currentPage?: number, fields?: string, pageSize?: number, sort?: string, statuses?: string, options?: any): Promise<import("axios").AxiosResponse<OrderHistoryList>>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| baseSiteId | string | Base site identifier |
| userId | string | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
| currentPage | number | The current result page requested. |
| fields | string | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
| pageSize | number | The number of results returned per page. |
| sort | string | Sorting method applied to the return results. |
| statuses | string | Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID. |
| options | any | Override http request option. |
Returns:
Promise<import("axios").AxiosResponse<OrderHistoryList>>
Exceptions
{RequiredError} OrdersApi