createCustomersStep - Medusa Core Workflows Reference
This documentation provides a reference to the createCustomersStep. It belongs to the @medusajs/medusa/core-flows package.
This step creates one or more customers.
Example#
Input#
CreateCustomersStepInputCreateCustomersStepInputThe data to create one or more customers.
CreateCustomersStepInputCreateCustomersStepInputcompany_namenull | stringOptionalThe company name of the customer.
company_namenull | stringOptionalfirst_namenull | stringOptionalThe first name of the customer.
first_namenull | stringOptionallast_namenull | stringOptionalThe last name of the customer.
last_namenull | stringOptionalemailnull | stringOptionalThe email of the customer.
emailnull | stringOptionalphonenull | stringOptionalThe phone of the customer.
phonenull | stringOptionalcreated_bynull | stringOptionalWho created the customer.
created_bynull | stringOptionalhas_accountbooleanOptionalWhether the customer has an account.
has_accountbooleanOptionalThe addresses of the customer.
Holds custom data in key-value pairs.
Output#
CustomerDTO[]CustomerDTO[]
CustomerDTO[]CustomerDTO[]idstringThe ID of the customer.
idstringemailstringThe email of the customer.
emailstringhas_accountbooleanA flag indicating if customer has an account or not.
has_accountbooleandefault_billing_address_idnull | stringThe associated default billing address's ID.
default_billing_address_idnull | stringdefault_shipping_address_idnull | stringThe associated default shipping address's ID.
default_shipping_address_idnull | stringcompany_namenull | stringThe company name of the customer.
company_namenull | stringfirst_namenull | stringThe first name of the customer.
first_namenull | stringlast_namenull | stringThe last name of the customer.
last_namenull | stringaddressesCustomerAddressDTO[]The addresses of the customer.
addressesCustomerAddressDTO[]phonenull | stringThe phone of the customer.
phonenull | stringgroupsobject[]The groups of the customer.
groupsobject[]metadataRecord<string, unknown>Holds custom data in key-value pairs.
metadataRecord<string, unknown>created_bynull | stringWho created the customer.
created_bynull | stringdeleted_atnull | string | DateThe deletion date of the customer.
deleted_atnull | string | Datecreated_atstring | DateThe creation date of the customer.
created_atstring | Dateupdated_atstring | DateThe update date of the customer.
updated_atstring | DateWas this page helpful?