Hotel Search by ID API Reference

POST	search/properties Base path: Pre-production https://api.pp.travelport.com/11/hotel/ Production https://api.travelport.com/11/hotel/

Related Content: Hotel Guide, Hotel Workflow Diagram, Hotel Search by Location API Reference

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 Authorization and Common Hotel API Headers.

Query Parameters

None.

Request Body

Show Request Body Table

Object	Description	Required/Optional
PropertiesQuerySpecificPropertyList	Top level object. Includes 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	Number. Number of travelers. Must be a numeric value between 1 and 9.	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	An array of up to 50 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
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.