updateCustomersWorkflow - Medusa Core Workflows Reference

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

This workflow updates one or more customers. It's used by the Update Customer Admin API Route and the Update Customer Store API Route.

This workflow has a hook that allows you to perform custom actions on the updated customer. For example, you can pass under additional_data custom data to update custom data models linked to the customers.

You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around updating customers.

Examples#

Steps#

Input#

Output#

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.

customersUpdated#

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

Example

Code
1import { updateCustomersWorkflow } from "@medusajs/medusa/core-flows"2
3updateCustomersWorkflow.hooks.customersUpdated(4  (async ({ customers, additional_data }, { 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
}]