Skip to main content

LocatorRequest

N/A

Properties

NameTypeRequiredDescription
requestLocatorRequestRequest1N/A
originAddressLocatorRequestOriginAddressContainer for origin address information.
translateLocatorRequestTranslateContains the locale information for the request.
unitOfMeasurementLocatorRequestUnitOfMeasurementDistance unit of measurement. This is required for location requests (request option 1).
locationIdstring[]Location ID is the identification number of the UPS affiliated location.
locationSearchCriteriaLocatorRequestLocationSearchCriteriaThe 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).
sortCriteriaLocatorRequestSortCriteriaContainer for Sort Criteria
allowAllConfidenceLevelsstringIndicator to allow confidence level in search.
searchOptionCodestringValid 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.
serviceGeoUnitLocatorRequestServiceGeoUnitServiceGeoUnit Container. Required to search for the freight facility information
freightIndicatorstringFreightIndicator. Required for Freight Location Search.

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →