Get Started
Product
Resources
Tools & SDKs
Framework
Reference

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[]

CustomerAddressDTOCustomerAddressDTO

The customer address details.

Was this page helpful?