CustomerAddress - Customer Module Data Models Reference
This documentation provides a reference to the CustomerAddress data model. It belongs to the Customer Module.
id
PrimaryKeyModifier<IdProperty>
The ID of the customer address.
is_default_shipping
BooleanProperty
Whether the customer address is used by default for shipping.
is_default_billing
BooleanProperty
Whether the customer address is used by default for billing.
The associated customer.
address_name
TextPropertyOptional
The name of the customer address
company
TextPropertyOptional
The company of the customer address
first_name
TextPropertyOptional
The first name of the customer address
last_name
TextPropertyOptional
The last name of the customer address
address_1
TextPropertyOptional
The first line of the customer address
address_2
TextPropertyOptional
The second line of the customer address
The city of the customer address
country_code
TextPropertyOptional
The country code of the customer address.
@example us
province
TextPropertyOptional
The province of the customer address
postal_code
TextPropertyOptional
The postal code of the customer address
phone
TextPropertyOptional
The phone of the customer address
metadata
JSONPropertyOptional
Holds custom data in key-value pairs.
Was this page helpful?