| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
(Optional) Internal 2Ship Id - Used to lookup a sender/recipient from 2ship address book |
string |
None. |
| PersonName |
(Optional) Mandatory if the CompanyName is not present |
string |
None. |
| CompanyName |
(Optional) Mandatory if the PersonName is not present |
string |
None. |
| Country |
(Mandatory) The country Code (ex: US, CA, GB etc) |
string |
None. |
| State |
(Mandatory) Country Province/State (for Canada(CA) - ON, AB... for United States(US) - NY... for other countries can use more letters!) |
string |
None. |
| City |
(Optional) mandatory for some carriers |
string |
None. |
| PostalCode |
(Mandatory) Postal/Zip |
string |
None. |
| Address1 |
(Optional) The Address line 1 |
string |
None. |
| Address2 |
(Optional) The Address line 2 |
string |
None. |
| Address3 |
(Optional) The Address line 3 |
string |
None. |
| Telephone |
(Optional) The Telephone |
string |
None. |
| TelephoneExtension |
(Optional) The Telephone Extension |
string |
None. |
|
(Optional) The Email |
string |
None. |
|
| IsResidential |
(Optional) if the address Is Residential |
boolean |
None. |
| TaxID |
(Optional) The tax id of the address |
string |
None. |
| RecipientType |
(Optional) The recipient Type |
string |
None. |
| AccountNo |
(Optional) Account # |
string |
None. |
| Latitude |
(Optional) Address Latitude |
decimal number |
None. |
| Longitude |
(Optional) Address Longitude |
decimal number |
None. |