Address Data Type

Postal address used in orders, customer profiles, and shop configuration. A customer can have multiple addresses associated with their account.

Available Since
1.3.0
Properties
Name Type Description
id number A unique identifier for the address.
street string The customer's mailing address
streetNo string An additional field for the customer's mailing address.
address2 string An additional field for the customer's mailing address.
city string The customer's city, town, or village.
company string The customer's company
country string The customer's country.
firstName string The customer’s first name.
lastName string The customer’s last name.
latitude number The latitude of the shipping address.
longitude number The longitude of the shipping address.
name string The customer’s first and last names.
phone string The customer’s phone number at this address.
email string The email address of the customer.
province string The customer’s region name. Typically a province, a state, or a prefecture.
zip string The customer’s postal code, also known as zip, postcode, Eircode, etc.
countryCode string The two-letter country code corresponding to the customer's country.
provinceCode string The two-letter code for the customer’s region.
stateCode string Abbreviated state or province code.
stateName string Full name of the state or province.
Address (JSON) 
{
  "address" : {
    "id" : 12345,
    "street" : "Golborne Road",
    "streetNo" : "45",
    "address2" : "...",
    "city" : "London",
    "company" : "...",
    "country" : "United Kingdom",
    "firstName" : "John",
    "lastName" : "Doe",
    "latitude" : 45.41685,
    "longitude" : -71.6822,
    "name" : "John Doe",
    "phone" : "+44208269323",
    "email" : "john.doe@emailservice.com",
    "province" : "...",
    "zip" : "WC2N 5DU",
    "countryCode" : "UK",
    "provinceCode" : "...",
    "stateCode" : "CA",
    "stateName" : "California"
  }
}
Address Data Type

Postal address used in orders, customer profiles, and shop configuration. A customer can have multiple addresses associated with their account.

Available Since
1.3.0
Properties
Name Type Description
address2 string An additional field for the customer's mailing address.
city string The customer's city, town, or village.
company string The customer's company
country string The customer's country.
countryCode string The two-letter country code corresponding to the customer's country.
email string The email address of the customer.
firstName string The customer’s first name.
id int A unique identifier for the address.
lastName string The customer’s last name.
latitude double The latitude of the shipping address.
longitude double The longitude of the shipping address.
name string The customer’s first and last names.
phone string The customer’s phone number at this address.
province string The customer’s region name. Typically a province, a state, or a prefecture.
provinceCode string The two-letter code for the customer’s region.
stateCode string Abbreviated state or province code.
stateName string Full name of the state or province.
street string The customer's mailing address
streetNo string An additional field for the customer's mailing address.
zip string The customer’s postal code, also known as zip, postcode, Eircode, etc.
Address (XML) 
<address>
  <id>...</id>
  <street>Golborne Road</street>
  <streetNo>45</streetNo>
  <address2>...</address2>
  <city>London</city>
  <company>...</company>
  <country>United Kingdom</country>
  <firstName>John</firstName>
  <lastName>Doe</lastName>
  <latitude>45.41685</latitude>
  <longitude>-71.6822</longitude>
  <name>John Doe</name>
  <phone>+44208269323</phone>
  <email>john.doe@emailservice.com</email>
  <province>...</province>
  <zip>WC2N 5DU</zip>
  <countryCode>UK</countryCode>
  <provinceCode>...</provinceCode>
  <stateCode>CA</stateCode>
  <stateName>California</stateName>
</address>