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).
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| searchOption | LocationSearchCriteriaSearchOption[] | ❌ | |
| maximumListSize | string | ❌ | If present, indicates the maximum number of locations the client wishes to receive in response; ranges from 1 to 50 with a default value of 5. |
| searchRadius | string | ❌ | Defines the maximum radius the user wishes to search for a UPS location. If the user does not specify, the default value is 100 miles. Whole numbers only. Valid values are: 5-100 for UnitOfMeasure MI 5-150 for UnitOfMesaure KM |
| serviceSearch | LocationSearchCriteriaServiceSearch | ❌ | Allows for users to further define the search criteria. Refer to the rules specified in Service Search section. |
| freightWillCallSearch | LocationSearchCriteriaFreightWillCallSearch | ❌ | Freight Will Call Search Container. Required if SearchOption is '05-Freight Will Call Search' |
| accessPointSearch | LocationSearchCriteriaAccessPointSearch | ❌ | Applicable for request option 64 only. This contains inclusion and exclusion criteria for address search. It also contains Account Number and Access Point Public ID search elements. |
| openTimeCriteria | LocationSearchCriteriaOpenTimeCriteria | ❌ | Container to hold open times of the Location. |
| brexitFilter | string | ❌ | Brexit Filter. Applicable for country code GB; Pass the PostalCode for the address in the location search if Brexit functionality is desired. UAPs with postal code starts with BT returned when brexit filter starts with BT, else UAPs returned with non BT postal code. Applicable for UAP and Proximal building search. |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs