Alokai

getOrder

Fetches an order.

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

Signature

declare function getOrder(
	context: BigcommerceIntegrationContext,
	params: index_d_exports$1.GetOrderProductsParameters
): Promise<index_d_exports$1.Order>;

Parameters

NameRequiredTypeDescription
contextRequiredBigcommerceIntegrationContext
paramsRequiredindex_d_exports$1.GetOrderProductsParameters

Returns

Returns a response with the order data

Referenced Types

Examples

Fetching an order

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

const orderId = 123;
const orderResponse = await sdk.bigcommerce.getOrder({ orderId });

On this page