getCustomerAddress

Gets customer addresses.

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

Signature

declare function getCustomerAddress(
	context: BigcommerceIntegrationContext,
	params?: index_d_exports$1.GetAddressParameters
): Promise<index_d_exports$1.GetAddressResponse>;

Parameters

Name	Required	Type	Description
`context`	Required	`BigcommerceIntegrationContext`
`params`	Optional	`index_d_exports$1.GetAddressParameters`

Returns

Returns a response containing the object with the created address details.

Referenced Types

BigcommerceIntegrationContext

Examples

Getting customer addresses

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

const address = await sdk.bigcommerce.getCustomerAddress()