OriginAddressAddressKeyFormat
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 |
|---|---|---|---|
| addressLine | string | ✅ | Address Line Information. The user may submit street level address information or provide Intersection information. |
| politicalDivision2 | string | ✅ | City or Town. |
| politicalDivision1 | string | ✅ | State or province |
| postcodePrimaryLow | string | ✅ | Main postal code. Required if the user does not submit the City, State/Province address combination. |
| countryCode | string | ✅ | Two-character country or territory abbreviation |
| consigneeName | string | ❌ | Name. Not relevant for this tool |
| addressLine2 | string | ❌ | Additional Address Line Information. |
| addressLine3 | string | ❌ | Additional Address Line Information. |
| politicalDivision3 | string | ❌ | Barrio or other sub-division of City |
| postcodeExtendedLow | string | ❌ | 4 Digit postal code extension. Valid for US only. |
| singleLineAddress | string | ❌ | 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) |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs