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

Hotel Rules Full Payload API Reference

POST

rules/offershospitality/buildfromrequest

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 full payload request sends all required offer details, while the reference payload Rules request references an offer by sending the unique offer ID from an Availability response.

Request

Also see Authentication and Common Hotel API Headers.

Query Parameters

None.

Request Body

Show Request Body Table

Object	Description	Required/Optional
OfferQueryHospitalityRequest	Top level object for rules request. Includes PropertyKey object.	Required
bookingCode	String. For the offer you want to request rules for, send the value from that offer in CatalogOffering/ProductOptions/Product/bookingCode from the Availability response.	Required
checkinDate	String. Check-in date in YYYY-MM-DD format.	Required
checkoutDate	String. Check-out date in YYYY-MM-DD format.	Required
numberOfGuests	Number. Number of travelers. Must be a numeric value between 1 and 9.	Required
storedAmount	String. For the offer you want to request rules for, send the value from that offer in CatalogOffering/Price/totalPrice from the Availability response.	Required
storedCurrency	String. Send the value from CatalogOffering/Price/CurrencyCode/value from the Availability response.	Required
HotelAggregator	String. Identifies the source of the rate. Send the value from CatalogOffering/Identifier/authority for the offer from the Availability response. Must be one of the following values: Travelport Expedia Booking.com Booking.com and Expedia access require additional provisioning and a direct agreement with the supplier. Please contact your Travelport Account Manager for details.	Required
requestedCurrency	String. Send the currency code to return a conversion rate for. Rates are always returned in the currency of the hotel's location. You can use requestedCurrency to send a currency to request conversion rate information for. The response then returns the CurrencyRateConversion object, which provides the conversion rate of the specified currency that can be used to calculate, independently of the API, the conversion of the rates returned in the response.	Optional
PropertyKey	Property ID information. Includes the RateCandidate object.	Required
propertyCode	String. Code for the property within the hotel chain.	Required
chainCode	String. Two-character code for the chain to search.	Required
RateCandidate	Rate plan details returned for the offer to request rules for as follows, if returned in the Availability response.	Required when returned in the Availability response
rateCode	String. Send the value from ProductRateCodeInfo/RateCodeInfo/value	Required when returned in the Availability response
rateID	String. Send the value from ProductRateCodeInfo/RateCodeInfo/rateID	Required when returned in the Availability response
rateCategory	String. Send the value from ProductRateCodeInfo/RateCodeInfo/rateCategory	Optional
chainCode	String. Two-character chain code for the property.	Required if RateCandidate requested.
propertyCode	String. Property code for the property.	Required if RateCandidate requested.
RoomStayCandidates	Top level object for traveler information. Includes RoomStayCandidate object.	Required if children are part of the request.
RoomStayCandidate	Top level object. Includes GuestCounts object.	Required if children are part of the request.
GuestCounts	Top level object. Includes GuestCount object.	Required if children are part of the request.
GuestCount	Array of qualifying codes and ages.	Required if children are part of the request.
count	Number. Number of travelers.	Required if using GuestCount object.
ageQualifyingCode	String. Required only if traveler age is relevant to a code. Adult code: 10 Child code: 8	Required if using GuestCount object.
age	String. Age of traveler. Required only when request includes a child in room.	Required for the children in the request.

Response

The response for the Rules Full Payload request is identical to the response for the reference payload request. See the Rules Reference Payload API Reference for the response table and examples.

Example Request

Show Example Request

{
  "OfferQueryHospitalityRequest": {
    "bookingCode": "N2DPRO",
    "requestedCurrency": "RON",
    "checkinDate": "2022-03-19",
    "checkoutDate": "2022-03-22",
    "numberOfGuests": 1,
    "storedAmount": "660.00",
    "storedCurrency": "GBP",
    "HotelAggregator": "Travelport",
    "PropertyKey": {
      "type": "PropertyKey",
      "chainCode": "DA",
      "propertyCode": "00638"
    }
  }
    "RateCandidate": [
              {
      "type": "RateCandidateDetail",
      "rateCode": "DUR",
      "chainCode": "BR",
      "propertyCode": "33722",
      "rateID": "12343434"
      }
    ]
}

Example Response

The response for the Rules Full Payload request is identical to the response for the reference payload request. See the Rules Reference Payload API Reference.

Error Messages

See the Rules Reference Payload API Reference.