Address
A physical postal address, such as a product or extra location.
A physical postal address, such as a product or extra location.
Properties
country_code
The ISO 3166-1 alpha-2 country code for the address.
Returns: String
city
The city for the address.
Returns: String
country
The localised country name for country_code.
Returns: String or nil — nil when country_code is blank.
full_address
The full address formatted from the address lines, city, post code, and country. Lines are separated by newlines.
Returns: String
id
The address unique identifier.
Returns: String — a UUID.
line_one
The first line of the street address.
Returns: String
line_two
The second line of the street address.
Returns: String or nil
post_code
The post code for the address.
Returns: String or nil
region
The geographic region for country_code (e.g. "Americas", "Europe").
Returns: String or nil — nil when country_code is blank.