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

CustomerAddress - Customer Module Data Models Reference

This documentation provides a reference to the CustomerAddress data model. It belongs to the Customer Module.

idPrimaryKeyModifier<IdProperty>
The ID of the customer address.
is_default_shippingBooleanProperty
Whether the customer address is used by default for shipping.
is_default_billingBooleanProperty
Whether the customer address is used by default for billing.
customerBelongsTo<Customer>
The associated customer.
address_nameTextPropertyOptional
The name of the customer address
companyTextPropertyOptional
The company of the customer address
first_nameTextPropertyOptional
The first name of the customer address
last_nameTextPropertyOptional
The last name of the customer address
address_1TextPropertyOptional
The first line of the customer address
address_2TextPropertyOptional
The second line of the customer address
cityTextPropertyOptional
The city of the customer address
country_codeTextPropertyOptional
The country code of the customer address. @example us
provinceTextPropertyOptional
The province of the customer address
postal_codeTextPropertyOptional
The postal code of the customer address
phoneTextPropertyOptional
The phone of the customer address
metadataJSONPropertyOptional
Holds custom data in key-value pairs.
Was this page helpful?