Car Availability Elements

 

This section contains Car Availability API schema by Quote and Shop request, and descriptions for all elements, attributes, and child elements found within the API.

Use Ctrl+F to locate specific elements or attributes. All code is pre-formatted, and may be copied and pasted directly into an API testing tool. Code headers/identifiers are displayed using XPath format.

API Information

Target Audience
All Sabre APIs Customers
Current Version
2.4.2
Authentication
Session Token
Service Action Code
OTA_VehAvailRateLLSRQ

Design Documentation

View in an XML format below:

Quick Navigation

Browse documentation on this page:

Request Header

<OTA_VehAvailRateRQ xmlns="http://webservices.sabre.com/sabreXML/2011/10" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="2.4.1" ReturnHostCommand="true">

Request Sample

Quote

<OTA_VehAvailRateRQ Version="2.4.2" xmlns="http://webservices.sabre.com/sabreXML/2011/10" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <VehAvailRQCore QueryType="Quote">
        <RateQualifier CurrencyCode="USD" Commission="true" RateAssured="true" RateCategory="G" RatePlan="D">
            <CustLoyalty ProgramID="xx" MembershipId="ABC123"/>
            <RateCode>ABC123</RateCode>
            <Corporate><ID>ABC123<ID></Corporate>
            <TourCode><Text>ABC123</Text></TourCode>
            <Promotion><Code>ABC123</Code></Promotion>
            <ID><Number>ABC123</Number></ID>
            <GuaranteePrepaid ReturnPrepaidRates="true" ReturnGuaranteeRates="true" ReturnRegularRates="true"/>
            <VehPrefs>
                <VehPref>
                    <VehType>SCAR</VehType>
                    <VehType>LCAR</VehType>
                    <VehType>ICAR</VehType>
                    <VehType>MCAR</VehType>
                    <VehType>PCAR</VehType>
                    <VehType>CCAR</VehType>
                    <VehType>SPAR</VehType>
                    <VehType>FRAR</VehType>
                    <VehType>STAR</VehType>
                    <VehType>FFAR</VehType>
                </VehPref>
            </VehPrefs>
        </RateQualifier>
        <SpecialEquipPrefs>
            <SpecialEquipPref EquipType="CST"/>
            <SpecialEquipPref EquipType="NAV"/>
        </SpecialEquipPrefs>
    <VehRentalCore PickUpDateTime="03-01T10:00" ReturnDateTime="03-07T17:00">
            <PickUpLocation LocationCode="DFWN002"/>
            <ReturnLocation LocationCode="DFWC001"/>
    </VehRentalCore>
    <VendorPrefs>
        <VendorPref Code="XX"/>
    </VendorPrefs>
    </VehAvailRQCore>
</OTA_VehAvailRateRQ>

 

Shop

<OTA_VehAvailRateRQ Version="2.4.2" xmlns="http://webservices.sabre.com/sabreXML/2011/10" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <VehAvailRQCore QueryType="Shop">
        <RateQualifier CurrencyCode="USD" Commission="true" RateAssured="true" RateCategory="G" RatePlan="D">
            <RateCode>ABC123</RateCode>
            <Corporate><ID>ABC123<ID></Corporate>
            <TourCode><Text>ABC123</Text></TourCode>
            <Promotion><Code>ABC123</Code></Promotion>
            <ID><Number>ABC123</Number></ID>
            <GuaranteePrepaid ReturnPrepaidRates="true" ReturnGuaranteeRates="true" ReturnRegularRates="true"/>
            <VehPrefs>
                <VehPref>
                    <VehType>SCAR</VehType>
                    <VehType>LCAR</VehType>
                    <VehType>ICAR</VehType>
                    <VehType>MCAR</VehType>
                    <VehType>PCAR</VehType>
                    <VehType>CCAR</VehType>
                    <VehType>SPAR</VehType>
                    <VehType>FRAR</VehType>
                    <VehType>STAR</VehType>
                    <VehType>FFAR</VehType>
                </VehPref>
            </VehPrefs>
        </RateQualifier>
        <SpecialEquipPrefs>
            <SpecialEquipPref EquipType="CST"/>
            <SpecialEquipPref EquipType="NAV"/>
        </SpecialEquipPrefs>
    <VehRentalCore PickUpDateTime="03-01T10:00" ReturnDateTime="03-07T17:00">
            <PickUpLocation LocationCode="DFW"/>
            <ReturnLocation LocationCode="MIA"/>
    </VehRentalCore>
    <VendorPrefs>
        <VendorPrefs Exclude="true"/>
        <VendorPref Code="XX"/>
        <VendorPref Code="YY"/>
        <VendorPref Code="ZZ"/>
        <VendorPref Code="AA"/>
        <VendorPref Code="BB"/>
        <VendorPref Code="CC"/>
        <VendorPref Code="DD"/>
        <VendorPref Code="EE"/>
        <VendorPref Code="FF"/>
    </VendorPrefs>
    </VehAvailRQCore>
</OTA_VehAvailRateRQ>

 

Request Elements

/OTA_VehAvailRateRQ/VehAvailRQCore/@Query Type

This element determines the type of car availability request being made. There are two types of requests:

Car Quote

Enter "Quote" into this element to request a single car supplier for one location.

<VehAvailRQCore queryType="Quote">

Car Shop

Enter "Shop" into this element to request a list of one or all car suppliers at a given airport. For example, you can search for a single supplier at JFK, or all suppliers for JFK.

<VehAvailRQCore queryType="Shop">

/OTA_VehAvailRateRQ/VehAvailRQCore/RateQualifier

The Rate Qualifier element contains attributes and child elements. If there are no rate qualifiers, there is no need to enter values.

Attributes

The RateQualifier attributes should be combined into one string if used in the request:

<RateQualifier CurrencyCode="USD" Commission="true"  RateAssured="true" RateCategory="G" RatePlan="D">

Note: These attributes are omitted if false or are not used in the request.

Name
Description

@CC_Rate

No longer used in requests. If a value is entered, it will be ignored in the response.

@CurrencyCode

The 3 letter ISO 4217 currency code. This attribute is optional for requests.

@Commission

Used to request only the suppliers that return comission information. If this field is omitted, the response will contain information from both car suppliers that return commission information, and those that do not.

Note: Suppliers may choose not to share commission information; if a supplier does not return displayable information, they may still provide commissions. Refer to the supplier for further information regarding commissions in the event the showing of commissions is suppressed.

To request this, enter "true":

<RateQualifier Commission="true">

@MileagePlan

No longer used in requests. If a value is entered, an error message will display.

@RateAssured

Used to request only suppliers that return the best publicly available rates currently offered. If this field is omitted, the response will contain responses from both suppliers that return Rate Assured information, and those that do not.

Note: Suppliers may choose not to share the rate assured indicator. Refer to the supplier for further information regarding rate assured information.

To request this, enter "true":

<RateQualifier RateAssured="true">

@RateCategory

Used to request types of rate. For example, if requesting a government rate, enter "G". Can be:

"S", "P", "G", "A", "I", "C", "U", "B", "V", "R", "K", "L", "N"

Note: Most category rates now use more detailed identifers that are used in the <RateQualifier> children fields. As a best practice, use the children fields to narrow down the request.

To request this, enter one of the category codes listed above:

<RateQualifier RateCatagory=”G”>

@RatePlan

Used to request the length of rental rates. Can be:

"D" (daily), "E" (weekend), "W" (weekly), and "M" (monthly)

Notes:

  • Most plans are determined by the length of the car rental in days and hours, and outline the difference between the pickup date/time and the return date/time. Because of this, this field tends to rarely be used.
  • If using this attribute, it will force a 5 day long rental to be returned as a "D" (daily) plan instead of defaulting to a "W" (weekly) plan that a car supplier would normally return. This is for business travelers that are not sure how long they will rent the car.

To request this, enter one of the category codes listed above:

<RateQualifier RateCatagory=”D”>

Children

The RateQualifier children are more complex qualifiers of the RateQualifier element:

Note: These items are only entered if the requestor knows this information. Otherwise, leave these fields blank.

Name
Description

//CustLoyalty/@ProgramId

//CustLoyalty/@MembershipId

Important! This is a "Quote" request item only. If used in a "Shop" request, it will be rejected.

Used by a car supplier to provide points that count towards a car rental.

To request this, enter the 2-character airline code first, followed by the 1-25 alpha-numeric loyalty number:

<RateQualifier>
    <CustLoyaltyProgramID="xx" MembershipId="ABC123"/>
</RateQualifier>

//RateCode

A car supplier-specific 2-6 alpha numeric code that is tied to the available rate.

Note: This data may be repeated for each car supplier, with a limit of 50.

To request this in a Quote request, enter the applicable rate code:

<RateQualifier>
    <RateCode>ABC123</RateCode>
</RateQualifier>

To request this in a Shop request, enter the 2 letter alpha-numeric car supplier code with the rate code:

<RateQualifier>
    <RateCode>XXABC123</RateCode>
    <RateCode>YYDEF456</RateCode>
    <RateCode>ZZGHI789</RateCode>
    <RateCode>BBABC123</RateCode>
</RateQualifier>

//Corporate/ID

A car supplier-specific 1-25 alpha numeric code that is used to identify the customer (usually a company) to the car supplier for a corporate discount.

To request this in a Quote request, enter the applicable corporate discount number:

<RateQualifier>
    <Corporate><ID>ABC123</ID></Corporate>
</RateQualifier>

To request this in a Shop request, enter the 2 letter alpha-numeric car supplier code with the corporate discount number:

<RateQualifier>
    <Corporate><ID>XXABC123</ID></Corporate>
    <Corporate><ID>YYDEF456</ID></Corporate>
    <Corporate><ID>ZZGHI789</ID></Corporate>
    <Corporate><ID>BBJKL098</ID></Corporate>
</RateQualifier>

Note: This data may be repeated for each car supplier, with a limit of 50.

//TourCode/Text

A car supplier-specific 1-25 alpha numeric code used to identify the customer to the car supplier for a tour discount.

To request this in a Quote request, enter the applicable tour number:

<RateQualifier>
    <TourCode><Text>ABC123</Text></TourCode>
</RateQualifier>

To request this in a Shop request, enter the 2 letter alpha-numeric car supplier code and tour code:

<RateQualifier>
    <TourCode><Text>XXABC123</Text></TourCode>
    <TourCode><Text>YYDEF456</Text></TourCode>
    <TourCode><Text>ZZGHI789</Text></TourCode>
    <TourCode><Text>BBJKL098</Text></TourCode>
</RateQualifier>

Note: This data may be repeated for each car supplier, with a limit of 50.

//Promotion/Code

A car supplier-specific 1-10 alpha numeric code that is used to identify a promotional coupon the customer may use.

To request this in a Quote request, enter the promotional coupon number:

<RateQualifier>
    <Promotion><Code>ABC123</Code></Promotion>
</RateQualifier>

To request this in a Shop request, enter the car supplier code and promotional coupon number:

<RateQualifier>
    <Promotion><Code>XXABC123</Code></Promotion>
    <Promotion><Code>YYDEF456</Code></Promotion>
    <Promotion><Code>ZZGHI789</Code></Promotion>
    <Promotion><Code>BBJKL098</Code></Promotion>
</RateQualifier>

Note: This data may be repeated for each car supplier, with a limit of 50.

//ID/Number

A car supplier-specific 1-25 alpha numeric code that is used to identify the customer to the car supplier. This is usually the loyalty number of the car supplier, and is similar to a frequent flyer number in the airline industry.

To request this in a Quote request, enter the applicable identity number:

<RateQualifier>
    <ID><Number>ABC123</Number></ID>
</RateQualifier>

To request this in a Shop request, enter the car supplier code and applicable identity number:

<RateQualifier>
    <ID><Number>XXABC123</Number></ID>
    <ID><Number>YYDEF456</Number></ID>
    <ID><Number>ZZGHI789</Number></ID>
    <ID><Number>BBJKL098</Number></ID>
</RateQualifier>

Note: This data may be repeated for each car supplier, with a limit of 50.

//GuaranteePrepaid

Guarantee Prepaid is used when requesting a relatively new type of rate from car suppliers. These rates provide detailed information of refundable amounts during payment at the time of booking.

The following fields are optional, and return Enhanced Guarantee Required or Prepay rates from participating car suppliers. If no values are entered into the request, all types of rates will be returned, with regular retail rates being the most common:

//GuaranteePrepaid/@ReturnPrepaidRates

//GuaranteePrepaid/@ReturnGuaranteeRates

//GuaranteePrepaid/@ReturnRegularRates

<GuaranteePrepaid ReturnPrepaidRates=" "/>
<GuaranteePrepaid ReturnGuaranteeRates=" "/>
<GuaranteePrepaid ReturnRegularRates=" "/>

To request this, enter "true" into the Prepaid and/or Guarantee fields:

<RateQualifier>
    <GuaranteePrepaid ReturnPrepaidRates=”true” />
</RateQualifier>

 

<RateQualifier>
    <GuaranteePrepaid ReturnGuaranteeRates=”true” />
</RateQualifier>

 

<RateQualifier>
    <GuaranteePrepaid ReturnRegularRates=”true” />
</RateQualifier>

These may be combined into one request:

<RateQualifier>
    <GuaranteePrepaid ReturnPrepaidRates=”true” ReturnGuaranteeRates=”true” ReturnRegularRates=”true”>
</RateQualifier>

//VehPrefs/VehPref/VehType

Vehicle Preferences are used to specify the type of car(s) to include in the search. For a list of all Vehicle Preferences codes, refer to the Matrices page.

Notes:

  • Up to 10 car types may be entered in the request.
  • If no values are entered, the value is defaulted to "ACAR" for All Cartypes. "ACAR" varies by suppliers, but generally includes all 2-4 door cars including minivans and SUVs.
  • Suppliers may choose not to have the ACAR value return all vehicles available for that specific supplier.

To request this, enter the applicable vehicle types:

<RateQualifier>
    <VehPrefs>
        <VehPref>
            <VehType>SCAR</VehType>
            <VehType>LCAR</VehType>
        </VehPref>
    </VehPrefs>
</RateQualifier>

All attributes and children of the RateQualifier element should be combined as follows:

<RateQualifier  Commission="true"  RateAssured="true" RateCategory="G" RatePlan="D">
    <CustLoyalty ProgramID=”xx” MembershipId=”ABC123”
    <RateCode>ABC123</RateCode>
    <Corporate><ID>ABC123</ID></Corporate>
    <TourCode><Text>ABC123</Text></TourCode>
    <Promotion><Code>ABC123</Code></Promotion>
    <ID><Number>ABC123</Number></ID>
    <GuaranteePrepaid ReturnPrepaidRates=”true” ReturnGuaranteeRates=”true” ReturnRegularRates=”true"/>
        <VehPrefs>
            <VehPref>
                <VehType>SCAR</VehType>
                <VehType>LCAR</VehType>
            </VehPref>
        </VehPrefs>
</RateQualifier>

//SpecialEquipPrefs/SpecialEquipPref/@EquipType

Used to request special equipment such as child seats, bicycle racks, and more. Refer to the Matrices page for a list of all values to enter into this field.

To request this, enter the appropriate equipment type:

<SpecialEquipPrefs>
    <SpecialEquipPref EquipType="CST"/>
    <SpecialEquipPref EquipType="NAV">
</SpecialEquipPrefs>

/OTA_VehAvailRateRQ/VehRentalCore

The Vehicle Rental Core element contains attributes and child elements. If child elements are used, this element must end with </VehRentalCore>.

Attributes

Name
Description

@PickUpDateTime

Required

The car pickup date and time in "month-dayTtime" format.

@ReturnDateTime

Required

The car return date and time in "month-dayTtime" format.

To request a car pickup and return date, enter the dates for both in month-dayTtime format:

<VehRentalCore PickUpDateTime="03-010T10:00" ReturnDateTime="03-07T17:00">

Children

VehRentalCore children elements contain pickup city code information (mandatory), and return/drop off city codes (optional). Return/drop off city information is only entered if different than the pickup city code information.

Name
Description

//PickUpLocation/@LocationCode

Required

Used to designate the car pickup location by airport code or non-airport code.

Airport Code

A 3 letter alpha-numeric code designates that the pickup location is within an airport.

<PickUpLocation LocationCode="DFW"/>

Note: Only airport locations are allowed for Shop requests. Non-airport codes will be rejected.

Non-Airport Code

A non-airport code designates that the pickup location is outside of an airport. This is shown as a 3 letter alpha-numeric value, followed by an additional alpha and 1-3 numerics. The additional alpha designates the non-airport type by direction or specific code. These values can be:

  • "N": North
  • "S": South
  • "E": East
  • "W": West
  • "R": Resort
  • "X": Rail
  • "P": Port
  • "C": City
<PickUpLocation LocationCode="DFWC001"/>

//ReturnLocation/@LocationCode

Used to designate the car return location by airport code or non-airport code. This field is optional.

Important! This field should only be used if different than <PickUpLocation LocationCode=" "> above.

Airport Code

A 3 letter alpha-numeric code designates that the return location is within an airport.

<ReturnLocation LocationCode="DFW"/>
Non-Airport Code

A non-airport code designates that the return location is outside of an airport. This is shown as a 3 letter alpha-numeric value, followed by an additional alpha and 1-3 numerics. The additional alpha designates the non-airport type by direction or specific code. These values can be:

  • "N": North
  • "S": South
  • "E": East
  • "W": West
  • "R": Resort
  • "X": Rail
  • "P": Port
  • "C": City
<ReturnLocation LocationCode="DFWC001"/>

The Vehicle Rental Core attributes and children should be combined in the request as follows:

When pickup and return values are the same, enter:

<VehRentalCore PickUpDateTime="03-010T10:00" ReturnDateTime="03-07T17:00">
    <PickUpLocation LocationCode="DFW"/>
</VehRentalCore>

When pickup and return are different (one-way), enter:

VehRentalCore PickUpDateTime="03-010T10:00" ReturnDateTime="03-07T17:00">
    <PickUpLocation LocationCode="DFWN002/>
    <ReturnLocation LocationCode="DFWC001"/>
</VehRentalCore>

/OTA_VehAvailRateRQ/VendorPrefs

The Vendor Preference element is used to request a specific car supplier, and only contains one attribute.

Shop Requests

If no car suppliers are entered in Shop requests, then all car suppliers for that location will be included in the request. This data may be repeated for each car supplier, with a limit of 50.

Certain car suppliers may be excluded from the Shop request as well. This is done by setting <VendorPrefs Exclude> to "true". Only the suppliers that are not on the list and exist at the requested location will be shown.

/OTA_VehAvailRateRQ/VendorPrefs/VendorPref/@Code

The Vendor Preference Code is a required 2 letter alpha-numeric value for Quote requests. This is optional for Shop requests if no specific car supplier is requested.

To request specific car suppliers in a Quote request, enter the valid car supplier code:

<VendorPrefs>
    <VendorPref Code="XX"/>
</VendorPrefs>

To request specific car suppliers in a Shop request, enter the valid car supplier code(s):

<VendorPrefs>
    <VendorPref Code="XX"/>
    <VendorPref Code="YY"/>
    <VendorPref Code="ZZ"/>
    <VendorPref Code="AA"/>
    <VendorPref Code="BB"/>
</VendorPrefs>

To exclude car suppliers in the request, set <VendorPrefs Exclude=" "> to "true" and enter the valid car supplier code(s) after:

<VendorPrefs>
    <VendorPrefs Exclude="true"/>
    <VendorPref Code="XX"/>
    <VendorPref Code="YY"/>
    <VendorPref Code="ZZ"/>
    <VendorPref Code="AA"/>
    <VendorPref Code="BB"/>
</VendorPrefs>

Response Sample

Quote

<VehAvailRSCore>
    <HeaderInfo>
        <Text>*RATES RETURNED VIA DIRECT CONNECT</Text>
        <Text>R C USD RATE/PLAN    MI      CHG           APPROX</Text>
        <Text>ALL TOTAL PRICES ARE RETURNED DIRECT CONNECT FROM CAR ASSOCIATE</Text>
        <Text>* BEST PUBLICLY AVAILABLE RATE</Text>
        <Text>C  COMMISSION  FX FIXED     05 PERCENTAGE    BLANK-COMM UNKNOWN</Text>
        <Text>R RATE AND/OR VEHICLE ON REQUEST         ‡ CURRENCY CONVERTED</Text>
        <Text>- AMOUNT TOO LARGE                       C CONTRACT RATE</Text>
        <Text>L INCLUSIVE RATE</Text>
        <Text>G GUARANTEE  REQUIRED - CREDIT CARD MANDATORY AT TIME OF SELL</Text>
        <Text>P PREPAYMENT REQUIRED - CREDIT CARD MANDATORY AT TIME OF SELL</Text>
        <Text>PLAN  D-DAILY  E-WEEKEND  W-WEEKLY  M-MONTHLY  B-BUNDLED</Text>
        <Text>CQ*R LINE  RATE DETAILS AND RULES</Text>
        <Text>CQ*P       LOCATION INFO IE.MAKES,EQUIPMENT,PAYMENT AND MORE</Text>
        <Text>CQ*X       EXTRA DAY AND HOUR RATES</Text>
        <Text>0C LINE    SELL CAR</Text>
        <Text>CAR SUPPLIER TEXT LINE 1 UP TO 63</Text>
        <Text>CAR SUPPLIER TEXT LINE2 UP TO 63</Text>
        <Text>CAR SUPPLIER TEXT LINE 3 UP TO 63</Text>
    </HeaderInfo>
    <VehRentalCore NumDays="11" NumHours="0" PickUpDateTime="08-04T12:00" ReturnDateTime="08-15T12:00">
        <DropOffLocationDetails LocationCode="MIA"/>
        <LocationDetails CounterLocation="A" LocationCode="MIA" LocationName="MIAMI" LocationOwner="C">
            <OperationSchedule>
                <OperationTimes>
                    <OperationTime End="23:59" Start="00:00"/>
                </OperationTimes>
            </OperationSchedule>
        </LocationDetails>
    </VehRentalCore>
    <VehVendorAvails>
        <VehVendorAvail RPH="1">
            <VehAvailCore>
                <GuaranteePrepaid Amount="570.56" AmountPercentage="M" CurrencyCode="USD" Ind="P">
                    <CancellationRefundAmount NumDays="0">570.56</CancellationRefundAmount>
                    <CancellationRefundAmount NumDays="1">100.00</CancellationRefundAmount>
                    <CancellationRefundAmount NumDays="331">50.00</CancellationRefundAmount>
                </GuaranteePrepaid>
                <PricedEquip>
                    <SpecialEquipment Code="CST" Status="CNF">
                        <Rate BaseAmount="0.00" Plan="B"/>
                    </SpecialEquipment>
                    <SpecialEquipment Code="NAV" Status="CNF">
                        <Rate BaseAmount="62.91" Plan="B"/>
                    </SpecialEquipment>
                    <SpecialEquipment Code="BST" Status="CNF">
                        <Rate BaseAmount="98.00" Plan="B"/>
                    </SpecialEquipment>
                    <SpecialEquipment Code="CST" Status="CNF">
                        <Rate BaseAmount="98.00" Plan="B"/>
                    </SpecialEquipment>
                </PricedEquip>
                <RentalRate AvailabilityStatus="S" RateCode="ABC123" STM_RatePlan="W">
                    <Vehicle>
                        <VehType>ECAR</VehType>
                    </Vehicle>
                </RentalRate>
                <VehicleCharges>
                    <VehicleCharge Amount="238.41" CurrencyCode="USD" GuaranteeInd="G" PrepayDeposit="P">
                        <AdditionalDayHour>
                            <Day CurrencyCode="USD" MileageAllowance="UNL" Rate="34.09"/>
                            <Hour CurrencyCode="USD" MileageAllowance="UNL" Rate="17.05"/>
                        </AdditionalDayHour>
                        <Mileage Allowance="UNL" CurrencyCode="USD" ExtraMileageCharge=".00" UnitOfMeasure="MI"/>
                        <SpecialEquipTotalCharge Amount="258.91" CurrencyCode="USD"/>
                        <TotalCharge Amount="847.58" CurrencyCode="USD"/>
                    </VehicleCharge>
                </VehicleCharges>
            </VehAvailCore>
            <Vendor Code="XX" CompanyShortName="TEST RENT" ParticipationLevel="B"/>
        </VehVendorAvail>
        <VehVendorAvail RPH="2">
            <VehAvailCore>
                <GuaranteePrepaid Amount="570.56" AmountPercentage="M" CurrencyCode="USD" Ind="P">
                    <CancellationRefundAmount NumDays="0">570.56</CancellationRefundAmount>
                    <CancellationRefundAmount NumDays="1">100.00</CancellationRefundAmount>
                    <CancellationRefundAmount NumDays="331">50.00</CancellationRefundAmount>
                </GuaranteePrepaid>
                <PricedEquip>
                    <SpecialEquipment Code="CST" Status="CNF">
                        <Rate BaseAmount="0.00" Plan="B"/>
                    </SpecialEquipment>
                    <SpecialEquipment Code="NAV" Status="CNF">
                        <Rate BaseAmount="62.91" Plan="B"/>
                    </SpecialEquipment>
                    <SpecialEquipment Code="BST" Status="CNF">
                        <Rate BaseAmount="98.00" Plan="B"/>
                    </SpecialEquipment>
                    <SpecialEquipment Code="CST" Status="CNF">
                        <Rate BaseAmount="98.00" Plan="B"/>
                    </SpecialEquipment>
                </PricedEquip>
                <RentalRate AvailabilityStatus="S" RateCode="ABC123" STM_RatePlan="W">
                    <Vehicle>
                        <VehType>ICAR</VehType>
                    </Vehicle>
                </RentalRate>
                <VehicleCharges>
                    <VehicleCharge Amount="238.41" CurrencyCode="USD" GuaranteeInd="G" PrepayDeposit="P">
                        <AdditionalDayHour>
                            <Day CurrencyCode="USD" MileageAllowance="UNL" Rate="34.09"/>
                            <Hour CurrencyCode="USD" MileageAllowance="UNL" Rate="17.05"/>
                        </AdditionalDayHour>
                        <Mileage Allowance="UNL" CurrencyCode="USD" ExtraMileageCharge=".00" UnitOfMeasure="MI"/>
                        <SpecialEquipTotalCharge Amount="258.91" CurrencyCode="USD"/>
                        <TotalCharge Amount="847.58" CurrencyCode="USD"/>
                    </VehicleCharge>
                </VehicleCharges>
            </VehAvailCore>
            <Vendor Code="XX" CompanyShortName="TEST RENT" ParticipationLevel="B"/>
        </VehVendorAvail>
    </VehVendorAvails>
</VehAvailRSCore>

Shop

<VehAvailRSCore>
    <HeaderInfo>
        <Text>R C USD RATE/PLAN MI/KM   CHG       APPROX C</Text>
    </HeaderInfo>
    <VehRentalCore NumDays="3" NumHours="0" PickUpDateTime="07-22T12:00" ReturnDateTime="07-25T12:00">
        <DropOffLocationDetails LocationCode="DFW"/>
        <LocationDetails LocationCode="DFW" LocationName="DALLAS FORT WORTH INTL"/>
    </VehRentalCore>
    <VehVendorAvails>
        <VehVendorAvail RPH="1">
            <VehAvailCore>
                <GuaranteePrepaid Amount="289.43" AmountPercentage="M" CurrencyCode="USD" Ind="P">
                    <CancellationRefundAmount NumDays="0">289.43</CancellationRefundAmount>
                    <CancellationRefundAmount NumDays="1">100.00</CancellationRefundAmount>
                    <CancellationRefundAmount NumDays="331">50.00</CancellationRefundAmount>
                </GuaranteePrepaid>
                <PricedEquip>
                    <SpecialEquipment Code="CST" Status="CNF">
                        <Rate BaseAmount="41.97" Plan="B"/>
                    </SpecialEquipment>
                    <SpecialEquipment Code="HCL" Status="CNF">
                        <Rate BaseAmount="0.00" Plan="B"/>
                    </SpecialEquipment>
                </PricedEquip>
                <RentalRate AvailabilityStatus="S" RateCode="ABC123" STM_RatePlan="D">
                    <Vehicle>
                        <VehType>ECAR</VehType>
                    </Vehicle>
                </RentalRate>
                <VehicleCharges>
                    <VehicleCharge Amount="66.51" CurrencyCode="USD" GuaranteeInd="G" PrepayDeposit="P">
                        <AdditionalDayHour>
                            <Day CurrencyCode="USD"/>
                            <Hour CurrencyCode="USD" MileageAllowance="UNL" Rate="22.61"/>
                        </AdditionalDayHour>
                        <Mileage Allowance="UNL" CurrencyCode="USD" ExtraMileageCharge=".00"/>
                        <SpecialEquipTotalCharge Amount="41.97" CurrencyCode="USD"/>
                        <TotalCharge Amount="337.70" CurrencyCode="USD"/>
                    </VehicleCharge>
                </VehicleCharges>
            </VehAvailCore>
            <Vendor Code="XX" CompanyShortName="CAR RENT" CounterLocation="A" ParticipationLevel="B"/>
        </VehVendorAvail>
        <VehVendorAvail RPH="2">
            <VehAvailCore>
                <RentalRate AvailabilityStatus="S" RateCode="DEF456" STM_RatePlan="D">
                    <Vehicle>
                        <VehType>SCAR</VehType>
                    </Vehicle>
                </RentalRate>
                <VehicleCharges>
                    <VehicleCharge Amount="81.00" CurrencyCode="USD" GuaranteeInd="G">
                        <AdditionalDayHour>
                            <Day CurrencyCode="USD" MileageAllowance="UNL" Rate="81.00"/>
                            <Hour CurrencyCode="USD" MileageAllowance="UNL" Rate="40.50"/>
                        </AdditionalDayHour>
                        <Mileage Allowance="UNL" CurrencyCode="USD" ExtraMileageCharge=".00"/>
                        <SpecialEquipTotalCharge CurrencyCode="USD"/>
                        <TotalCharge Amount="339.79" CurrencyCode="USD"/>
                    </VehicleCharge>
                </VehicleCharges>
            </VehAvailCore>
            <Vendor Code="YY" CompanyShortName="TEST CAR" CounterLocation="A" ParticipationLevel="B"/>
        </VehVendorAvail>
    </VehVendorAvails>
</VehAvailRSCore>

Response Elements

/VehAvailRSCore

Vehicle Availability Core contains critical information relating to the booking.

VehAvailRSCore/HeaderInfo/Text

All data in this response attribute is constant, except for optional messages at the end of the response from the car supplier. These constant data headers can be ignored, as it's stock data that displays to legacy users viewing this data outside of the API. However, the free text provided by the car supplier at the end of the response attribute is important to note. This text can be 0-5 lines, and is highlighted in the example below.

Contains multiple of one child element, with each element between 1-63 characters.

<HeaderInfo>
    <Text>*RATES RETURNED VIA DIRECT CONNECT</Text>
    <Text>R C CAD RATE/PLAN    MI      CHG           APPROX</Text>
    <Text>ALL TOTAL PRICES ARE RETURNED DIRECT CONNECT FROM CAR ASSOCIATE</Text>
    <Text>* BEST PUBLICLY AVAILABLE RATE</Text>
    <Text>C  COMMISSION  FX FIXED     05 PERCENTAGE    BLANK-COMM UNKNOWN</Text>
    <Text>R RATE AND/OR VEHICLE ON REQUEST         Â‡ CURRENCY CONVERTED</Text>
    <Text>- AMOUNT TOO LARGE                       C CONTRACT RATE</Text>
    <Text>L INCLUSIVE RATE</Text>
    <Text>G GUARANTEE  REQUIRED - CREDIT CARD MANDATORY AT TIME OF SELL</Text>
    <Text>P PREPAYMENT REQUIRED - CREDIT CARD MANDATORY AT TIME OF SELL</Text>
    <Text>PLAN  D-DAILY  E-WEEKEND  W-WEEKLY  M-MONTHLY  B-BUNDLED</Text>
    <Text>CQ*R LINE  RATE DETAILS AND RULES</Text>
    <Text>CQ*P       LOCATION INFO IE.MAKES,EQUIPMENT,PAYMENT AND MORE</Text>
    <Text>CQ*X       EXTRA DAY AND HOUR RATES</Text>
    <Text>0C LINE    SELL CAR</Text>
    <Text>CAR SUPPLIER THANKS YOU FOR YOUR BUSINESS</Text>
    <Text>UNDER AGE DRIVERS MAY HAVE SURCHARGE</Text>
</HeaderInfo>

/VehAvailRSCore/VehRentalCore

The VehRentalCore element is the beginning of critical information, and contains a string of values.

Quote responses contain the actual number of days and hours the car supplier used to determine the type of rate returned.

Shop responses contain the number of days and hours in the request as the difference between the pickup date/times and return date/times. Suppliers round the length of the rental up or down to determine the rates to return.

Attributes

The following values are part of the element string:

Name
Description

@NumDays

The length of the rental in days. Will always be a 1-3 numeric value.

Note: A day is defined as the 24-hour period of time based on when the car was picked up.

@NumHours

The number of hours past a 24-hour time period for the length of the rental. Will always be a 1-3 numeric value.

@PickUpDateTime

The pick up time in "month-dayTtime" format.

@ReturnDateTime

The return time in "month-dayTtime" format.

.../VehRentalCore/DropoffLocationDetails

This element is only present if a value for <ReturnLocation LocationCode=" "> was entered in the request, and contains a breakdown of the city/airport code. If needed, this field will also display the extended-location code for non-airports.

Attributes
Name
Description

@ExtendedLocationCode

Important! This is a "Quote" request item only.

The Extended Location Code is an optional, Quote-specific field (non-airport locations only) field in response to <ReturnLocation LocationCode="DFWC001"/>. It's displayed in 1 alpha, 3 numeric format, with the 1 alpha representing the type of non-airport by direction or type code. These values can be:

  • "N": North
  • "S": South
  • "E": East
  • "W": West
  • "R": Resort
  • "X": Rail
  • "P": Port
  • "C": City

Example:

<DropOffLocationDetails ExtendedLocationCode="C001"/>

@LocationCode

The Location Code is optional, and contains drop off location details in 3 alpha-numeric format. It will only be present if <ReturnLocation LocationCode> was submitted in the request.

<DropOffLocationDetails LocationCode="DFW"/>

 

.../VehRentalCore/LocationDetails

This element contains a string of attributes and children elements relating to rental location hours.

Attributes
Name
Description

@CounterLocation

Required

Displays 1 alpha numeric value that signifies the location of the rental facility. Can be:

  • "N": NON AIRPORT LOCATION
  • "I": IN TERMINAL
  • "F": OFF AIRPORT/RENTAL SHUTTLE
  • "S": IN TERMINAL/RENTAL SHUTTLE
  • "O": ON AIRPORT/RENTAL SHUTTLE
  • "A": ON AIRPORT/AIRPORT SHUTTLE
  • "C": CALL FOR SHUTTLE
  • "M": 2 SHUTTLES AIRPORT AND RENTAL

@ExtendedLocationCode

Important! This is a "Quote" request item only.

An optional, Quote request-specific field (non-airport locations only) in response to <ReturnLocation LocationCode="DFWC001"/>. It's displayed in 1 alpha 3 numeric format, with the 1 alpha representing the type of non-airport by direction or type code. Can be:

  • "N": North
  • "S": South
  • "E": East
  • "W": West
  • "R": Resort
  • "X": Rail
  • "P": Port
  • "C": City

<DropOffLocationDetails ExtendedLocationCode="C001"

@LocationCode

Required

The 3 alpha-numeric airport code of the pickup location.

@LocationName

Required

The name of the pickup location. Can be 1-26 characters.

@LocationOwner

Required

A 1 alpha value that denotes the owner type of the location. Can be:

"C" for a corporate-owned location, or "F" for a franchise-owned location

Non-Airport Quote

<LocationDetails CounterLocation="N" ExtendedLocationCode="C007" LocationCode="LAS" LocationName="LAS VEGAS" LocationOwner="C">

Airport Quote or Shop

<LocationDetails CounterLocation="I" LocationCode="LAS" LocationName="LAS VEGAS" LocationOwner="C">

Children

The following table contains a list of all applicable child elements in the LocationDetails parent element:

Name
Description

//OperationSchedule

Contains 1 to 4 hours of operations.

//OperationTimes

Contains both end and start times.

//OperationTimes/OperationTime/@End

//OperationTimes/OperationTime/@Start

Contains two attributes, the opening (start) and closing (end) times in 24-hour format, from 00:00 to 23:59.

The Operation Time is always based on day. For example, a location open from 6:00AM to 1:00AM every day of the would display as two sets of time:

<OperationTime End="01:00" Start="00:00"/>
<OperationTime End="23:59" Start="06:00"/>

 

/VehAvailRSCore/VehVendorAvails

Contains rate information for each car available. This group of elements can repeat up to 999 times.

.../VehVendorAvail/@RPH

The RPH is a required field that denotes the line number of each rate item. This element will never contain more than 3 numbers.

.../VehVendorAvail/VehAvailCore

The <VehicleAvailCore> element denotes the beginning of the rental and rate information.

.../VehVendorAvail/VehAvailCore/GuaranteePrepaid

Gurantee Prepaid contains a string of attributes and child elements. These attributes and children elements return amount information and whether the amount is prepaid or guaranteed. Guarantee Prepaid is optional.

The response is displayed in sequential order. In the case of multiple <CancellationRefundAmount> values, the number of days will always be in decreasing order:

<GuaranteePrepaid Amount="379.28" AmountPercentage="M" CurrencyCode="USD" Ind="P"> 
    <CancellationRefundAmount NumDays="331">25.00</CancellationRefundAmount> 
    <CancellationRefundAmount NumDays="2">50.00</CancellationRefundAmount>
    <CancellationRefundAmount NumDays="1">100.00</CancellationRefundAmount> 
    <CancellationRefundAmount NumDays="0">379.28</CancellationRefundAmount> 
</GuaranteePrepaid>

Attributes
Name
Description

@Amount

The total amount guaranteed to be charged at time of pickup, even if the customer fails to arrive. This can also be the total amount to be prepaid at the time of booking.

Can be a 1-13 numeric value or up to 12 with one decimal point.

@AmountPercentage

Can be "M" for Money, or "P" for percentage. 

@CurrencyCode

The 3 letter ISO 4217 currency code.

@Ind

Indicator denoting whether the value is Guaranteed "G", or Prepaid "P".

GuaranteePrepaid can be strung together as follows:

<GuaranteePrepaid Amount="379.28" AmountPercentage="M" CurrencyCode="USD" Ind="P">

Children

GuaranteePrepaid child elements must have at least 1, and up to 4, occurrences of CancellationRefundAmount elements.

Name
Description

//CancellationRefundAmount

Contains one attribute plus one monetary amount or percentage amount. The amount is always a cancellation amount as there is no longer a refund listed.

The refund is the difference between the amount in <GuaranteePrepaid Amount> and the <Amount> if <Ind="G">, or the remaining percentage if <Ind="P">.

//CancellationRefundAmount/@NumDays

The number of days covering the entire amount of time from the booking date/time through to the pickup date/time.

This value is between 1-3 numeric, and cannot exceed 331 days.

00.00 (monetary value)

The monetary value or percentage of the cancellation amount.

If <Ind="M">, the value is 1-13 numeric or up to 12 with one decimal point.

If <Ind="P">, the value is 1-5 numeric, with no more than 3 numbers to the right of a single decimal point.

<GuaranteePrepaid> child elements can be strung together as follows:

<CancellationRefundAmount NumDays="2">50.00</CancellationRefundAmount>
<CancellationRefundAmount NumDays="1">100.00</CancellationRefundAmount>
<CancellationRefundAmount NumDays="0">379.28</CancellationRefundAmount>

.../VehVendorAvail/VehAvailCore/PricedEquip

PricedEquip is optional, but when present, contains the SpecialEquipment and Rate BaseAmount elements.

.../VehVendorAvail/VehAvailCore/PricedEquip/SpecialEquipment

SpecialEquipment attributes display if PricedEquip is present. These attributes are commonly referred to as Car Extras, and may return physical equipment, services, and surcharges.

Attributes
Name
Description

@Code

Displays when <PricedEquip> is present in the response, and includes things like child seats, services, and surcharges. These codes can be standard Sabre Car Codes, or custom codes provided by the supplier. These car supplier codes do not have a defined name returned, as they are defined in the Sabre Car Rental Location Policy.

Special equipment/Car Extra codes may be repeated up to 10 times. Some suppliers do not support this field, or only support up to 4-10 repeats of equipment type.

@Status

Displays when <PricedEquip> is present in the response. Can be Confirmed "CNF", On Request "ONR", or Not Available "NTA".

.../VehVendorAvail/VehAvailCore/PricedEquip/SpecialEquipment/Rate

Contains the amount of the Car Extra and the Plan type to apply to the amount.

Attributes
Name
Description

@BaseAmount

Displays when <PricedEquip> is present in the response. It can be a 1-13 numeric value representing the base amount of the special equipment.

@Plan

Displays when <PricedEquip> is present and contains a list of possible rate plans. Can be Daily "D", Weekend "E", Weekly "W", Monthly "M", and "B" Bundled (length of rental).

.../VehVendorAvail/VehAvailCore/RentalRate

Attributes
Name
Description

@AvailabilityStatus

Denotes the availability status of the vehicle. Can be Sell "S" or On Request "R".

@RateCode

The car supplier-specific 2-6 alpha-numeric code tied to the available rate.

@STM_RatePlan

Describes the length of rental rates. This value is determined by the length of the car rental based on the number of days and hours, and is the difference between the pickup date/time and the return date/time. Can be Daily "D", Weekend "E", Weekly "W", Monthly "M", and Bundled "B" (length of rental).

<RentalRate AvailabilityStatus="S" RateCode="ABC123" STM_RatePlan="W">

Children
Name
Description

//Vehicle

Denotes the beginning of the vehicle type information, monetary amounts, and distance limits (if any).

//Vehicle/VehicleType

A 4 alpha-numeric code that denotes the type of vehicle. Refer to the Matrices page for a list of all possible values.

.../VehVendorAvail/VehAvailCore/VehicleCharges

VehicleCharges contains all information regarding car rental pricing.

.../VehVendorAvail/VehAvailCore/VehicleCharges/VehicleCharge

Attributes
Name
Description

@Amount

The base amount, can be a 1-13 numeric value, or up to 12 with one decimal point.

@CurrencyCode

The 3 letter ISO 4217 currency code.

@GuaranteeInd

The Guarantee Indication has a dual purpose:

  • The primary purpose displays whether the rate is guranteed. This is a one letter value that can be Guarantee "G", Request (Quoted) "Q", or Closed "C".
  • The secondary purpose indicates the rate in the Amount=" " is the actual amount or has been converted from the specific currency of the rental location. If present, this value will be prior to the "G", "Q", or "C", and the value will be a cross Loraine, representing change (‡).

<VehicleCharge Amount="426.24" CurrencyCode="GBP" GuaranteeInd="‡G">

.../VehVendorAvail/VehAvailCore/VehicleCharges/VehicleCharge/AdditionalDayHour

Represents the beginning of an extra day and any extra hourly rates/mileages. When this field displays, at least one child element will also display describing the overage(s).

<AdditionalDayHour>
    <Day CurrencyCode="GBP" MileageAllowance="UNL" Rate="71.04"/>
    <Hour CurrencyCode="GBP" MileageAllowance="UNL" Rate="10.04"/>
</AdditionalDayHour>

Day Attributes
Name
Description

//Day

Lists all attributes that apply to the extra day.

//Day/@CurrencyCode

The 3 letter ISO 4217 currency code.

//Day/@MileageAllowance

Denotes the limit of distance allowed for an the extra day of rental. Can be "UNL" for Unlimited or a 1-5 numeric value.

Note: If MileageAllowance="UNL", then the extra day must be UNL.

//Day/@Rate

Displays the rate of the extra day. Can be a 1-13 numeric value or up to 12 with one decimal point.

<Day CurrencyCode="GBP" MileageAllowance="UNL" Rate="71.04"/>

Hour Attributes
Name
Description

//Hour

Lists all attributes that apply to the extra hour.

//Hour/@CurrencyCode

The 3 letter ISO 4217 currency code.

//Hour/@MileageAllowance

Denotes the limit of distance allowed for an the extra hour of rental. Can be "UNL" for Unlimited or a 1-5 numeric value.

Note: If MileageAllowance="UNL", then the extra day must be UNL.

//Hour/@Rate

The rate of the extra hour. Can be a 1-13 numeric value or up to 12 with one decimal point.

<Hour CurrencyCode="GBP" MileageAllowance="UNL" Rate="15.04"/>

.../VehVendorAvail/VehAvailCore/VehicleCharges/VehicleCharge/DropOffCharge

Displays attributes only when DropOffLocationDetails is present.

Attributes
Name
Description

@Amount

Denotes the car rental drop off amount. Can be a 1-13 numeric value, or up to 12 with one decimal point.

@CurrencyCode

The 3 letter ISO 4217 currency code.

.../VehVendorAvail/VehAvailCore/VehicleCharges/VehicleCharge/Mileage

Displays details pertaining to the distance limit of the rental and extra mileage fees.

Attributes
Name
Description

@Allowance

The limit of distance allowed for the plan. Can be "UNL" for unlimted or a 1-5 numeric value.

@CurrencyCode

The 3 letter ISO 4217 currency code.

@ExtraMileageCharge

  • If Allowance="UNL", then ExtraMileageCharge=".00"
  • This charge will display a 1-5 numeric value if the Allowance=" " is a numeric value.

@UnitOfMeasure

The unit of measure in either Miles "MI" or Kilometer "KM".

.../VehVendorAvail/VehAvailCore/VehicleCharges/VehicleCharge/SpecialEquipTotalCharge/@CurrencyCode

Contains a number of attributes when the currency code is the only one present and no PricedEquip is present.

.../VehVendorAvail/VehAvailCore/VehicleCharges/VehicleCharge/TotalCharge

Contains the total charge of the car rental and the currency of the charge.

Attributes
Name
Description

@Amount

Denotes the total amount of the car rental. Can be a 1-13 numeric value, or up to 12 with one decimal point.

@CurrencyCode

The 3 letter ISO 4217 currency code.

<TotalCharge Amount="1017.20" CurrencyCode="GBP"/>


Docs Navigation