Skip to main content

address

An address, such as a customer address or order shipping address.

Tip

Use the format_address filter to output an address according to its locale.

Properties

Anchor to
address1
string

The first line of the address.

Anchor to
address2
string

The second line of the address.

If no second line is specified, then nil is returned.

Anchor to
city
string

The city of the address.

Anchor to
company
string

The company of the address.

If no company is specified, then nil is returned.

Anchor to
country
country

The country of the address.

Anchor to
country_code
string

The country of the address in ISO 3166-1 (alpha 2) format.

Anchor to
first_name
string

The first name of the address.

Anchor to
id
number

The ID of the address.

Anchor to
last_name
string

The last name of the address.

Anchor to
name
string

A combination of the first and last names of the address.

Anchor to
phone
string

The phone number of the address.

If no phone number is specified, then nil is returned.

Anchor to
province
string

The province of the address.

Anchor to
province_code
string

The province of the address in ISO 3166-2 (alpha 2) format.

Note

The value doesn't include the preceding ISO 3166-1 country code.

Anchor to
street
string

A combination of the first and second lines of the address.

Anchor to
summary
string

A summary of the address, including the following properties:

  • First and last name
  • First and second lines
  • City
  • Province
  • Country
Anchor to
url
string

The relative URL for the address.

Note

This only applies to customer addresses.

Anchor to
zip
string

The zip or postal code of the address.

{
"address1": "150 Elgin Street",
"address2": "8th floor",
"city": "Ottawa",
"company": "Polina's Potions, LLC",
"country": {},
"country_code": "CA",
"first_name": null,
"id": 56174706753,
"last_name": null,
"name": "",
"phone": "416-123-1234",
"province": "Ontario",
"province_code": "ON",
"street": "150 Elgin Street, 8th floor",
"summary": "150 Elgin Street, 8th floor, Ottawa, Ontario, Canada",
"url": "/account/addresses/56174706753",
"zip": "K2P 1L4"
}
Was this section helpful?