Alokai

getOrderShippingAddresses

Fetches a shipping address associated with an order.

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

Signature

declare function getOrderShippingAddresses(
	context: BigcommerceIntegrationContext,
	params?: index_d_exports$1.GetOrderShippingAddressesParameters
): Promise<index_d_exports$1.OrderShippingAddressesResponse>;

Parameters

NameRequiredTypeDescription
contextRequiredBigcommerceIntegrationContext
paramsOptionalindex_d_exports$1.GetOrderShippingAddressesParameters

Returns

Returns a response with the products associated with the order.

Referenced Types

Examples

Fetches a shipping address associated with an order.

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

const orderShippingAddressResponse = await sdk.bigcommerce.getOrderShippingAddresses({ orderId: 286 })

On this page