Alokai

getOrders

Fetches orders.

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

Signature

declare function getOrders(
	context: BigcommerceIntegrationContext,
	params?: index_d_exports$1.GetOrdersParameters
): Promise<index_d_exports$1.OrdersResponse>;

Parameters

NameRequiredTypeDescription
contextRequiredBigcommerceIntegrationContext
paramsOptionalindex_d_exports$1.GetOrdersParameters

Returns

Returns a response with the orders data

Referenced Types

Examples

Fetching orders

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

const ordersResponse = await sdk.bigcommerce.getOrders();

On this page