Home > @vue-storefront/magento-api > deleteCustomerAddress

deleteCustomerAddress() function

Deletes a customer address.

Signature:

export default function deleteCustomerAddress(context: Context, addressId: number, customQuery?: CustomQuery, customHeaders?: CustomHeaders): Promise<ExecutionResult<DeleteCustomerAddressMutation>>;

Parameters

Parameter	Type	Description
context	Context	VSF Context
addressId	number	ID of the customer address to delete
customQuery	CustomQuery	(Optional) (optional) - custom GraphQL query that extends the default query
customHeaders	CustomHeaders	(Optional) (optional) - custom headers that extends the default headers

Returns:

Promise<ExecutionResult<DeleteCustomerAddressMutation>>