LocatorRequest
N/A
Properties
Name | Type | Required | Description |
---|---|---|---|
request | LocatorRequestRequest1 | ✅ | N/A |
originAddress | LocatorRequestOriginAddress | ✅ | Container for origin address information. |
translate | LocatorRequestTranslate | ✅ | Contains the locale information for the request. |
unitOfMeasurement | LocatorRequestUnitOfMeasurement | ❌ | Distance unit of measurement. This is required for location requests (request option 1). |
locationId | string[] | ❌ | Location ID is the identification number of the UPS affiliated location. |
locationSearchCriteria | LocatorRequestLocationSearchCriteria | ❌ | The Location search criteria container allows the user to further define the basis to which they wish to receive the UPS locations. Only relevant when the user requests a Location search (request option 1). |
sortCriteria | LocatorRequestSortCriteria | ❌ | Container for Sort Criteria |
allowAllConfidenceLevels | string | ❌ | Indicator to allow confidence level in search. |
searchOptionCode | string | ❌ | Valid values: 01-Proximity Search Details 02-Address Search Details 03-Proximity Search Summary 04-Address Search Summary 05-Freight Will Call Search. Either OptionType 03 or 04 is required. |
serviceGeoUnit | LocatorRequestServiceGeoUnit | ❌ | ServiceGeoUnit Container. Required to search for the freight facility information |
freightIndicator | string | ❌ | FreightIndicator. Required for Freight Location Search. |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs