updateAddress

Updates a saved address of the signed-in customer by address id.

This method communicates with the updateAddress endpoint of the Vue Storefront API Middleware. In turn, it receives data from the updateCustomerAddress or the Update customer address endpoints exposed by SCAPI / OCAPI depending on the middleware configuration.

Signature

export declare function updateAddress(
	props: CustomerUpdateAddressParams
): Promise<import("commerce-sdk/dist/customer/customer").ShopperCustomers.CustomerAddress>;

Parameters

Returns

Returns a representation of a Customer Address.

Referenced Types

• CustomerUpdateAddressParams
• ShopperCustomers.CustomerAddress

Examples

Updates an existing saved customer address.

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

const category = await sdk.commerce.updateAddress({
  addressId: 'Home',
  countryCode: 'US',
});