getOrderProducts

Fetches products associated with an order.

It receives data from the getOrderProducts endpoint exposed by the BigCommerce API

Signature

declare function getOrderProducts(
	context: BigcommerceIntegrationContext,
	params?: index_d_exports$1.GetOrderProductsParameters
): Promise<index_d_exports$1.OrderProductResponse>;

Parameters

Name	Required	Type	Description
`context`	Required	`BigcommerceIntegrationContext`
`params`	Optional	`index_d_exports$1.GetOrderProductsParameters`

Returns

Returns a response with the products associated with the order.

Referenced Types

BigcommerceIntegrationContext

Examples

Fetching a list of products associated with an order.

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

const orderProductsResponse = await sdk.bigcommerce.getOrderProducts({ orderId: 286 })