getOrdersWithDetails
Gets orders data with shipping address and products data, by a cart id.
This method sends a POST request to the getOrdersWithDetails endpoint of the Vue Storefront API Middleware. In turn, it receives data from the getOrders getOrdersProducts getOrderShippingAddresses endpoints exposed by the BigCommerce API
This endpoint can be used for cases where there are multiple orders associated to one cart.
Signature
declare function getOrdersWithDetails$1(
props: GetOrdersWithDetailsParameters,
options?: MethodOptions
): Promise<OrdersWithDetailsResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
props | Required | GetOrdersWithDetailsParameters | 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 of orders data with products and the shipping address.
Referenced Types
Examples
Getting the order with details by cart id.
import { sdk } from '~/sdk.config.ts';
const getOrdersWithDetailsResponse = await sdk.bigcommerce.getOrderByCart({
cart_id: '7c3ab631-782c-4747-8ccc-873e87de5152'
})