createCustomersWorkflow - Medusa Core Workflows Reference

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

This workflow creates one or more customers. It's used by the Create Customer Admin API Route.

This workflow has a hook that allows you to perform custom actions on the created customer. You can see an example in this guide.

You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating 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.

customersCreated#

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

Example

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

Input

Handlers consuming this hook accept the following input.