Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

CustomerAddressDTO

The customer address details.

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?
Edit this page
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
⇧↵