findOrCreateCustomerStep - Medusa Core Workflows Reference

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

This step either finds a customer matching the specified ID, or finds / create a customer matching the specified email. If both ID and email are provided, ID takes precedence. If the customer is a guest, the email is updated to the provided email.

src/workflows/my-workflow.ts
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { findOrCreateCustomerStep } from "@medusajs/medusa/core-flows"3
4const myWorkflow = createWorkflow(5  "my-workflow",6  () => {7    const data = findOrCreateCustomerStep({})8  }9)

Input#

FindOrCreateCustomerStepInputFindOrCreateCustomerStepInput
The details of the customer to find or create.
customerIdnull | stringOptional
The ID of the customer to find.
emailnull | stringOptional
If the customerId isn't specified, find a customer with this email or create a new customer having this email.

Output#

FindOrCreateCustomerOutputStepOutputFindOrCreateCustomerOutputStepOutput
The details of the customer found or created.
customernull | CustomerDTOOptional
The customer found or created, if any.
emailnull | stringOptional
The email of the customer found or created, if any.
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