deleteCustomerAddress

Deletes a customer address.

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

Signature

declare function deleteCustomerAddress$1(
	props: DeleteAddressParameters,
	options?: MethodOptions
): Promise<void>;

Parameters

Name	Required	Type	Description
`props`	Required	`DeleteAddressParameters`	Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.
`options`	Optional	`MethodOptions`

Returns

Returns void

Referenced Types

DeleteAddressParameters

Examples

Deleting a customer address

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

const deleteAddressResponse = await sdk.bigcommerce.deleteCustomerAddress({
 'id:in': [100]
})