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.

Examples#

Steps#

Input#

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#

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

Example

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

Input

Handlers consuming this hook accept the following input.

Emitted Events#

This section lists the events that are either triggered by the emitEventStep in the workflow, or by another workflow executed within this workflow.

You can listen to these events in a subscriber, as explained in the Subscribers documentation.

[{
  id, // The ID of the customer
}]