Hotel Rules Reference Payload API Reference

Product

Array. One instance for each product, type ProductHospitality.

Key value pairs:

bookingCode: Booking code retrieved from the Availability response.

adaCompliant: Yes, No, or Unknown indicator for ADA compliance.

propertyName: Name of property offering this product.

guests: Number of guests.

Quantity: Number of rooms currently available matching this rate.

Includes PropertyKey, PropertyAddress, RoomType, Telephone, and DateRange objects.

---

PropertyKey

When ReferenceList is returned, PropertyKey includes the key value pairs:

chainCode: Chain code for the property.

propertyCode: Property code for the property.

---

PropertyAddress

Top level property address object. Key value pairs:

City: Property city.

PostalCode: Property postal code.

Includes AddressLine, StateProv, and Country objects.

AddressLine

Text string for property street address.

StateProv

Property state or province. Key value pairs:

value: The state or province code of the property address.

name: State/province name or code.

Country

Property country. Key value pairs:

name: Country name or code.

---

Telephone

Telephone number of xxxxxx. Key value pairs:

phoneNumber: string. Accepted characters: numeric, dash, space, period.

cityCode: IATA city code if referenced by phone number.

---

RoomType

Room type detail.

Includes RoomCharacteristics, Description, and RoomAmenity objects.

---

RoomCharacteristics

Room details. Key value pairs:

category: Category of the room.

typeCode: OTA room type code.

smokingAllowed: Yes or No indicator for smoking.

wifiIncluded: Yes or No indicator for wifi.

viewCode: Free text describing the view.

shortRoomDescription: Normalized text for grouping rates against similar room types.

accessibleRoom: Yes or No indicator for room with accessible features.

Includes BedConfiguration object.

---

BedConfiguration

Configuration of bed(s) in room. Key value pairs:

quantity: Number of beds in the room.

bedType: Bed type values as follows:

• King Bed(s)
• Queen Bed(s)
• Twin Bed(s)
• Sofa Bed(s)
• OTHER Bed(s)

size: Size of bed(s) in the room. Approximate measurement of the bed(s).

---

Description

A room description text string. Key value pairs:

languages: The language code of the description text.

value: Room description text (e.g. Save 15 Pct Off Studio King Suite Full Breakfast:Free WiFi:32in TV).

---

RoomAmenity

Room amenity name and description. Key value pairs:

description: Description of amenity received from supplier.

code: OTA code associated to amenity.

includedIndicator: Amenity included with rate.

---

RoomOccupancy

Room occupancy value. Key value pair:

maxOccupancy: The maximum number of room occupants.

---

DateRange

Check-in and -out dates. Key value pairs:

start: Check-in date in YYYY-MM-DD format.

end: Check-out date in YYYY-MM-DD format.

Price

Price details for this offer or rate. Key value pairs:

Base: Base price before taxes and fees. Not returned by all suppliers.

TotalTaxes: Total taxes applied to the base price. Not returned by all suppliers.

TotalFees: Total fees included in Total Price.

TotalPrice: Total price of this offer including the base price and all taxes and fees.

Includes CurrencyCode and PriceBreakdown objects.

---

CurrencyCode

The currency code the amount is provided in. Key value pairs:

decimalPlace: Number of decimal places for this currency.

value: Three-character currency code.

---

PriceBreakdown

The information returned in PriceBreakdown can vary by provider and location. Key value pairs:

roomPricingType: A string provided by the hotel to describe the rate, such as per night or per stay.

priceChangesDuringStayInd: True indicates the price changes during requested dates; multiple instances of roomPricingType=per night are returned.

If roomPricingType = Per night, may include NightlyRate, AverageNightlyRate, and AmenitySurcharges objects.

If roomPricingType = Per stay, Description returns a rate description text string, e.g., Advance Purchase-Ro-Free WiFi..

May include Amount and Commission objects.

---

NightlyRate

Rate per night. Key value pairs:

startDate: Start date for the nightly rate in YYYY-MM-DD format.

nights: Number of nights the nightly rate is valid.

Includes Amount object.

---

Amount

The rate amount. Key value pairs:

Base: Base amount of the rate not including taxes or fees.

Total: Total for this group of nights.

Includes CurrencyCode (see above), Taxes, and Fees objects.

---

Taxes

Tax details.

TotalTaxes: Total of all taxes included in this rate.

Includes Tax and TaxPercent objects.

---

Tax

Breakdown of the tax. Key value pairs:

currencyCode: Three character currency code.

description: OTA description of tax.

purpose: Supplier returned description of tax.

includedInBase: Indicates whether tax is included in Amount/Base value. Possible values are Yes, No, Unknown.

taxCode: OTA code for the tax.

value: The amount of the tax

---

TaxPercent

Returned when the tax is expressed as a percentage of the amount. Key value pairs:

taxCode: Any code for the tax.

includedInBase: Indicates whether tax is included in the base amount. Possible values are Yes, No, or Unknown.

value: The tax percentage amount.

---

Fees

Fees may be included in the TotalPrice due separately at the property. Key value pairs:

TotalFees: Total fees included in the total price.

TotalAdditionalFeesPaidLocally: Fees due separately at the property. Expect them to be paid in local currency.

Includes Fee object.

---

Fee

Fee details. Key value pairs:

description: Hotel provider's text explanation of the fee, e.g. Resort Fee.

feeCode: Hotel provider's explanation of the fee; can be returned either as a code or as text.

feeApplication: How the fee is applied. Possible values are:

• PERPERSON
• PERROOM
• PERACCOMMODATION
• PERHOUSE
• PERAPARTMENT
• PERADULT

feeFrequency: The frequency of the fee. Possible values are:

• PERNIGHT
• PERDAY
• PERSTAY
• PERWEEK
• ROUNDTRIP
• ONEWAY

includedInBaseInd: Boolean. True indicates fee is included in Base Price.

includedInTotalPriceInd: Boolean. True indicates fee is included in Total Price.

Includes FeeAmountOrPercent object.

---

FeeAmountOrPercent

Defines whether the fee is charged as an amount or percentage. Key value pairs:

Amount: Returned if fee is charged as fixed amount.

code: Three-character currency code.

value: Exact amount of fee.

Percent: Returned if fee is charged as percentage of base amount.

---

Commission

Commission details. Returned with either @type CommissionPercent (commission is a percentage) or @type CommissionAmount (commission is a set amount).

When returned with @type CommissionPercent:

application: A value of Commissionable indicates the rate pays commission. Non-paying indicates no commission.

Percent: The commission percentage.

When returned with @type CommissionAmount:

application: A value of Commissionable indicates the rate pays commission. Non-paying indicates no commission.

Amount: Exact amount of commission paid for this booking.

code: Three-character currency code.

value: Numeric amount of commission.

---

AverageNightlyRate

The average nightly rate. Key value pairs:

code: Three-character currency code of amount.

approximateInd: true indicates this is a calculated value; false indicates this is the value returned by the property.

value: Numeric amount of average nightly rate.

---

AmenitySurcharges

Amenity surcharges detail. Includes Surcharge object.

---

Surcharge

Additional charges related to requested amenities. Key value pairs:

currencyCode: Three-character currency code.

description: Description of charge (e.g., Roll away Surcharge)

value: Surcharge amount.

TermsAndConditionsFull

Top level object for terms and conditions, instances of TermsAndConditionsFullHospitality.

RatePaymentInfo: Postpay or Prepay designation.

CustomerLoyaltyIDRequiredAtReservation: Boolean. True indicates the rate returned is contingent on a membership number, typically a frequent guest or frequent flyer loyalty number.

RateQualificationIDRequiredAtCheckIn: Boolean. True indicates the rate returned is contingent on qualification to be presented at check in at the property; guest must show proof of qualifying, typically an ID for government, military, workplace, association, or membership.

As returned from supplier, objects returned may include TextBlock, CustomerLoyalty, Guarantee, CancelPenalty, DepositPolicy, AcceptedCreditCard, Description, MealsIncluded, ProductRateCodeInfo, and CheckInOutPolicy.

---

TextBlock

Array. Each instance is one rule or set of information. Key value pair:

title: The title of the rule or information. May include any of the following Rule Types. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values.

Supported values:

• Promotional Data

• Rate Description

• Room Rate Data

• Rate Text

• Guarantee

• Cancellation

• Deposit

• Check in/out

• Room detail

• Extra charges

• Packages

• Property

• Location

• Miscellaneous

• Rate Amount

• Alternate Rate Amount

• Rate Comment

• FAX

• Phone

• Special Information

• Information

• Room Hold Expiration Time

Includes the TextFormatted object providing the rule or information itself.

---

TextFormatted

The rule or information itself. Key value pairs:

language: The language the rule is provided in.

value: The actual text of the hotel rule or information.

---

CustomerLoyalty

String. Indicates customer loyalty information. Key value pairs:

value: Number on loyalty card.

programId: For frequent guest number, the two-character hotel supplier or brand code. For frequent flyer number, the two-character air supplier code of the loyalty program.

supplierType: Returns hotel for frequent guest number or air or for frequent flyer number.

---

Guarantee

Array. Indicates if the room rate requires a guarantee to be booked. Key value pair:

guaranteeType: The type of guarantee. Supported values:

• PrepayRequired

• DepositRequired

• GuaranteesNotRequired

• Profile

• DepositNotRequired

• NoGuaranteesAccepted

• GuaranteeRequired

• CC/DC/Voucher

• PrepayNotRequired

• GuaranteesAccepted

• NoDepositsAccepted

---

CancelPenalty

Array. CancelPenalty breaks down any cancellation penalties for the rate. Key value pair:

Refundable: Yes indicate the rate is refundable. No indicates no refund is available for a cancellation.

Includes the Deadline and HotelPenalty objects.

---

Deadline

Cancellation penalty deadline details. Key value pair:

Time: The deadline time in 24-hour HH:MM:SS format.

Includes SpecificDate object.

---

SpecificDate

Details on cancellation penalty. Key value pairs:

specific: Specific cancellation date in YYYY-MM-DD format.

start: Date in YYYY-MM-DD format. Used with end to designate a date range.

end: Date in YYYY-MM-DD format.

---

HotelPenalty

Cancellation penalty amount. Key value pairs depend on the @type value:

When returned with @type HotelPenaltyNights:

subjectToTax: Indicator whether penalty amount is subject to taxes, either Yes, No, Unknown.

Nights: The number of nights charged at the nightly rate for the cancellation fee.

When returned with @type HotelPenaltyPercent:

Percent: Percentage of total amount to be charged as penalty.

appliesTo: Returned as Amount.

When returned with @type HotelPenaltyAmount:

Amount: Exact penalty amount.

code: Three-character currency code.

value: Penalty amount.

---

DepositPolicy

Deposit details related to this booking. Includes Deposit object.

---

Deposit

Deposit total. Key value pairs:

remainderInd: True indicates deposit was a portion of the total price.

Date: Date deposit must be received.

Includes CurrencyAmount object.

---

CurrencyAmount

Amount of deposit and the currency code for that amount. Key value pairs:

code: Currency code.

value: Deposit amount.

---

AcceptedCreditCard

An array of accepted credit cards. Key value pair:

value: Two-character credit card code.

---

Description

Free-form text for a room and rate description.

---

MealsIncluded

The following meal attributes are returned only if true:

breakfastInd: Breakfast is included.

lunchInd: Lunch is included.

dinnerInd: Dinner is included.

---

ProductRateCodeInfo

Top level object for rate code details. Includes RateCodeInfo.

---

RateCodeInfo

Rate code information. Key value pairs:

rateName: Name of the rate plan.

rateID: ID of the rate plan associated with the negotiated rate plan code.

value: The negotiated rate plan code.

rateCategory: OTA rate category code.

Possible values:

• Military

• Convention

• Credential

• Weekly

• Association

• All

• FamilyPlan

• Club

• Monthly

• RackGeneral

• FullInclusive

• Promotional

• Government

• Industry/TravelAgentRate

• PrePaid

• Weekend

• Corporate

• Mutli-DayPackage

• Tour

• Employee

• MultLevel/Negotiated/Secure

• Package

• Other

• Leisure

• VIP

• SeniorCitizen

---

CheckInOutPolicy

Check in and out times. Key value pairs:

checkInTime: Local property check in time in 24 hour clock format.

checkOutTime: Local property check out time in 24 hour clock format.

CurrencyRateConversion

Returned only if requestedCurrency sent in the request. By default the Hotel APIs return all rates in the currency of the hotel's location. If requestedCurrency was sent in the request, the response returns the currency conversion rate of the local currency to the requested currency. The response does not convert any amounts.

Includes SourceCurrency, TargetCurrency, and ConversionRate objects.

---

SourceCurrency

The currency code based on the location of the hotel and used for all rates in the response. Key value pairs:

decimalPlace: Number of decimal places.

value: Currency code.

---

TargetCurrency

Currency code sent in the request in requestedCurrency. Key value pairs:

decimalPlace: Number of decimal places.

value: Currency code.

---

ConversionRate

Conversion rate. Key value pair:

value: Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts.