New Features

In the Response

Optional

Parameter: HighestNightlyRate

Type: string

Description: This attribute will return the highest nightly rate for each rate being displayed, allowing you to better apply per diems on the highest rate instead of on total rates.

Sample Value:

<ns22:ConvertedRateInfo HighestNightlyRate="149.24" AverageNightlyRate="163.84" RateKey="bbgel5FDknBw==" ApproxTotalPrice="819.19" AverageNightlyRateBeforeTax="138.32" EndDate="2023-12-06" StartDate="2023-12-01" CurrencyCode="USD" AmountAfterTax="819.19" AdditionalFeesInclusive="false" AmountBeforeTax="691.60" RateSource="110" TaxInclusive="true"/>

In the Response

Optional

Parameter: ApproxTotalPrice

Type: string

Description: The ApproxTotalPrice will always return a rate, including all known taxes and fees, irrespective of whether the AmountAfterTax included them or not. This enables like-for-like comparisons of the total rate across sources, and gives a clear indication of the total charge to the traveler for a particular booking. If the AmountAfterTax already contains all the taxes and fees, ApproxTotalPrice will have the same value as it.

Sample Value:

<ns22:ConvertedRateInfo HighestNightlyRate="149.24" AverageNightlyRate="163.84" RateKey="bbgel5FDknBw==" ApproxTotalPrice="819.19" AverageNightlyRateBeforeTax="138.32" EndDate="2023-12-06" StartDate="2023-12-01" CurrencyCode="USD" AmountAfterTax="819.19" AdditionalFeesInclusive="false" AmountBeforeTax="691.60" RateSource="110" TaxInclusive="true"/>

New Features

In the Response

Optional

Parameter: MinSellingRate

Type: decimal

Description: Returns the supplier recommended selling price for the rate, if returned. This is generally populated for net rates.

Sample Value:

<RateInfo StartDate="2021-10-20" EndDate="2021-10-24" AmountBeforeTax="760.60" AmountAfterTax="882.40" MinSellingRate="900.00" />

Note: If populated, this is returned for each RateInfo or ConvertedRateInfo element in the response

In the Response

Optional

Parameter: AverageNightlyRateBeforeTax

Type: decimal

Description: Irrespective of the source, the AverageNightlyRateBeforeTax field will always be populated in the response, returning the overall averaged (not highest) nightly rate without considering any taxes or fees.

Sample Value:

<RateInfo StartDate="2021-10-20" EndDate="2021-10-24" AmountBeforeTax="760.60" AmountAfterTax="882.40" AverageNightlyRate="220.60" AverageNightlyRateBeforeTax="190.15" CurrencyCode="USD"/>

In the Response

Optional

Parameter: All OTA Code elements will now be accompanied with an attribute with the description of that OTA code.

Type: string

Description: This change applies to all OTA codes in the API responses, including but not limited to: RoomTypeCode, RatePlanInclusion, Amenity, TaxGroups, and FeeGroups.

Sample Value:

<RatePlanInclusion Code="222" Description="Free high speed internet connection"/>
<MealsIncluded Breakfast="true" Lunch="true" Dinner="true" MealPlanIndicator="true" MealPlanCode="1" GuestCount="3" MealPlanDescription="All Inclusive"/>
<TaxGroup Code="13" Description="Sales Tax" Amount="40.00" CurrencyCode="USD"/>
<FeeGroup Code="2" Description="City Hotel Fee" Amount="25.00" CurrencyCode="USD"/>

In the Response

Optional

Parameter: CVVRequired

Type: boolean

Description: When specifically returned by suppliers, this boolean field is populated in the response to indicate that a CVV number is mandatory when booking.

Sample Value:

<GuaranteeAccepted GuaranteeTypeCode="5" GuaranteeTypeDescription="Credit Card">
      <PaymentCards CVVRequired="true">
          <PaymentCard CardCode="VI">VISA</PaymentCard>
          <PaymentCard CardCode="MC">MASTER CARD</PaymentCard>
      </PaymentCards>
</GuaranteeAccepted>

In the Response

Optional

Parameter: DepositPolicies

Type: element

Description: The Deposit policies element now contains a list of multiple policies for rates that may have a varying deposit policies based on dates for a reservation.

Sample Value:

<DepositPolicies>
    <DepositPolicy>
        <Deadline AbsoluteDeadline="202-10-12T18:00:00"/>
        <AmountPercent NmbrOfNights="1" Amount="176.48"/>
    </DepositPolicy>
    <DepositPolicy>
        <Deadline AbsoluteDeadline="202-10-18T18:00:00"/>
        <AmountPercent NmbrOfNights="1" Amount="176.48"/>
    </DepositPolicy>
</DepositPolicies>

Functional Updates And Enhancements

In the Response

Optional

Parameter: Hotel Codes

Type: string

Description: The response will now always return Global hotel codes irrespective of whether the rateKey was generated using a Sabre or a Global hotel code. If the property is also available from Sabre, a SabreHotelCode and the Chain code will be returned in the response.

Sample Value:

<HotelInfo HotelCode="100095296" CodeContext="GLOBAL" SabreHotelCode="49504"/>

In the Response

Optional

Parameter: AmountBeforeTax

Type: decimal

Description: The AmountBeforeTax is now always returned in the response, irrespective of the source being shopped.

Sample Value:

<RateInfo StartDate="2021-10-20" EndDate="2021-10-24" AmountBeforeTax="760.60" AmountAfterTax="882.40"  AverageNightlyRate="220.60" AverageNightlyRateBeforeTax="190.15" CurrencyCode="USD" AdditionalFeesInclusive="true" TaxInclusive="true" />

In the Response

Optional

Parameter: LoyaltyId

Type: string

Description: The LoyaltyId attribute has been removed from the RateInfos element and instead moved inside the Rooms -> Room -> RatePlans -> RatePlan element since it reflects the rateplan and not rates.

Sample Value:

<RatePlan RatePlanName="Room, 2 Double Beds" RatePlanCode="AARP" RatePlanType="1" LoyaltyId="IQ1234"/>

Resolved Issues

In the Response

Optional

Description: Rate related additional details will now be populated in the AdditionalDetails element inside the RateInfo element for all sources, which removes an inconsistency where it was sometimes populated under the Rooms element.

Functional Updates And Enhancements

In the Response

Optional

Parameter: Simplification of RateInfo information in the response

Type: mixed

Description: RateInfo will now just supply totals which will include Commission. The following tags will be removed from the Rate Level: Taxes; Fees; Rates; CancelPenalties; Guarantee; Additional Details. At Room Level, the "Commission" has been removed.