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

Hotel Search by ID API Reference

POST

search/properties

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/

The Hotel Search by ID request searches for hotels by one or more property IDs. The response returns a list of properties based on the ID/s sent, and is in the same format as the response for Hotel Search by Location.

Request

Also see Authentication and Common Hotel API Headers.

Query Parameters

None.

Request Body

Show Request Body Table

Object	Description	Required/Optional
PropertiesQuerySpecificPropertyList	Top level object. Includes RoomStayCandidate, PropertyKey and RateCandidates object.	Required
checkinDate	Check-in date in YYYY-MM-DD format.	Required
checkoutDate	Check-out date in YYYY-MM-DD format.	Required
numberOfGuests Please use RoomStayCandidate instead.	Number. Number of travelers. Must be a numeric value between 1 and 9. Though numberOfGuests is still supported, the preferred guest object to code to is RoomStayCandidate to correctly handle children in room booking.	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
ImageSize	String. A size for the image to return, allowing you to set image quality. The following values are accepted: ExtraLarge Large Medium Small Thumbnail	Optional
returnAllImagesInd	Element to distinguish between requesting one or all images for each property returned in the response. Boolean values of true/false. Default when missing in request is false.	Optional
AggregatorList	Restrict the search to a specific aggregator. Accepted values are: TVPT Travelport BKNG Booking.com EXPE Expedia User must be authorized for any aggregator selected.	Optional
RoomStayCandidate	Top level object for information associated with room searches. Includes GuestCounts object.	Required
GuestCounts	Top level object for guest counts. Includes GuestCount object.	Required
GuestCount	Guest count and age(s).	Required
count	Number. Number of travelers. Must be a numeric value between 1 and 9.	Required
age	Age of traveler. Required only when request includes a child in room.	Optional
ageQualifyingCode	Required only if traveler age is relevant to a code.	Optional
PropertyKey	An array of up to 25 PropertyKey objects. Each PropertyKey object identifies a property to search.	Required
propertyCode	String. Code for the property within the hotel chain.	Required
chainCode	String. Two-character code for the chain to search.	Required
RateCandidates	An array of one to eight negotiated rate codes and / or one frequent guest number. Includes RateCandidate object.	Optional
RateCandidate	Rate plan details and/or frequent guest number, if requesting. Includes CustomerLoyalty object.	Optional
rateCode	String. Negotiated rate code.	Optional
masterRateCode	String. An agency-created rate code that can be translated into up to 12 negotiated rate codes.
rateCategory	For a rate category, send one or up to 8 rate categories to search for, such as Weekend or Government. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Note that some properties do not return these rates unless explicitly requested. Categories are spelled for readability in this document. Please consult the swagger file for exact spelling. Travelport translates the category of “All” into the category set of Promotional, Package, Senior Citizen, Family Plan, Weekend, Association, Corporate, Government. Supported values are as follows: All Association Club Convention Corporate Family Plan Government Military Multi-level/Negotiated/Secure Package Promotional Rack General Senior Citizen Tour Industry/Travel Agent Rate Weekend Multi-day Package Weekly Monthly	Optional
CustomerLoyalty	String. One frequent guest number.	Optional
supplier	String. Two character hotel supplier code or brand code of the loyalty program.	Optional
value	String. Number on loyalty card.	Optional

Response

The response for the Hotel Search by ID request is in the same format as the response for Hotel Search by Location; see the Search by Location API Reference.

Example Request

Show Example Request

The example below sends three property IDs to search. All objects except requestedCurrency are required.

{
  "PropertiesQuerySpecificPropertyList": {
    "checkinDate": "2021-04-01",
    "checkoutDate": "2021-04-04",
    "numberOfGuests": "1",
    "requestedCurrency": "INR",
    "PropertyKey": [
      {
        "propertyCode": "A5748",
        "chainCode": "HI",
        ”type": "PropertyKey"
      },
      {
        "propertyCode": "47194",
        "chainCode": "CY",
        ”type": "PropertyKey"
      },
      {
        "propertyCode": "81388",
        "chainCode": "HY",
        ”type": "PropertyKey"
      }
    ]
  }
}

Example Response

The response for the Hotel Search by ID request is in the same format as the response for Hotel Search by Location; see the Search by Location API Reference.

Error Messages

See the Search by Location API Reference for error messages.