getOrdersWithDetails

Gets orders data with shipping address and products data, by a cart id.

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(
	context: BigcommerceIntegrationContext,
	params?: GetOrdersWithDetailsParameters
): Promise<OrdersWithDetailsResponse>;

Parameters

Returns

Returns a response of orders data with products and the shipping address.

Referenced Types

• BigcommerceIntegrationContext
• GetOrdersWithDetailsParameters
• OrdersWithDetailsResponse

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