Address

Address, used for physical deliveries and contact details.

Fields

FieldDescription
id
int 
(required)

Address ID

Note: Only available when used for a contact address.

Example value:123423
typeid
int 
(required)

Address type ID

Note: Only available when used for a contact address.

Example value:3
addressee
string 
(required)

Addressee

Note: Only available when used as an order deliver address.

Example value:"Mr. John Doe"
city
string 
(required)

City

Example value:"Leuven"
country
string 
(required)

Country name (based on typeid, returned as a convenience).

Note: Only available when used for a contact address.

Example value:"Belgium"
countrycode
string 
(required)

ISO 3166-1 alpha-2 country code

Example value:"BE"
customerid
int 
(required)

Contact this address belongs to

Note: Only available when used for a contact address.

Example value:32541
state
string 
(required)

State

Example value:"CA"
street1
string 
(required)

Street field 1 (typically the street name)

Example value:"Gaston Geenslaan"
street2
string 
(required)

Street field 2 (typically the number)

Example value:"11"
street3
string 
(required)

Street field 3 (sometimes used for box numbers or suffixes)

Example value:"B"
type
string 
(required)

Address type (based on typeid, returned as a convenience).

Note: Only available when used for a contact address.

Example value:"Home"
zip
string 
(required)

Zip code

Example value:"AA3000"

Example

 1{
 2    "id": 123423,
 3    "typeid": 3,
 4    "addressee": "Mr. John Doe",
 5    "city": "Leuven",
 6    "country": "Belgium",
 7    "countrycode": "BE",
 8    "customerid": 32541,
 9    "state": "CA",
10    "street1": "Gaston Geenslaan",
11    "street2": "11",
12    "street3": "B",
13    "type": "Home",
14    "zip": "AA3000"
15}