getOrderProducts

Fetches products associated with an order.

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

Signature

declare function getOrderProducts$1(
	props: GetOrderProductsParameters,
	options?: MethodOptions
): Promise<OrderProductResponse>;

Parameters

Name	Required	Type	Description
`props`	Required	`GetOrderProductsParameters`	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 with the products associated with the order.

Referenced Types

GetOrderProductsParameters
OrderProductResponse

Examples

Fetching a list of products associated with an order.

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

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