Addresses
Address objects convey physical location information are most commonly attached to orders (as the 'ship_to' and the 'sold_to'). No operations may be performed directly on addresses. This documentation only defines the address object properties and requirements.
Properties
| Name | Description |
|---|---|
|
name1 string (64) |
Name (Line 1) |
|
name2 string (64) optional |
Name (Line 2). |
|
street1 string (128) |
Street Address (Line 1) |
|
street2 string (128) optional |
Street Address (Line 2) |
|
city string (64) |
Name of city or town. |
|
province string (2) |
The two-character province code. At this time, only US state codes/abbreviations are officially supported. |
|
postal_code string (16) |
The postal code of the address. Most often, this will be the 5 character version (in the US), but the field can support more specific codes if necessary. |
|
country string (2) |
The two-character country code (ISO 3166-1 alpha-2). At this time, only 'US' is officially supported. |
|
phone1 string (32) optional |
Primary phone number. |
|
phone2 string (32) optional |
Additional phone number. |
|
fax string (64) optional |
Fax line number. Wait...is this still a thing? |
|
string (128) optional |
Primary email address of addressee. |
Examples
"ship_to": {
"type": "residential"",
"name1": "Manchester",
"name2": null,
"street1": "1522 Manchester Rd",
"street2": null,
"city": "West Carrollton",
"province": "OH",
"postal_code": "45458",
"country": "US",
"phone1": null,
"phone2": null,
"fax": null,
"email": null
}