Car API Migration Guide
Important! The VehLocationListLLSRQ and VehQuoteLocationListLLSRQ Car APIs are being sunset. Ensure to use the Geo Search API instead.
Introduction
This document describes the following Sabre Car APIs targeted for retirement, and the new APIs to use in their place:
Note: Host-native Sabre and Sabre Data Stream (SDS) formats for these APIs will not be impacted during the migration period, and will remain functional.
Below is the list of Car API functionality targeted for sunset and the respective alternative APIs that may be used after sunset.
Sunset API | New API | Functionality |
---|---|---|
VehLocationListLLSRQ | GeoSearch | API car rental vendor location information by specific airport or city code. |
VehQuoteLocationListLLSRQ | GeoSearch | API car rental vendor location information for a specific airport or city code. |
GeoSearch API Overview
Refer to the GeoSearch API page for more information.
The GeoSearch API is used to request information about car rental locations, hotel properties, and airports.
Required input parameters
Radius
UOM
(Unit of Measure)
Optional input parameters
Category
is optional by default, but must be set asCar
to enable Car functionality.MaxResults
limits the number of locations returned if there more locations in the radius than this number.
AddressRef element
One of the below AddressRef
attributes must be selected to determine the geo point to search by:
Country
Street
City
StateProv
PostalCode
CountryCode
GeoSearch Request XML Structure
<GeoRef Radius=" " UOM=" " MaxResults=" " OffSet=" " Category=" ">
<AddressRef Street=" " City=" " PostalCode=" " County=" " StateProv=" " CountryCode=" "/>
</GeoRef>
</GeoSearchRQ>
<GeoSearchRQ>
This field is the beginning the request for GeoSearch.
<GeoRef Radius=" " UOM=" " MaxResults=" " OffSet=" " Category=" ">
The GeoRef element and its attributes describe the number of miles or kilometers to search around the radius of the reference point, the maximum number of results returned, and the cateogry of information to return.
Radius=" "
- The Radius attribute is required.
- The radius value must be 1-3 numeric.
- The radius, in conjunction with Unit of Measure, determine the size of the search area to find the category of information.
UOM=" "
- The Unit of Measure attribute is required.
- The
UOM
must beMI
orKM
for miles or kilometers. - The radius, in conjunction with Unit of Measure, determine the size of the search area to find the category of information.
- When used in conjunction with GetVehAvail, this should be set to
MI
.
MaxResults=" "
- The Maximum Results attribute is optional, with a default value of
300
. - The maximum results value can be 1-3 numeric (a number from 1 to 300).
- This determines the maximum amount of responses if there are many in the search area. The locations returned will always be the closest locations.
OffSet=" "
- The OffSet is optional and is used for internal Sabre use only.
- Do not use the OffSet attribute.
Category=" "
- The Category attribute is mandatory.
Category
must beCAR
,HOTEL
, orAIR
.- The category determines the type of locations returned:
CAR
- car rental locationsHOTEL
- hotel property locationsAIR
- airports
When used in place of the VehLocationListLLSRQ or VehQuoteLocationList APIs, use CAR
.
<AddressRef Street=" " City=" " PostalCode=" " County=" " StateProv=" " CountryCode=" "/>
- The
AddressRef
element is optional, but is the most-used element when searching for car rental locations. - The
AddressRef
attributes are optional, except forCountryCode
. However, the more attributes used, the more accurate the location information returned.
Street=" "
- The
Street
attribute is optional. - The
Street
attribute value can be between 1-50 characters. - When used in conjunction with GetVehAvail, this attribute is strongly suggested.
City=" "
- The
City
attribute is optional. - The
City
attribute can be between 1-50 characters.
PostalCode=" "
- The
PostalCode
attribute is optional. - The
PostalCode
attribute can be between 1-50 characters, but is usually between 5-11 alpha-numeric.
County=" "
- The
County
attribute is optional. - The
County
attribute can be between 1-50 characters. - The
County
attribute is primarily used in countries that have the sameCity
name used repeatedly in the state or province.
StateProv=" "
- The State or Province attribute is optional.
- The
StateProv
attribute can be between 1-50 characters, but is usually the standard postal 2-3 character abbreviation for the state or province. For example, NY = New York state.
CountryCode=" "
- The
CountryCode
attribute is required. - The
CountryCode
attribute can be between 2-50 characters, but is usually the 2 character ISO standard international country code abbreviation. For example, US = United States.
</GeoRef>
This is the end of Geo Reference element.
</GeoSearchRQ>
This is the end of the Geo Search request.
Sample request:
<GeoRef Radius="10" UOM="MI" MaxResults="50" Category="CAR">
<AddressRef Street="3150 Sabre Drive" City="Southlake" PostalCode="76092" County=" " StateProv="TX" CountryCode="US"/>
</GeoRef>
</GeoSearchRQ>
GeoSearch XML Response Structure
Note: This section includes just one location, but in an actual call to the API, this response will repeat multiple times until the MaxLocation
number is reached, or the maximum Radius
number is reached.
<GeoSearchRS>
This field is the beginning of the GeoSearch response message.
<ApplicationResults status="Complete">
The ApplicationResults
status attribute must be Complete
.
<GeoSearchResults Radius="10.0" UOM="MI" Category="CAR" Latitude="32.982263" Longitude="-97.161872" MaxSearchResults="12" OffSet="1">
The Latitude
and Longitude
are derived from the AddressRef
parameters entered into the request.
<GeoSearchResult Distance="5.39" Direction="SW" Latitude="32.934204" Longitude="-97.235146">
This latitude and longitude are from the response rental location address.
The rest of the data is very similar to what is returned with the current car APIs that are being sunset.
Sample response:
<ApplicationResults status="Complete"">
<Success timeStamp="2019-01-16T15:54:26.364-06:00"/>
<ApplicationResults>
<GeoSearchResults Radius="10.0" UOM="MI" Category="CAR" Latitude="32.982263"
Longitude="-97.161872" MaxSearchResults="12" OffSet="1">
<GeoSearchResult Distance="5.39" Direction="SW" Latitude="32.934204"
Longitude="-97.235146">
<Name>DFWW055 KELLER</Name>
<Id>ETDFWW055</Id>
<Street>830 KELLER PKWY</Street>
<Zip>76248-2400</Zip>
<City>KELLER</City>
<State>TX</State>
<Country>US</Country>
<ConfidenceFactor>1</ConfidenceFactor>
<Attribute Name="vendor" Value="ET"/>
<GeoSearchResult>
<GeoSearchResults>
<GeoSearchRS>
RPH Element Sunset
Overview
Important! If the RPH field is not used by your application, then there is no need to read the rest of this document.
This section of the migration guide describes secondary Sabre Car APIs that are planned to be sunset.
The RPH
element contains the line number of the individual car rate item where more information is being requested, or is used to make a booking/reservation for a specific car and rate.
A Car secondary API contains the use of the RPH element in the following APIs:
- OTA_VehAvailRateLLSRQ – Car availability airport or single specific car supplier location information
- VehLocationFinderLLSRQ – Car availability geo/local/non-airport information
- OTA_VehResLLSRQ – Car booking/reservation/sell functions
- OTA_VehLocDetailLLSRQ – Car rental location policy
- VehRateRulesLLSRQ – Car availability, specific car rates, and rule details
Note: If the RPH field appears in any of the service requests shown above, it is likely that a code change will be required.
Updates to Support RPH Sunset
API Name | Update Needed | Sunset XML |
---|---|---|
Car Shop API - OTA_VehAvailRateLLSRQ | Update – Remove support of the RPH element | <VehAvailRQCore queryType="Quote" RPH="1"> |
Car Location Shop – VehLocationFinderLLSRQ | Update – Remove support of the RPH element | <VehLocationFinder queryType="Quote" RPH="1"> |
Car Sell - OTA_VehResRQLLSRQ | Update – Remove support of the RPH element | <VehRentalcore InsertAfter=”0” PickUpDateTime=”12-12T10:10” Quantity=”1” ReturndateTime=”12-23T10:10 RPH="1"> |
The use of secondary/reference APIs will continue to be allowed via Host Sabre commands and for Sabre Data Stream (SDS) requests. The RPH
element is only used after an original Availability
request has been made.
Car Secondary/Reference API Alternatives
In place of the RPH
element, it will now be necessary to populate the specific API needed with all the details from the specific car rate to acquire additional information.
OTA_VehResLLSRQ – Car Booking/Reservation/Sell
- Car Supplier
- Pick up Date / Time
- Return Date / Time
- Cartype
- Pickup City / Extended Location Code (if not Airport)
- Return (DropOff) City (if not same as Pickup City) / Extended Location Code (if not Airport)
- RateCode
- There may be additional optional qualifiers if they were entered in the original request, such as Car Extras, Loyalty Numbers, and Discount Numbers.
VehRateRulesLLSRQ – Car Availability Specific Car Rate and Rule Details
- Car Supplier
- Pick up Date / Time
- Return Date / Time
- Cartype
- Pickup City / Extended Location Code (if not Airport)
- Return (DropOff) City (if not same as Pickup City) / Extended Location Code (if not Airport)
- RateCode
- There may be additional optional qualifiers if they were entered in the original request, such as Car Extras, Loyalty Numbers, and Discount Numbers.
OTA_VehLocDetailLLSRQ – Car Rental Location Policy
- Car Supplier
- Pickup City / Extended Location Code (if not Airport)
- Pick up Date – optional
- Return Date – optional
Information to support the usage of the above Car APIs can be viewed at: