| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
?string | ➖ | Unique identifier for the address. | 123 |
type |
?Components\Type | ➖ | The type of address. | primary |
string |
?string | ➖ | The address string. Some APIs don't provide structured address data. | 25 Spring Street, Blackburn, VIC 3130 |
name |
?string | ➖ | The name of the address. | HQ US |
line1 |
?string | ➖ | Line 1 of the address e.g. number, street, suite, apt #, etc. | Main street |
line2 |
?string | ➖ | Line 2 of the address | apt # |
line3 |
?string | ➖ | Line 3 of the address | Suite # |
line4 |
?string | ➖ | Line 4 of the address | delivery instructions |
streetNumber |
?string | ➖ | Street number | 25 |
city |
?string | ➖ | Name of city. | San Francisco |
state |
?string | ➖ | Name of state | CA |
postalCode |
?string | ➖ | Zip code or equivalent. | 94104 |
country |
?string | ➖ | country code according to ISO 3166-1 alpha-2. | US |
latitude |
?string | ➖ | Latitude of the address | 40.759211 |
longitude |
?string | ➖ | Longitude of the address | -73.984638 |
county |
?string | ➖ | Address field that holds a sublocality, such as a county | Santa Clara |
contactName |
?string | ➖ | Name of the contact person at the address | Elon Musk |
salutation |
?string | ➖ | Salutation of the contact person at the address | Mr |
phoneNumber |
?string | ➖ | Phone number of the address | 111-111-1111 |
fax |
?string | ➖ | Fax number of the address | 122-111-1111 |
email |
?string | ➖ | Email address of the address | elon@musk.com |
website |
?string | ➖ | Website of the address | https://elonmusk.com |
notes |
?string | ➖ | Additional notes | Address notes or delivery instructions. |
rowVersion |
?string | ➖ | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 |