getCustomerAddress

Gets customer addresses.

This method sends a POST request to the getCustomerAddress endpoint of the Vue Storefront API Middleware. In turn, it receives data from the getCustomerAddress endpoint exposed by the BigCommerce API

Signature

declare function getCustomerAddress$1(
	props?: GetAddressParameters,
	options?: MethodOptions
): Promise<GetAddressResponse>;

Parameters

Name	Required	Type	Description
`props`	Optional	`GetAddressParameters`	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 containing the object with the created address details.

Referenced Types

GetAddressParameters
GetAddressResponse

Examples

Getting customer addresses

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

const address = await sdk.bigcommerce.getCustomerAddress()