Hotel Rate Details

hotel:HotelRateDetail

HotelRateDetail provides information for specific hotel room/rate combinations (@RatePlanType) in Hotel Rate and Rule Search, Hotel Rules, and Hotel Booking responses.

Requests that include HotelRateDetail are used only for upsell requests (HotelUpsellDetailsReq), which are not currently supported.

Element/Attribute Description
HotelRateDetail Provides details associated to a specific hotel room and rate combination (@RatePlanType).
@RatePlanType The booking code that identifies the room type and associated rate. Also known as BIC (Booking Indicator Code).
@Base

The base amount is populated with the total, or is populated with the base amount multiplied by the number of nights if the total is not returned.
@Tax

The tax amount associated to the rate plan (@RatePlanType). These taxes include charges such as city taxes, tourism taxes, and VAT/GST.

Tax codes can be obtained using UniversalRecordRetrieveReq with the "HotelTaxType" Reference Data type.


  • Universal API uses OTA Travelport-proprietary tax codes for taxes applicable to a rate plan type.

Tax detail codes are returned by Galileo (1G), Apollo (1V), and Worldspan (1P).

@Total

The total amount is populated with the approximate total, or if the approximate total is not available, the base amount plus taxes.

When the response is from Galileo and Apollo, the total amount is the base amount plus the taxes.

@Surcharge Any additional fees or charges associated with the rate plan.
@ApproximateBase The approximate base room rate, excluding taxes or fees. Base values are returned for Rate by Date hotel responses. If a preferred currency is specified in the request, alternate currency amounts from are returned.
@ApproximateTax Approximate taxes associated with the room rate and hotel stay.
@ApproximateTotal The approximate total room rate, including taxes and fees.
@ApproximateSurcharge Any additional fees or charges associated with the rate plan.
@RateGuaranteed

If "true", the rate is guaranteed by the supplier. If "false", the rate is not guaranteed.

Supported by Galileo and Apollo only.
@ApproximateRateGuaranteed

If "true", the approximate rate is guaranteed by the supplier. If "false", the rate is not guaranteed.

Supported by Galileo and Apollo only.
@RateCategory The rate category associated to the rate plan type.
@Key The key associated to the HotelRateDetail instance.
@RateSupplier The source of the associated property data.
@InPolicy, @PolicyCode, @PolicyExclusion

If hotel policy information is requested, the response indicates if a Rate Plan Type meets the policy requirements of the

@RateChangeIndicator

Indicates the presence of rate changes for a room/rate plan (@RatePlanType).


  • For all supported providers, returns discrete data for rate change indicators in HotelRateDetail @RateChangeIndicator:
  • If "True", the room rate changes during the hotel stay.
  • If "False", the room rate does not change during the hotel stay.
  • If "Unknown", the supplier did not return rate change data.

Rate change indicators are supported for Galileo (1G), Apollo (1V), and Worldspan (1P).

@ExtraFeesIncluded

Indicates the presence of extra fees for a room/rate plan (@RatePlanType).


  • For all supported providers, returns discrete data extra fee indicators in HotelRateDetail @ExtraFeesIncluded:
  • If "True", additional fees or charges are included in the total rate. These fees can be charged for additional adult travelers, child travelers, cribs, and rollaway cots for adults, and rollaway cots for children. The fee amounts are returned in /HotelRateDetail/ExtraCharges.
  • If "False", additional fees or charges are not included in the total rate.
  • If "Unknown", the supplier did not return extra fee data.

Extra fee indicators are supported for Galileo (1G), Apollo (1V), and Worldspan (1P).

/RoomRateDescription

A textual description of the room/rate combination is typically returned in the HotelRateDetail/RoomRateDescription child element. This description typically includes information such as check-in and check-out times, and deposit, guarantee, and cancellation policies. However, this data is returned directly from the supplier, and amount and type of data returned can vary by supplier.

Important! Depending on the provider, supplier/aggregator, and schema version, room rate descriptions may be returned as either free text in RoomRateDescription or as discrete data. In some responses, the same description information may be returned as both free text and discrete data.

Historically, most room rate descriptions were returned as free text in /RoomRateDescription with an assigned category (@Name). However, elements are being added in various releases to return some of these descriptions as discrete data in elements such as AcceptedPayment, TaxDetails, and ExtraCharges.

General Room/Rate Descriptions

Room/rate descriptions are returned in Hotel Rate and Rule Search, Hotel Rules, and Hotel Super Shopper. Descriptions were added to Hotel Booking as a configurable option.

By default, Universal API returns room/rate description text in Hotel Booking responses. However, this functionality is configurable by Target Branch. Contact your Travelport representative if you want to request that room/rate descriptions be disabled for Hotel Booking responses for a specific Target Branch.

Parsing for Rate Plan and Room Description Text

In Hotel.xsd, the following changes were made rate plan and room description text to separate this text into two separate @Name values. This update applies to responses for Hotel Rate and Rule Search, Hotel Super Shopper, and Hotel Booking:

  • A description of the type of room associated with the plan, such as Suite, Regular, and Condo.

Important! Even though there is no schema change associated to these unenumerated values, client applications must be modified to support the change in RoomRateDescription @Name values for Hotel.xsd.

Hotel.xsd

The rate name and room description are divided into separate values of Name="Room" and Name="Rate". Text is returned in sentence case or title case. For example:

<RoomRateDescription Name="Room">

<Text>1 Queen Bed-nonsmoking</Text>

<Text>Hi Speed 9.95 Day-sweet Dreams Experience Bed</Text>

</RoomRateDescription>

<RoomRateDescription Name="Rate">

<Text>Best Available Rate</Text>

</RoomRateDescription>

Note: If text cannot be parsed, room and rate information is returned in the original format.

See examples in .

Prior to Hotel v46.0, the Pretty Print Service for hotels was controlled by a switch to activate or deactivate the functionality for all hotel customers for all transactions applicable. Room and rate description were parsed into separate attributes. If the service was unable to parse the text, it displayed the room and rate description in the original format. Release 18.3

Hotel v46.0 provides the ability to deactivate the pretty print service by target branch. By default all Universal API hotel customers are active for the pretty print service. However, if a target branch is added to the new switch, the pretty print service is not applied to any hotel response transactions. All hotel transactions display the room and rate description in a single attribute. For example:

<hotel:RoomRateDescription Name="Description"> <hotel:Text>1 BEDROOM APARTMENT 1 KING BED. GOVERNEMENT RATE-CHAMBRE SEULE</hotel:Text> </hotel:RoomRateDescription>
/HotelRateByDate

Indicates the dates in the booking that apply to the HotelRateDetail parent element. If provided, rate change information is returned at least one time and up to 30 rate change times for a maximum 99-night stay. Information included in the response indicates the effective date, expiration date, and base rate of the nightly rate amount for the associated date range.

  • The HotelRatebyDate element includes a breakdown of rate data for each day of the requested stay. This information includes:
    • EffectiveDate, which is the start date of the nightly rate change.
    • ExpireDate, which is the end date of the nightly rate change.
    • Base, which is the nightly rate during the effective and expiration dates, without any additional taxes, fees, or surcharges. If there are multiple rates returned for the stay, then multiple base rates are included in the response.
    • Tax, Total, and Surcharge data for the booking.
    • The total price, which combines the base rate and taxes.

    Imported PNRs that contain Rate by Data date are supported, but are not recorded to the UR History.
    /AcceptedPayment

    Accepted forms of payment for a hotel guarantee, deposit, or payment.

    Returns discrete data for accepted forms of payment in HotelRateDetail/AcceptedPayment.

    @PaymentCode is a specific form of payment accepted by the supplier or aggregator for the room and rate (@RatePlanType). For example, an American Express credit card is indicated by AcceptedPayment PaymentCode="AX".

    Availability of discrete data may vary by provider and supplier/aggregator:

    • For Galileo (1G) and Apollo (1V), accepted payment types are returned only in AcceptedPayment.
    • For Worldspan (1P), not all accepted payment codes are currently returned. Therefore, accepted payment types are returned both in AcceptedPayment and as free text in RoomRateDescription Name="Credit Cards".
    /Commission

    Accepted forms of payment for a hotel guarantee, deposit, or payment.

    Commission data is returned as discrete data in HotelRateDetail/Commission:

    • @Indicator indicates if the rate plan (@RatePlanType) is commissionable (True), not commissionable (False), or is not returned from the supplier/aggregator (Unknown).
    • @Percent is the percentage applied to the commissionable amount to determine the payable commission amount. Galileo, Apollo, and Worldspan only.

    For all providers, commission data is returned only in the Commission element.
    /CorporateDiscountID The corporate discount ID or negotiated rate associated with the rate plan type.
    /RateMatchIndicator Indicates if the rate returned from the supplier matches the requested search parameters, such as the number of child guests or extra adult guests.
    /TaxDetails

    Tax detail codes for taxes applicable to a room/rate plan (@RatePlanType). These taxes include charges such as city taxes, tourism taxes, and VAT/GST.


    • Open Travel Alliance (OTA)

    Tax codes can be obtained using UniversalRecordRetrieveReq with the "HotelTaxType" Reference Data type. OTA tax codes are returned in current schema versions.

    Tax detail codes are supported by Galileo (1G), Apollo (1V), and Worldspan (1P).

    /CancelInfo

    Sometimes a hotel supplier may provide an indicator for a hotel room rate that is non-refundable or that has additional cancellation information room plan type.

    The CancelInfo element is used to return this cancellation information for Galileo and Apollo suppliers that participate in Complete Pricing Plus (CP2). The CancelInfo element attributes may be populated in both Hotel and Universal Record responses if data is provided by a hotel supplier.

    @NonRefundableStayIndicator and @CancelDeadline are discrete data for Worldspan in Hotel Rate and Rule Search only. Previously, Worldspan returned free-text data in HotelDetailRsp/RequestedHotelDetails/HotelRateDetail/RoomRateDescription @Name @Text. When applicable, Worldspan continue to return free text in addition to the @CancelDeadline value:

    RoomRateDescription Name="Cancel Policy Exist" Text="Please reference the Cancellation Policy in Hotel Rules"

    Attributes Definition

    @NonRefundableStayIndicator

    Returned from hotel room rate.

    • true = non-refundable
    • false = refundable
    • unknown = unknown or not provided by hotel.

    @CancelDeadline

    YYYY-MM-DDTHH:MM

    The date and time to cancel the hotel reservation without penalty. All dates and times are local to the hotel property.

    • blank or not present = unknown or not provided by hotel

    @TaxInclusive

    Shows if the cancellation penalty includes taxes.

    • True = yes
    • False = no
    • blank or not present = unknown or not provided by hotel.

    @FeeInclusive

    Shows if the cancellation penalty includes extra fees.

    • True= yes
    • False=no
    • blank or not present= unknown or not provided by hotel.

    @CancelPenaltyAmount

    If provided, returns the ISO three-character currency code and value amount with decimal. For example, CAD100.00.

    • blank or not present= unknown or not provided by hotel.

    @NumberOfNights

    The number of nights that are charged as the cancellation penalty. For example: 3.

    • Integer: 0 – 99
    • blank or not present= unknown or not provided by hotel.

    @CancelPenaltyPercent

    Percentage of booking that will be charged as the cancellation penalty. For example: 100.

    • Integer: 1 – 999
    • blank or not present = unknown or not provided by hotel.

    @CancelPenaltyPercentAppliesTo

    Explanation of the cancellation penalty percent.

    • Text. 0-64 characters.
    • blank or not present = unknown or not provided by hotel.
    @OffsetTimeUnit, @OffsetUnitMultiplier, @OffsetDropTime

    Indicate the deadline time associated with a cancellation.

    The following attributes were added to CancelInfo to indicate the time period of the deadline either after booking or before arrival at the hotel stay.

    • @OffsetTimeUnit: "Year”, “Month”, “Day”, or “Hour”.
    • @OffsetUnitMultiplier: The number of units for the deadline.
    • @OffsetDropTime: "AfterBooking" or "BeforeArrival".

    For example:

    <CancelInfo NonRefundableStayIndicator="true" OffsetTimeUnit=”Week” OffsetUnitMultiplier=”2” OffsetDropTime=”BeforeArrival”/>

    Cancellation is non-refundable after two weeks before arrival at the hotel stay.

    Offset time is returned only for Galileo (1G) and Apollo (1V). Offset time is not returned for Worldspan (1P).
    /GuaranteeInfo

    Discrete guarantee, deposit and pre-payment information, if it is populated by the supplier or aggregator. If the hotel supplier does not support discrete data in the response, free text data is returned in RoomRateDescription.
    /ExtraCharges

    Extra charges apply to fees for additional travelers, cribs, and rollaway cots in a hotel room.

    Extra charges are returned as discrete data in /HotelRateDetail/ExtraCharges, which contains the following attributes for specific types of charges: @ExtraAdultAmount, @ExtraChildAmount, @CribAmount, @AdultRollawayCharge, and @ChildRollawayCharge.

    For Galileo (1G), Apollo (1V), and Worldspan (1P), extra charges are returned only in the ExtraCharges element for Hotel v35.0 and later, with the exception of Hotel Rules. For Hotel Rules:

    • Worldspan continue to return extra charges as free text in RoomRateDescription.
    • Galileo and Apollo return extra charges in /ExtraCharges.
    /Inclusions

    The Inclusions element contains discrete information about designated smoking rooms, available bed types, meal plans, and room views associated to a rate plan (@RatePlanType).

    Inclusions @SmokingRoomIndicator

    Indicates is smoking is permitted in a room.

    Extra charges are returned as discrete data in /HotelRateDetail @SmokingRoomIndicator:

    • "True" if smoking is permitted in the room.
    • "False" if smoking is not permitted.
    • "Unknown" if the supplier/aggregator did not return data.
    Inclusions/BedType

    Returns bed types for a room/rate plan.

    Inclusions/Mealplans

    Meal plans associated to a rate plan type.
    Inclusions/RoomView

    Returns room views for a rate plan type.