Check the Hotel Release Notes for updates across all Hotel APIs.

Hotel Rules Reference Payload API Reference

POST

rules/offershospitality/buildfromcatalogofferings

Base path:

Use this base path if you have not yet received or not migrated to the new credentials from Travelport:

Pre-production https://api.pp.travelport.com/11/hotel/

Production https://api.travelport.com/11/hotel/

Use this base path after you have migrated to the new credentials from Travelport (using .net instead of .com):

Pre-production https://api.pp.travelport.net/11/hotel/

Production https://api.travelport.net/11/hotel/

Hotel Rules retrieves the rules associated with a specific rate. The reference payload references an offer by sending the unique offer ID from an Availability response, instead of sending all required offer details as in the full payload Rules request.

Request

Also see Authentication and Common Hotel API Headers.

Query Parameters

None.

Request Body

Show Request Body Table

Object	Description	Required/Optional
OfferQueryBuildFromCatalogOfferingsHospitality	Top level object for rules request. Includes BuildFromCatalogOfferingsRequest object.	Required
BuildFromCatalogOfferingsRequest	Top level object for offer ID. Includes ProductIdentifier object.	Required
ProductIdentifier	Top level object for offer identifier.	Required
id	Send the value from CatalogOffering/id from the Availability response for the offer to request rules for. Offers cached from the Availability response are stored for 15 minutes. If a rule with the offer ID is not requested within 15 minutes, you must send a new Availability request before a reference payload request.	Required

Response

Show Response Body Table

The top level objects in the Rules response are listed below. For details see the individual tables following.

Object	Description
OfferHospitalityResponse	Top level object for rules response. Includes Offer, Identifier, and CurrencyRateConversion objects.
Offer	Top level object for offer details. Includes Product, Price, and TermsAndConditionsFull objects. See the individual tables below for details.
Identifier	Defines which supplier system returned the rules for that rate. Key value pair: authority: Indicates which supplier returned the rules. Possible values are: TVPT: Travelport BKNG: Booking.com
CurrencyRateConversion	Currency conversion factor returned if requestedCurrency sent in the request. See table below.

Offer/Product object

Object	Description
Product	Array. One instance for each product, type ProductHospitality. Product is a common object in the model. Not all objects in this table may be returned in this specific API. 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, GuestCounts, 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 pair: 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 property. Key value pairs: phoneNumber: string. Accepted characters: numeric, dash, space, period. cityCode: IATA city code if referenced by phone number
GuestCounts	Object for number and type of guests.
GuestCount	Array describing guest details. Key value pairs: count: Numeric. Number of travelers. ageQualifyingCode: String. Required only if traveler age is relevant to a code. Adult code: 10 Child code: 8
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.

Offer/Price object

Object	Description
Price	Price details for this offer or rate. Price is a common object in the model. Not all objects in this table may be returned in this specific API. 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: The amount of the offer. Includes CurrencyCode and PriceBreakdown objects.
CurrencyCode	The currency code the amount is provided in. Key value pairs: decimalPlace: Decimal place number. 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: When set as true, expect multiple occurrences of roomPricingType (per night). If roomPricingType = Per night, May include NightlyRate, AverageNightlyRate, and AmenitySurcharges objects. If roomPricingType = Per stay, Description: 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. If the nightly rate changes during the stay, multiple NightlyRate objects are returned.
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	Parent object which can include Fee by rate or by property. Fees may be included in the TotalPrice or may be due separately at the property. Key value pair: 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: When 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. Default is false. Fee is included in Base Price. includedInTotalPriceInd: Boolean. Default is false. Fee is included in Total Price. Includes FeeAmountOrPercent object.
FeeAmountOrPercent	Object defining the amount or percent charged as a fee. Key value pairs: Amount: Amount object for a specific fee amount. code: Three-character currency code. value: Exact amount of fee. Percent: Percentage of base amount charged as a fee.
Commission	Commission details. Key value pairs: When returned with type: CommissionPercent: application: A value of Commissionable indicates the rate pays commission. Non-paying indicates no commission. Percent: Provides the commission percentage. When returned with type: CommissionAmount application: Same as above. Amount: Exact amount of commission paid for this booking. code: Three-character currency code. value: Numeric amount of commission.
AverageNightlyRate	The average nightly rate of the request. 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.

Offer/TermsAndConditionsFull object

Object	Description
TermsAndConditionsFull	Top level object for terms and conditions, instances of TermsAndConditionsFullHospitality. RatePaymentInfo: Postpay or Prepay designation. CustomerLoyaltyIDRequiredAtReservation: Boolean. Default is false. The rate returned is contingent on a membership number to be included within the sell request, typically associated to frequent guest or frequent flyer loyalty numbers. RateQualificationIDRequiredAtCheckIn: Boolean. Default is false. The discounted rate returned may be denied at the property if guest does not show proof of qualifying, typically a government/military/workplace/association/membership ID. As returned from supplier, may include TextBlock, CustomerLoyalty, Guarantee, CancelPenalty, DepositPolicy, AcceptedCreditCard, Description, MealsIncluded, ProductRateCodeInfo, and CheckInOutPolicy objects. TermsAndConditionsFull is a common object in the model. Not all objects in this table may be returned in this specific API.
TextBlock	Array. Each instance is one rule or set of information. Key value pair: title: The title of the rule or information. Can include any of the following Rule Types. Not every property returns all of these types. Some properties do not return any title. Note that currently only English is supported for these 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: Two character hotel supplier code or brand code of the loyalty program for frequent guest use. Two character air supplier code of loyalty program for frequent flyer use. supplierType: “hotel” for designating frequent guest or “air” for designating frequent flyer.
Guarantee	Array. Indicates if the room rate requires a guarantee to be booked. Key value pair: guaranteeType: The type of guarantee. The following are Guarantee types that may be returned: 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 or No values. 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 range of dates. end: Date in YYYY-MM-DD format.
HotelPenalty	Cancellation penalty amount. Attributes include: When returned with type: HotelPenaltyNights subjectToTax: Yes, No, or Unknown indicating if additional taxes may be applied to penalty amount. Nights: The number of nights charged at the nightly rate if provider charges a cancellation fee. When returned with type: HotelPenaltyPercent Percent: Percentage of total amount to be charged as penalty. appliesTo: Value of “Amount” will be returned. 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 in relation to TotalPrice. Key value pairs: remainderInd:true or false indicating if a deposit was part of the total price. Date: Date deposit must be received. Includes CurrencyAmount object.
CurrencyAmount	Object describing amount of deposit. Key value pairs: code: three character 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. This duplicates the room description in RoomType and the rate description in Price and will be removed in a future release.
MealsIncluded	The following meal attributes are returned and set to true if applicable: breakfastInd lunchInd dinnerInd
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. Values may be: 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	checkInTime: Local property check in time in 24 hour clock format. checkOutTime: Local property check out time in 24 hour clock format.

CurrencyRateConversion object

Object	Description
CurrencyRateConversion	CurrencyRateConversion is returned only if requestedCurrency was 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 currency conversion information per below. 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 for the currency value. value: Currency code.
TargetCurrency	Currency code sent in the request in requestedCurrency. Key value pairs: decimalPlace: Number of decimal places value: Currency code.
ConversionRate	Current conversion rate of the user-specified currency (the TargetCurrency value). 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.

Example Request

The example below shows the Hotel Rules reference payload request.

Show Example Request

{
  "OfferQueryBuildFromCatalogOfferingsHospitality": {
    "BuildFromCatalogOfferingsRequest": {
      "type": "BuildFromCatalogOfferingsRequest",
      "ProductIdentifier": [
        {
          "id": "86c995ca-2316-4576-9001-6314de9282c4:f72e307f-a792-4261-a3bc-4a8396bf81be"
        }
      ]
    }
  }
}

Example Response

Show Example Response

{
    "OfferHospitalityResponse": {
        "Offer": {
            "Product": [
                {
                    "type": "ProductHospitality",
                    "bookingCode": "N2DPRO",
                    "guests": 1,
                    "PropertyKey": {
                        "chainCode": "DA",
                        "propertyCode": "00638"
                    },
                    "RoomType": {
                        "type": "RoomTypeDetail",
                        "RoomCharacteristics": {
                            "wifiIncluded": "Yes",
                            "BedConfiguration": [
                                {
                                    "quantity": 1,
                                    "bedType": "Double",
                                    "size": "Double"
                                }
                            ]
                        },
                        "Description": {
                            "value": "Deluxe Double Room Double/Aircon/WiFi/Tea/Coffee/Flatscreen TV "
                        }
                    },
                    "DateRange": {
                        "start": "2022-03-19",
                        "end": "2022-03-22"
                    }
                }
            ],
            "Price": {
                "type": "PriceDetail",
                "CurrencyCode": {
                    "decimalPlace": 2,
                    "value": "GBP"
                },
                “Base”: 455.76,
                “TotalTaxes”: 34.24,
                "TotalPrice": 490.00,
                "PriceBreakdown": [
                    {
                        "type": "PriceBreakdownHospitality",
                        "roomPricingType": "Per night",
                        "NightlyRate": [
                            {
                                "startDate": "2022-03-19",
                                "nights": 3,
                                "Amount": {
                                    "CurrencyCode": {
                                        "decimalPlace": 2,
                                        "value": "GBP"
                                    },
                                    "Base": 151.92
                                }
                            }
                        ],
                        "AverageNightlyRate": [
                            {
                                "code": "GBP",
                                "approximateInd": true,
                                "value": 151.92
                            }
                        ]
                    },
                    {
                        "type": "PriceBreakdownHospitality",
                        "roomPricingType": "Per stay",
                        "Amount": {
                            ”type": "Amount",
                            "CurrencyCode": {
                                "decimalPlace": 2,
                                "value": "GBP"
                            },
                            "Base": 455.76,
                            “TotalTaxes”: 34.24,
                            “Total”: 490.00
                        }
                    }
                ]
            },
            "TermsAndConditionsFull": [
                {
                    "type": "TermsAndConditionsFullHospitality",
                    "TextBlock": [
                        {
                            "title": "Address",
                            "TextFormatted": [
                                {
                                    "language": "en",
                                    "value": "626 Chiswick High Road London Gb With4 5Ry "
                                }
                            ]
                        },
                        {
                            "type": "TextBlock",
                            "title": "Location",
                            "TextFormatted": [
                                {
                                    "language": "en",
                                    "value": "Location: "
                                }
                            ]
                        },
                        {
                            "type": "TextBlock",
                            "title": "Promotional",
                            "TextFormatted": [
                                {
                                    "language": "en",
                                    "value": "Thank You For Choosing Dalata Hotels "
                                }
                            ]
                        },
                        {
                            "type": "TextBlock",
                            "title": "Guarantee",
                            "TextFormatted": [
                                {
                                    "language": "en",
                                    "value": "Credit Cards: AX CA VI "
                                }
                            ]
                        },
                        {
                            "type": "TextBlock",
                            "title": "Cancellation",
                            "TextFormatted": [
                                {
                                    "language": "en",
                                    "value": "cancel 1 day by 2pm 1 night penalty."
                                }
                            ]
                        },
                        {
                            "type": "TextBlock",
                            "title": "Other",
                            "TextFormatted": [
                                {
                                    "language": "en",
                                    "value": "Minimum Length Of Stay 2 Nights Check In Time: 1400 Check Out Time: 1100 "
                                }
                            ]
                        },
                        {
                            "type": "TextBlock",
                            "title": "Room detail",
                            "TextFormatted": [
                                {
                                    "language": "en",
                                    "value": "Deluxe Double Room Double/Aircon/WiFi/Tea/Coffee/Flatscreen TV "
                                }
                            ]
                        },
                        {
                            "type": "TextBlock",
                            "title": "Fax",
                            "TextFormatted": [
                                {
                                    "language": "en",
                                    "value": "442089965201 "
                                }
                            ]
                        },
                        {
                            "type": "TextBlock",
                            "title": "Rate description",
                            "TextFormatted": [
                                {
                                    "language": "en",
                                    "value": "N3Dgrs Greatrate - Discounted Stays 2Los Save 12 Pct Breakfast Include "
                                }
                            ]
                        },
                        {
                            "type": "TextBlock",
                            "title": "Rate amount",
                            "TextFormatted": [
                                {
                                    "language": "en",
                                    "value": "15192 Person Night Starting 19 Mar For 3 Nights "
                                }
                            ]
                        },
                        {
                            "type": "TextBlock",
                            "title": "Property",
                            "TextFormatted": [
                                {
                                    "language": "en",
                                    "value": "Clayton Hotel Chiswick Property Opened: 01Jan06 Property Renovated: 01Jan06 Property Has 123 Rooms And 0 Suites On 7 Floors "
                                }
                            ]
                        },
                        {
                            "type": "TextBlock",
                            "title": "Room rate",
                            "TextFormatted": [
                                {
                                    "language": "en",
                                    "value": "Credit Card Guarantee Is Required Upon Booking. "
                                }
                            ]
                        },
                        {
                            "type": "TextBlock",
                            "title": "Phone",
                            "TextFormatted": [
                                {
                                    "language": "en",
                                    "value": "442089965200 "
                                }
                            ]
                        },
                        {
                            "type": "TextBlock",
                            "title": "Total Amount",
                            "TextFormatted": [
                                {
                                    "language": "en",
                                    "value": "45576 Sub Total For Stay 45576 Approx Total Include All Known Taxes/Fees "
                                }
                            ]
                        }
                    ],
                    "CancelPenalty": [
                        {
                            "Deadline": {
                                "SpecificDate": {
                                    "specific": "2022-01-18"
                                },
                                "Time": "14:00:00"
                            },
                            "HotelPenalty": {
                                ”type": "HotelPenaltyNights",
                                "subjectToTax": "Unknown",
                                "Nights": 1
                            },
                            "Refundable": "Yes"
                        }
                    ],
                    "AcceptedCreditCard": [
                        {
                            "value": "AX"
                        },
                        {
                            "value": "CA"
                        },
                        {
                            "value": "VI"
                        }
                    ],
                    "Description": [
                        "N3Dgrs",
                        "Greatrate - Discounted Stays",
                        "2Los Save 12 Pct Breakfast Include"
                    ],
                    "MealsIncluded": {
                        "breakfastInd": true
                    },
                    "CheckInOutPolicy": {
                        "checkInTime": "14:00:00",
                        "checkOutTime": "11:00:00"
                    }
                }
            ]
        },
        "ProductRateCodeInfo": [
            {
                "RateCodeInfo": {
                    "rateCategory": "Negotiated",
                    "rateName": ”Duran Trucking”,
                    "rateID": ”12343434”,
                    "value": ”DUR”
                }

    "Identifier": {
                    "authority": "TVPT"
                },
                "CurrencyRateConversion": [
                    {
                        "SourceCurrency": {
                            "decimalPlace": 2,
                            "value": "GBP"
                        },
                        "TargetCurrency": {
                            "decimalPlace": 2,
                            "value": "RON"
                        },
                        "ConversionRate": {
                            "value": 5.8868963604
                        }
                    }
                ]
            }
        }

Error Messages

Show Error Messages

SourceCode	StatusCode (HTTP code)	Message
	400	Not able to reach IDM Authorization atomic or Authorization cannot be identified due to insufficient inputs.
	401	Unauthorised user.
	404	BOOKING CODE IS NOT STORED ON ROOMMASTER
	404	VENDOR SYS ERR OCCURRED *
	500	OfferQueryHospitalityRequestxxx version: 11_2 nor any of its super class is known to this context.
	400	check in date missing
	400	Invalid format: "xxx"
	400	Invalid format: "2022-05-01 15:00" is malformed at " 15:00"
	400	Invalid format: "2022" is too short
	400	Check in Date cannot be before Current Date
	400	Cannot parse "2021-05-55": Value 55 for dayOfMonth must be in the range [1,31]
	400	Cannot parse "2021-55-01": Value 55 for monthOfYear must be in the range [1,12]
	400	check out date cannot be before or equal to check in date
	400	check out date missing
	404	CHECK OUT DATE BEYOND 332 DAYS INTO FUTURE
	404	INVALID-EXCEEDS 99 NT MAXIMUM
	400	Number of Guests is required field.
	400	Not a number: xxx
	400	Number of Guests should be between 1 and 9.
	400	Booking code is required field.
	400	property key missing
	400	Chain code is required field.
	400	Chain code is invalid, must be 2 alphabetic characters.
	400	Property code is required field.
	400	Property code is invalid, must be alphanumeric.
	404	No Properties Found.
	400	Hotel Aggregator is required for Multi Source Content.
	400	Booking code is invalid.
	404	Cannot find hotel offer with ID: xxx. Offer ID may be incorrect or offer has expired. Try performing availability again.
	400	OfferId is required field.
	400	Bad Request
	500	OfferQueryBuildFromCatalogOfferingsHospitalityxxx version: 11_1 nor any of its super class is known to this context.