updateCustomerAddress

Updates a Customer Address.

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

Signature

declare function updateCustomerAddress(
	props: UpdateAddressParameters,
	options?: MethodOptions
): Promise<UpdateAddressResponse>;

Parameters

Name	Required	Type	Description
`props`	Required	`UpdateAddressParameters`	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 of a a customer address object.

Referenced Types

Examples

Updating a customer address

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

const updateCustomerAddress = await sdk.bigcommerce.updateCustomerAddress({
 id: 19,
 first_name: 'Name',
 last_name: 'Surname',
 company: 'Company',
 address1: 'New Address',
 address2: '5',
 city: 'Edinburgh',
 state_or_province: '',
 postal_code: 'EH1 1ST',
 country_code: 'GB',
 phone: '074743473312'
})