Menu

createCustomerAddressesStep - Medusa Core Workflows Reference

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

This step creates one or more customer addresses.

Example#

Code
1const data = createCustomerAddressesStep([2  {3    customer_id: "cus_123",4    first_name: "John",5    last_name: "Doe",6    address_1: "123 Main St",7    city: "Anytown",8    province: "NY",9    postal_code: "12345",10    country_code: "us",11  }12])

Input#

CreateCustomerAddressesStepInputCreateCustomerAddressesStepInput
The data to create one or more customer addresses.
customer_idstring
The associated customer's ID.
address_namenull | stringOptional
The address's name.
is_default_shippingbooleanOptional
Whether the address is default shipping.
is_default_billingbooleanOptional
Whether the address is the default for billing.
companynull | stringOptional
The company.
first_namenull | stringOptional
The first name.
last_namenull | stringOptional
The last name.
address_1null | stringOptional
The address 1.
address_2null | stringOptional
The address 2.
citynull | stringOptional
The city.
country_codenull | stringOptional
The country code.
provincenull | stringOptional
The province.
postal_codenull | stringOptional
The postal code.
phonenull | stringOptional
The phone.
metadataMetadataTypeOptional
Holds custom data in key-value pairs.

Output#

CustomerAddressDTO[]CustomerAddressDTO[]
idstring
The ID of the customer address.
is_default_shippingboolean
Whether the customer address is default shipping.
is_default_billingboolean
Whether the customer address is default billing.
customer_idstring
The associated customer's ID.
created_atstring
The created at of the customer address.
updated_atstring
The updated at of the customer address.
address_namestringOptional
The address name of the customer address.
companystringOptional
The company of the customer address.
first_namestringOptional
The first name of the customer address.
last_namestringOptional
The last name of the customer address.
address_1stringOptional
The address 1 of the customer address.
address_2stringOptional
The address 2 of the customer address.
citystringOptional
The city of the customer address.
country_codestringOptional
The country code of the customer address.
provincestringOptional
The province of the customer address.
postal_codestringOptional
The postal code of the customer address.
phonestringOptional
The phone of the customer address.
metadataRecord<string, unknown>Optional
Holds custom data in key-value pairs.
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
⇧↵