Get Started
Product
Resources
Tools & SDKs
Framework
Reference

deleteCustomerAddressesWorkflow - Medusa Core Workflows Reference

This documentation provides a reference to the deleteCustomerAddressesWorkflow. It belongs to the @medusajs/medusa/core-flows package.

This workflow deletes one or more customer addresses. It's used by the Remove Customer Addresses Admin API Route and the Remove Customer Addresses Store API Route.

Note: This workflow deletes addresses created by the Customer Module only. So, you can't delete addresses attached to a cart, for example. To do that, use the workflow relevant to that module.

You can use this workflow within your customizations or your own custom workflows, allowing you to delete customer addresses in your custom flows.

Source Code

Examples#

Steps#

deleteCustomerAddressesStep

addressesDeleted

Workflow Hook

Step conditioned by when

Input#

DeleteCustomerAddressesWorkflowInputDeleteCustomerAddressesWorkflowInput

The details of the addresses to delete.

idsstring[]

The IDs of the addresses to delete.

Hooks#

Hooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.

Learn more about Hooks and Additional Data.

addressesDeleted#

This hook is executed after the addresses are deleted. You can consume this hook to perform custom actions.

Example

Code
1import { deleteCustomerAddressesWorkflow } from "@medusajs/medusa/core-flows"2
3deleteCustomerAddressesWorkflow.hooks.addressesDeleted(4  (async ({ ids }, { container }) => {5    //TODO6  })7)

Input

Handlers consuming this hook accept the following input.

inputobject

The input data for the hook.

idsstring[]

Was this page helpful?