This documentation provides a reference to the createCustomerAddressesWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow creates one or more addresses for customers. It's used by the Add Customer Address Admin API Route and the Add Customer Address Store API Route.
This workflow has a hook that allows you to perform custom actions on the created customer addresses. For example, you can pass under additional_data
custom data that
allows you to create custom data models linked to the addresses.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating customer addresses.
Source CodeWorkflow hook
Step conditioned by when
View step details
CreateCustomerAddressesWorkflowInput
CreateCustomerAddressesWorkflowInputaddresses
CreateCustomerAddressDTO[]additional_data
Record<string, unknown>Optionaladditional_data
property in HTTP requests.
Learn more in this documentation.CustomerAddressDTO[]
CustomerAddressDTO[]id
stringis_default_shipping
booleanis_default_billing
booleancustomer_id
stringcreated_at
stringupdated_at
stringaddress_name
stringOptionalcompany
stringOptionalfirst_name
stringOptionallast_name
stringOptionaladdress_1
stringOptionaladdress_2
stringOptionalcity
stringOptionalcountry_code
stringOptionalprovince
stringOptionalpostal_code
stringOptionalphone
stringOptionalmetadata
Record<string, unknown>OptionalHooks 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.
This hook is executed after the addresses are created. You can consume this hook to perform custom actions on the created addresses.
Handlers consuming this hook accept the following input.
input
inputaddresses
CustomerAddressDTO[]additional_data
Record<string, unknown> | undefinedadditional_data
property in HTTP requests.
Learn more in this documentation.