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.
Source CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
UpdateCustomersWorkflowInputUpdateCustomersWorkflowInputThe data to update one or more customers, along with custom data that's passed to the workflow's hooks.
UpdateCustomersWorkflowInputUpdateCustomersWorkflowInputselectorFilterableCustomerPropsThe filters to select the customers to update.
selectorFilterableCustomerPropsupdateCustomerUpdatableFieldsThe data to update in the customers.
updateCustomerUpdatableFieldsadditional_dataRecord<string, unknown>OptionalAdditional data that can be passed through the additional_data property in HTTP requests.
Learn more in this documentation.
additional_dataRecord<string, unknown>Optionaladditional_data property in HTTP requests.
Learn more in this documentation.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 | DateHooks#
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#
Handlers consuming this hook accept the following input.
invokeInvokeFn<object, TOutput, TCompensateInput>