getOrderByCart

Gets order data by cart.

This method sends a POST request to the getOrderByCart endpoint of the Vue Storefront API Middleware. In turn, it receives data from the getOrders getOrdersProducts getOrderShippingAddresses endpoints exposed by the BigCommerce API

Signature

declare function getOrderByCart$1(
	props: GetOrderByCartParameters,
	options?: MethodOptions
): Promise<OrderByCartResponse>;

Parameters

Name	Required	Type	Description
`props`	Required	`GetOrderByCartParameters`	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 an object containing order data with products and the shipping address.

Referenced Types

GetOrderByCartParameters
OrderByCartResponse

Examples

Getting the order by cart.

import { sdk } from '~/sdk.config.ts';

const getOrderByCartResponse = await sdk.bigcommerce.getOrderByCart({
  cartId: '7c3ab631-782c-4747-8ccc-873e87de5152'
})