getOrderShippingAddresses
Fetches a shipping address associated with an order.
This method sends a POST request to the getOrderShippingAddresses endpoint of the Vue Storefront API Middleware. In turn, it receives data from the getOrderShippingAddresses endpoint exposed by the BigCommerce API
Signature
declare function getOrderShippingAddresses$1(
props: GetOrderShippingAddressesParameters,
options?: MethodOptions
): Promise<OrderShippingAddressesResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
props | Required | GetOrderShippingAddressesParameters | 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
Examples
Fetches a shipping address associated with an order.
import { sdk } from '~/sdk.config.ts';
const orderShippingAddressResponse = await sdk.bigcommerce.getOrderShippingAddresses({ orderId: 286 })