Appearance
useCustomerOrders
Definition
Composable for fetching the orders list.
Basic usage
ts
const {
orders,
changeCurrentPage,
loadOrders
} = useCustomerOrders();
Signature
ts
export function useCustomerOrders(): UseCustomerOrdersReturn
Return type
See UseCustomerOrdersReturn
ts
export type UseCustomerOrdersReturn = {
/**
* All placed orders belonging to the logged-in customer
*/
orders: Ref<Order[]>;
/**
* Changes the current page of the orders list
*
* In order to change a page with additional parameters please use `loadOrders` method.
*/
changeCurrentPage(pageNumber: number | string): Promise<void>;
/**
* Fetches the orders list and assigns the result to the `orders` property
*/
loadOrders(parameters?: ShopwareSearchParams): Promise<void>;
};
Properties
| Name | Type | Description |
|---|---|---|
| orders | Ref<Array<Order>> | All placed orders belonging to the logged-in customer |
Methods
| Name | Type | Description |
|---|---|---|
| changeCurrentPage | Promise<void> | Changes the current page of the orders listIn order to change a page with additional parameters please use `loadOrders` method. |
| loadOrders | Promise<void> | Fetches the orders list and assigns the result to the `orders` property |