Home > @vsf-enterprise/bigcommerce-api > Endpoints > getOrderShippingAddresses

Endpoints.getOrderShippingAddresses() method

Returns the shipping addresses of the given order. Optional filter parameters can be passed in.

Signature:

getOrderShippingAddresses(context: BigcommerceIntegrationContext, params?: GetOrderShippingAddressesParameters): Promise<OrderShippingAddressesResponse>;

Parameters

Parameter	Type	Description
context	BigcommerceIntegrationContext	An auto-generated value prepended to the method as a first parameter.
params	GetOrderShippingAddressesParameters	(Optional) An object which contains optional properties for retrieving the shipping addresses of an order.

Returns:

Promise<OrderShippingAddressesResponse>