Search by ID API Reference

PropertiesQuerySpecificPropertyList*

Top level object. Includes RoomStayCandidate, PropertyKey, and RateCandidates object.

checkinDate*: Check-in date in YYYY-MM-DD format.

checkoutDate*: Check-out date in YYYY-MM-DD format.

AggregatorList: Restrict the search to a specific aggregator. Accepted values are:

• TVPT Travelport

• BKNG Booking.com

You must be authorized for any aggregator selected.

numberOfGuests*: Number. Total number of travelers. Must be a numeric value between 1 and 9.

Required; send with same value as the total across all counts in RoomStayCandidate/GuestCount/count below.

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.

ImageSize: String. A size for the image to return, allowing you to set image quality. Supported values:

• ExtraLarge

• Large

• Medium

• Small

• Thumbnail

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.

---

RoomStayCandidate*

Top level object for information associated with room searches. Includes GuestCounts object.

---

GuestCounts*

Top level object for guest counts. Includes GuestCount object.

---

GuestCount*

Guest count and age(s).

count*: Number. Number of travelers. Must be a numeric value between 1 and 9.

age: Integer. Age of traveler. Required only when request includes a child in room.

ageQualifyingCode: String. Required only for children or if traveler age is relevant, such as for a senior discount. Supported values and meanings:

• 10: Traveler in this GuestCount is an adult

• 8: Traveler in this GuestCount is a child

---

PropertyKey*

An array of up to 250 PropertyKey objects. Each PropertyKey object identifies a property to search.

propertyCode*: String. Code for the property within the hotel chain.

chainCode*: String. Two-character code for the chain to search.

---

RateCandidates

An array of one to eight negotiated rate codes and / or one frequent guest number. Includes RateCandidate object.

---

RateCandidate

Rate plan details and/or frequent guest number, if requesting. Includes CustomerLoyalty object.

rateCode: String. Negotiated rate code.

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. Refer to the OAS (aka Swagger) files provided by Travelport for exact spelling. Travelport translates the category of “All” into the category set of Promotional, Package, Senior Citizen, Family Plan, Weekend, Association, Corporate, Government.

rateCategory supported values

• 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

---

CustomerLoyalty

String. One frequent guest number.

supplier: String. Two character hotel supplier code or brand code of the loyalty program.

value: String. Number on loyalty card.

 

Example search by property ID

{
 "PropertiesQuerySpecificPropertyList": {
  "checkinDate": "2025-10-16",
  "checkoutDate": "2025-10-17",
  "AggregatorList": [
   "TVPT"
  ],
  "RoomStayCandidates": {
   "RoomStayCandidate": [
    {
     "@type": "RoomStayCandidate",
     "GuestCounts": {
      "@type": "GuestCounts",
      "GuestCount": [
       {
        "@type": "GuestCount",
        "count": 1,
        "age": 26,
        "ageQualifyingCode": "10"
       }
      ]
     }
    }
   ]
  },
  "PropertyKey": [
   {
    "@type": "PropertyKey",
    "chainCode": "HI",
    "propertyCode": "17424"
   },
   {
    "@type": "PropertyKey",
    "chainCode": "UR",
    "propertyCode": "G3375"
   }
  ]
 }
}