Alokai

updateCustomerAddress

Updates a Customer Address.

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

Signature

declare function updateCustomerAddress(
	context: BigcommerceIntegrationContext,
	params: index_d_exports$1.UpdateAddressParameters
): Promise<index_d_exports$1.UpdateAddressResponse>;

Parameters

NameRequiredTypeDescription
contextRequiredBigcommerceIntegrationContext
paramsRequiredindex_d_exports$1.UpdateAddressParameters

Returns

Returns a response of a a customer address object.

Referenced Types

Examples

Updating a customer address

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

const res = 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'
})

On this page