getOrderByCart

Gets order data by cart.

It receives data from the getOrders getOrdersProducts getOrderShippingAddresses endpoints exposed by the BigCommerce API

Signature

declare function getOrderByCart(
	context: BigcommerceIntegrationContext,
	params?: GetOrderByCartParameters
): Promise<OrderByCartResponse>;

Parameters

Name	Required	Type	Description
`context`	Required	`BigcommerceIntegrationContext`
`params`	Optional	`GetOrderByCartParameters`

Returns

Returns a response of an object containing order data with products and the shipping address.

Referenced Types

BigcommerceIntegrationContext
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'
})