getOrders
Fetches orders
This method sends a POST request to the getOrders endpoint of the Vue Storefront API Middleware. In turn, it receives data from the getOrders endpoint exposed by the BigCommerce API
Signature
declare function getOrders$1(
props?: GetOrdersParameters,
options?: MethodOptions
): Promise<OrdersResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
props | Optional | GetOrdersParameters | Parameter object which can be used with this method. Refer to its type definition to learn about possible properties. |
options | Optional | MethodOptions |
Returns
Returns a response with the orders data
Referenced Types
Examples
Fetching orders
import { sdk } from '~/sdk.config.ts';
const ordersResponse = await sdk.bigcommerce.getOrders();