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 CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
DeleteCustomersWorkflowInput
DeleteCustomersWorkflowInputThe details of the customers to delete.
DeleteCustomersWorkflowInput
DeleteCustomersWorkflowInputids
string[]The IDs of the customers to delete.
ids
string[]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.
input
object
input
objectids
string[]
ids
string[]Was this page helpful?