deleteCustomersWorkflow - Medusa Core Workflows Reference

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

This workflow deletes one or more customers. It's used by the removeCustomerAccountWorkflow.

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

Source Code

Examples#

Steps#

Workflow hook

Step conditioned by when

View step details

Input#

DeleteCustomersWorkflowInputDeleteCustomersWorkflowInput
The details of the customers to delete.
idsstring[]
The IDs of the customers 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.

customersDeleted#

Handlers consuming this hook accept the following input.

inputobject
idsstring[]
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break