SearchResultsDropLocation
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| locationId | string | ✅ | The location ID that corresponds to the UPS location. Do not expose the Location ID. |
| originOrDestination | string | ✅ | OriginOrDestination will returned for FreightWillCallRequestType 1 Postal based and 3 City and/or State based search. OriginOrDestination will be 01 for origin facilities and 02 for Destination facilities |
| ivr | DropLocationIvr | ✅ | Integrated Voice Response information. ONLY FOR IVR. |
| geocode | DropLocationGeocode | ✅ | Geocode is the latitude and longitude of the location address. The Geocode for the location address will be returned when Location is requested in the Request Option. |
| addressKeyFormat | DropLocationAddressKeyFormat | ✅ | Contains all of the basic information about a location, Consignee Name, Building Name, Address Lines, City, State/Province, Postal Code and Country or Terriotry Code. |
| phoneNumber | string[] | ✅ | The UPS locations Phone number. A phone number of the location will be returned. 10 digits allowed for US, otherwise 1..15 digits allowed. The phone number will be returned as a string. NOTE: For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1. |
| locationAttribute | DropLocationLocationAttribute[] | ✅ | OptionType is a container that indicates the type of the location attribute. There are 4 types of attributes. They are: Location, Retail Location, Additional Services and Program Type. NOTE: For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1. |
| distance | DropLocationDistance | ✅ | Container for the straight line distance from the origin to the UPS location. |
| timezone | string | ✅ | TimeZone. |
| faxNumber | string | ❌ | The UPS location's Fax number. A fax number of the location will be returned when available. 10 digits allowed for US, otherwise 1..15 digits allowed. The fax number will be returned as string. |
| eMailAddress | string | ❌ | Email address of the UPS location. Returned when available. |
| specialInstructions | DropLocationSpecialInstructions[] | ❌ | Walking directions. NOTE: For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1. |
| latestGroundDropOffTime | string[] | ❌ | The latest ground time the users can Drop-off the package at the location to be picked up. The time information is based on the time at the UPS location. When a user specifies a Drop-off Time and Ground as the Service Type, the locations that have latest Drop-off times equal to or later than the specified Drop-off time and service type are returned. NOTE: For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1. |
| latestAirDropOffTime | string[] | ❌ | The latest airtime the users can Drop-off the package at the location to be picked up. The time information is based on the time at the UPS location. When a user specifies a Drop-off Time and Air as the Service Type, the locations that have latest Drop-off times equal to or later than the specified Drop-off time and service type are returned. NOTE: For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1. |
| additionalChargeIndicator | string | ❌ | Presence or Absence Indicator. If present, Indicates if the UPS location would have an additional charge. ASO locations will require an additional charge. |
| standardHoursOfOperation | string | ❌ | The standard hours of operation of the drop location will be returned when available. The location's time may differ because of holidays. |
| nonStandardHoursOfOperation | string | ❌ | The non-standard hours of operation of the drop location. The location's time may differ because of holidays, weekends, or other factors that are beyond the locations control. Seven days preceding a given holiday the Non Standard Hours Of Operation will be returned along with the standard hours of operation if available. |
| willCallHoursOfOperation | string | ❌ | The will call hours of operation of the drop location will be returned when available. The location's time may differ because of holidays. |
| number | string | ❌ | The center number of the drop location if it is The UPS store. |
| homePageUrl | string | ❌ | The home page URL of the drop location if it is The UPS store. |
| comments | string | ❌ | Comments returned about the location. Text will be displayed in English or the locale given in the request. If Country Code is FR, and locale passed in the request is "fr_FR" then text will be displayed in French language, else comment will be displayed in English language. |
| additionalComments | DropLocationAdditionalComments | ❌ | Container for Additional Comments about Location.Text will be displayed in the Locale requested. |
| disclaimer | string[] | ❌ | Textual disclaimer about the drop location. NOTE: For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1. |
| slic | string | ❌ | SLIC. |
| facilityType | string | ❌ | PKG/FRT. |
| operatingHours | DropLocationOperatingHours | ❌ | Operating Hours. |
| localizedInstruction | DropLocationLocalizedInstruction[] | ❌ | LocalizedInstruction container. Applicable for SearchOptionCode 01, 02, 03. NOTE: For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1. |
| promotionInformation | DropLocationPromotionInformation[] | ❌ | Container to hold any promotion text for the location. Text will be displayed in English or the locale given in the request. NOTE: For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1. |
| sortCode | DropLocationSortCode | ❌ | This container is only for Freight Will call Search. |
| serviceOfferingList | DropLocationServiceOfferingList | ❌ | Container to hold the list of service offerings at the end point. |
| displayPhoneNumberIndicator | string | ❌ | Valid Values: 0-Do not display phone number 1-Display phone number. This indicator will be returned only for the contact type Telephone number. This indicator is used by the clients to determine whether to display the telephone number to the end user. |
| accessPointInformation | DropLocationAccessPointInformation | ❌ | Container for UPS Access Point specific parameters. |
| locationImage | DropLocationLocationImage | ❌ | Location Image container. |
| locationNewIndicator | string | ❌ | Indicator for new location. |
| promotionalLinkUrl | string | ❌ | Promotional link URL for specific location. |
| featuredRank | string | ❌ | Feature Ranking values: Null or blank - Location is not featured. 1 - Featured Location ranked number 1. 2 - Featured Location ranked number 2. |
| willCallLocationIndicator | string | ❌ | Will Call Location Indicator values: - Y – Signifies a Will Call location that serves the customers address. - N - Signifies it is not a Will Call location. Will Call locations are only returned with a "Y" indicator if the request included EnhancedSearchOption code 10. |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs