Contains all of the basic information about the origin such as: Address Lines, City, State/Province, Postal Code and Country or Territory Code. The element CountryCode is required.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| address_line | str | ✅ | Address Line Information. The user may submit street level address information or provide Intersection information. |
| political_division2 | str | ✅ | City or Town. |
| political_division1 | str | ✅ | State or province |
| postcode_primary_low | str | ✅ | Main postal code. Required if the user does not submit the City, State/Province address combination. |
| country_code | str | ✅ | Two-character country or territory abbreviation |
| consignee_name | str | ❌ | Name. Not relevant for this tool |
| address_line2 | str | ❌ | Additional Address Line Information. |
| address_line3 | str | ❌ | Additional Address Line Information. |
| political_division3 | str | ❌ | Barrio or other sub-division of City |
| postcode_extended_low | str | ❌ | 4 Digit postal code extension. Valid for US only. |
| single_line_address | str | ❌ | Single line search information. Can contain values of origin address in a single line. Will override other origin address information. Conditionally Required for Non-Postal Code Countries. Applicable Country Ireland (IE) SingleLineAddress used for the lookup SingleLineAddress (Format - CSV) ("Values:" + postalCode + city + state + address + landmark + phoneNumber) |