The address object
An address associated with a customer. Addresses are populated by the customer in the checkout.
A customer can enter two addresses: a billing address and a shipping address. When accessing attributes of the address
object, you must specify which address you want to target by using either shipping_address
or billing_address
before the attribute.
The address
object can be used in email templates, the order status page of the checkout, and in apps such as Order Printer.
address.address1
Anchor link to section titled "address.address1"Returns the value of the Address1 field of the address.
address.address2
Anchor link to section titled "address.address2"Returns the value of the Address2 field of the address.
address.city
Anchor link to section titled "address.city"Returns the value of the City field of the address.
address.company
Anchor link to section titled "address.company"Returns the value of the Company field of the address.
address.country
Anchor link to section titled "address.country"Returns the value of the Country field of the address.
address.country_code
Anchor link to section titled "address.country_code"Returns the value of the Country field of the address in ISO 3166-2 standard format.
address.first_name
Anchor link to section titled "address.first_name"Returns the value of the First Name field of the address.
address.last_name
Anchor link to section titled "address.last_name"Returns the value of the Last Name field of the address.
address.name
Anchor link to section titled "address.name"Returns the values of the First Name and Last Name fields of the address.
address.phone
Anchor link to section titled "address.phone"Returns the value of the Phone field of the address.
address.province
Anchor link to section titled "address.province"Returns the value of the Province/State field of the address.
address.province_code
Anchor link to section titled "address.province_code"Returns the abbreviated value of the Province/State field of the address.
address.street
Anchor link to section titled "address.street"Returns the combined values of the Address1 and Address2 fields of the address.
address.url
Anchor link to section titled "address.url"Returns the relative URL of the address.
address.zip
Anchor link to section titled "address.zip"Returns the value of the Postal/Zip field of the address.