Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

createCustomerAccountWorkflow - Medusa Core Workflows Reference

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

This workflow creates a customer and attaches it to an auth identity. It's used by the Register Customer Store API Route.

You can create an auth identity first using the Retrieve Registration JWT Token API Route. Learn more about basic authentication flows in this documentation.

You can use this workflow within your customizations or your own custom workflows, allowing you to register or create customer accounts within your custom flows.

Source Code

Examples#

Steps#

validateCustomerAccountCreation

createCustomersWorkflow

setAuthAppMetadataStep

Workflow Hook

Step conditioned by when

Input#

CreateCustomerAccountWorkflowInputCreateCustomerAccountWorkflowInput
The details of the customer account to create.
authIdentityIdstring
The ID of the auth identity to attach the customer to.
customerDataCreateCustomerDTO
The details of the customer to create.

Output#

CustomerDTOCustomerDTO
The customer details.
idstring
The ID of the customer.
emailstring
The email of the customer.
has_accountboolean
A flag indicating if customer has an account or not.
default_billing_address_idnull | string
The associated default billing address's ID.
default_shipping_address_idnull | string
The associated default shipping address's ID.
company_namenull | string
The company name of the customer.
first_namenull | string
The first name of the customer.
last_namenull | string
The last name of the customer.
addressesCustomerAddressDTO[]
The addresses of the customer.
phonenull | string
The phone of the customer.
groupsobject[]
The groups of the customer.
metadataRecord<string, unknown>
Holds custom data in key-value pairs.
created_bynull | string
Who created the customer.
deleted_atnull | string | Date
The deletion date of the customer.
created_atstring | Date
The creation date of the customer.
updated_atstring | Date
The update date of the customer.
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
⇧↵