An address, such as an order shipping address.

PropertiesTypeDescription
addressstringThe first line of the address.
address1stringThe second line of the address.
citystringThe city of the address.
companystringThe company of the address. If no company is specified, then an empty string is returned.
countrystringThe country of the address.
country_codestringThe country of the address is in ISO 3166-1 (alpha 2) format.
emailstringThe email of the address. If no email is specified, then an empty string is returned.
first_namestringThe first name of the address.
idstringThe ID of the address.
is_defaultbooleanReturns true if the address is the default.
last_namestringThe last name of the address.
phonestringThe phone number of the address.
phone_area_codestringThe phone area code of the address.
provincestringThe province of the address.
province_codestringThe province of the address is in ISO 3166-2 (alpha 4) format.
zipstringThe zip or postal code of the address.
{
  "id": "ed853cba-628a-42df-b5b0-672ff18e0db6",
  "first_name": null,
  "last_name": null,
  "email": "[email protected]",
  "country_code": "CA",
  "country": "Canada",
  "province_code": "CA-ON",
  "province": "Ontario",
  "area": null,
  "city": "Ottawa",
  "address": "150 Elgin Street",
  "address1": "8th floor",
  "zip": "K2P 1L4",
  "company": "",
  "phone": "416-123-1234",
  "phone_area_code": "CA_647",
  "is_default": true
}