SearchComplete API Reference

POST

search/searchcomplete

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/12/hotel | Production https://api.travelport.com/12/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/12/hotel/ | Production https://api.travelport.net/12/hotel/

Note the 12 in SearchComplete, which is on model version 12.

Related Content: JSON Hotel APIs Guide, Hotel Search Guide, SearchComplete Pagination API Reference

JSON Hotel SearchComplete is not yet available as a general release. All details in this documentation are for informational purposes only and subject to change until General Availability release, which will be communicated in advance via a Travelport Developer Advisory.

The JSON Hotel APIs offer three APIs for hotel searches. SearchComplete combines into a single API the information that in the Search v11 workflow is returned in separate search, details, and availability requests.

SearchComplete provides several optional filters that you can use to specify the type of results to return. You can filter by property criteria, room characteristics, and/or rate details. This topic lists all filters and how to implement them, while the Hotel Search Guide provides a detailed usage description.

Regardless of the criteria in the search, all responses return results in the same format. Individual hotel properties matching the search criteria are returned as an array of propertyItems objects. The response returns up to 100 properties, or all requested properties if less than 100. If more than 100 properties matching the search criteria are found, you can request the next pages of results with the SearchComplete Pagination API. See the JSON Hotel APIs Guide for more about pagination.

SearchComplete uses ODMClosed Open Data Model. ODM is an open source, object-oriented data model developed by Open Travel, a cross-sector technology alliance for the travel community. The JSON APIs are based on the ODM model using either version 11 or version 12. See the JSON Hotel APIs Guide for details. version 12, and is referred to as a v12 API. SearchComplete and SearchComplete Pagination are the only Hotel APIs on model v12. After these requests, you continue the workflow with v11 APIs: Proceed directly to booking using v11 Create Reservation, either the full payload or reference payload request. Optionally, before booking, you can use the v11 Hotel Rules API to request rules for any rate.

For more, see the sections on API Versions and Workflows in the JSON Hotel APIs Guide.


Request

As part of the request requirements, also see Authentication and Common Hotel API Headers.

Query Parameters

None.

Request Body - Search Complete with optional filters

The example searches for a hotel by IATA city code. Additional examples are provided below.

The red asterisk at the end of an object name below, as in Traveler*, marks that object as required in the request.

excludeResponseFields

String. Exclude the specified fields from the response.

Supported values:

  • roomTypes

  • roomRates


requestedCurrency

String. Three-character currency code.

Used to request conversion rate information. The response will return the currencyRateConversion object, which will contain the conversion rate of the requested currency.


stayDetails*

Top-level object for basic search criteria. Properties:

checkInDateLocal* : String. The local date the guest will check in. Format: YYYY-MM-DD

checkOutDateLocal* : String. The local date the guest will check out. Format: YYYY-MM-DD

rooms*: Number. Number of rooms requested. Default is 1.

Includes guests and extraAccommodations objects.


guests*

Sends guest types and counts. Requires at least one adult key value pair and may include children object.

adults* : Integer. Number of adults staying in the property.


children*for child traveler

Required when children are part of the booking.

age*for child traveler  Integer. When children object is sent, must also send age with the value of the child's age. Send multiple instances of age to indicate multiple children.


extraAccommodations

Send to request extra accommodations, such as a crib.

quantity* with extraAccommodations: Integer. Number of accommodations needed.

accommodationType* with extraAccommodations: The type of accommodation requested. Supported values:

  • Crib

  • ExtraAdult

  • ExtraChild

  • RollawayAdult

  • RollawayChild


propertyFilter*

Top level object for filtering the properties you want returned.

Includes location, aggregators, propertyKeys, chainCodes, propertyType, amenityCategories, customerLoyaltyCards, hotelNameContains, negotiatedRates, privateRateType, returnOnlyAvailableProperties, imageSize, returnAllImageURLs, returnRateSummaryInfo, recommendedPropertyAmenitiesInd, removeSpecialRates, applyLenientPropertyListRules, categories.

maxWaitTime: Integer. Maximum wait time for the property to respond in milliseconds.


location*

Filter hotels by location or a specific property ID.

@type*: Indicates the type of location for the search. Supported values:

  • coordinates

  • cityIATACode

  • airportIATACode

  • address

details*: Depending on the @type value sent, use the corresponding property below to send details about the search location. The details for one type of property is required.

  • latitude: Number. The latitude of the location. Required when @type is coordinates.

  • longitude: Number. The longitude of the location. Required when @type is coordinates.

  • iataCode: String. IATA code of a city or airport. Required when @type is cityIATACode or airportIATACode.

  • cityName: String. Name of the city. Required when @type is address.

  • stateProvince - String. The state or province of the location.

  • countryCode: String. ISO 3166 code for a country.

radius* for value: Radius of the search location. Includes the properties:

  • value - Integer. Radius from location.

  • unit - Unit of distance. Supported values: km, mi


aggregators

String. List of aggregators to be returned in the response. TVPT is mandatory and will always be returned in the result set. Supported values: 

  • TVPT for Travelport

  • BKNG for Booking.com


propertyKeys

Used to filter results by a specific property.

chainCode* when authority = TVPT is not populated. String. Chain code of the property. Chain code is a required property when authority is not populated or set to TVPT.

propertyCode: String. Property code to return.

authority: String. The authority to apply the property keys. Default is TVPT.

Includes chainCode, propertyCode, and authority.


chainCodes: String. Brand codes or chain codes to filter properties in the search location.


propertyType: String. List of property types to return in the response.


amenityCategories

Top level object for the category of amenities.

AmenityCategory: String. Specify the amenities that you want the hotels in the response to have.


customerLoyaltyCards

Top level object for specifying the account ID and supplier for membership programs.

value* if customerLoyaltyCards is sent : String. The customer loyalty card number or email address.

supplierCode* if customerLoyaltyCards is sent : String. Supplier code of the loyalty program

supplierType : String. The type of supplier of a loyalty program, for example, Air, Hotel, or Aggregator.


hotelNameContains

String. Send part of the hotel name to filter results.


negotiatedRates

Top level object to return negotiates rates in the response.

rateCodes : Array of negotiated rate codes

masterRateCode : String. A master rate code.

Includes rateCodes and masterRateCode.


privateRateType

Top level object to specify negotiated rate codes to obtain private rates.

negotiatedCodes : Array of negotiated rate codes

consortiaCodes : Array of consortia rate codes

tmcCodes : Array of TMC rate codes

categories : String. Category of rates for the private rate code.

Contains negotiatedCodes, consortiaCodes, tmcCodes, categories, and masterRateCode.

masterRateCode : String. A master rate code.


returnOnlyAvailableProperties : Boolean. When true, only properties with availability will be returned in the response.


imageSize : String. The size of the images to be returned. Supported values:

  • Large

  • Medium

  • Small

  • Thumbnail

  • ExtraLarge


returnAllImageURLs : Boolean. When true, all image URLs are returned in the response.


returnRateSummaryInfo : Boolean. When true, the rate summary is returned in the payload response.


recommendedPropertyAmenitiesInd : Boolean. When true, a limited set of property amenities will be returned in the response. If false or omitted, a full set of property amenities are returned in the response.


removeSpecialRates : Boolean. When true, special rate category rates are removed from the response.


applyLenientPropertyListRules : Boolean. When true, properties are returned by distance from location. Some properties in the list will not support any of the negotiated rates in the request.


categories : String. Category of rates.

Example hotel search by IATA city code

{
 "stayDetails": {
  "checkInDateLocal": "2025-10-01",
  "checkOutDateLocal": "2025-10-03",
  "rooms": 1,
  "guests": {
   "adults": 1
  }
 },
 "propertyFilter": {
  "location": {
   "type": "cityIATACode",
   "details": {
    "iataCode": "DEN"
   },
   "radius": {
    "value": 1,
    "unit": "km"
   }
  }
 }
}

Request Body - Search Complete with optional filters

requestedCurrency - minimum base request payload

requestedCurrency : String. Send the code for the currency in which to return search result pricing.


returnCompleteNightlyRateBreakdown : Boolean. Default is false. If true, the base, total taxes, and total fees are returned in nightlyRatesBreakdown.


stayDetails*

Top-level object for basic search criteria.

Includes guests object.

checkInDateLocal* : String. The local date the guest will check in. Format: YYYY-MM-DD

checkOutDateLocal* : String. The local date the guest will check out. Format: YYYY-MM-DD

rooms* : Number of rooms requested. Default is 1.


guests*

Object for guest types and counts.

May include adults and children objects.

adults* : Number of adults staying in the room.

children : Array of children ages.

age* if children are included in the reservation request : Number. Age(s) of children staying in the room.


propertyFilter

Top-level object for search modifiers based on property characteristics. See propertyFilter below.


roomFilter

Top-level object for search modifiers based on room characteristics. See roomFilter below.


rateFilter

Top-level object for search modifiers based on rate characteristics. See rateFilter below.


propertyFilter - optional object for sending search modifiers based on property characteristics

roomFilter - optional object for sending search modifiers based on room characteristics

rateFilter - optional object for sending search modifiers based on rate characteristics

Example hotel search by city code with optional filters

{
"requestedCurrency": "EUR",
    "stayDetails": {
        "checkInDateLocal": "2025-10-30",
        "checkOutDateLocal":  "2025-10-31",
        "rooms": 1,
        "guests": {
            "adults":1,
            "children": [
                {
                    "age": 2
                }
            ]
        }
    },
    "propertyFilter": {
        "maxWaitTime": 5000,
        "location": {
            "type": "cityIATACode",
            "details": {
                "iataCode": "LON"
            },
            "radius": {
                "value": 40,
                "unit": "km"
            }
        },
        "chainCodes": [
            "HL",
            "EM",
            "HY",
            "DA",
            "RT",
            "HH"
        ],
        "customerLoyaltyCards": [
            {
                "value": "132456",
                "supplierCode": "HL",
                "supplierType": "Hotel"
            }
        ],
        "hotelNameContains": "hotel",
        "negotiatedRates": {
            "rateCodes": [
                "LOREAL",
                "IBM",
                "GEE",
                "ABC"
            ],
            "masterRateCode": "1ABC23"
        },
        "returnOnlyAvailableProperties": true,
        "imageSize": "Large",
        "returnAllImageURLs": false,
        "recommendedPropertyAmenitiesInd": true,
        "removeSpecialRates": true,
        "categories": [
            "Military",
            "Weekend",
            "Club"
        ]
    },
    "roomFilter": {
        "nonSmoking": true,
        "balcony": true,
        "accessible": true,
        "connecting": true,
        "family": true,
        "bedConfiguration": {
            "minimumQuantity": 1,
            "type": "King"
        },
        "amenityCodes": [
            2,
            7,
            11
        ],
        "recommendedRoomAmenitiesInd": true
    },
    "rateFilter": {
        "rateFlags": {
            "refundable": true,
            "commissionable": true,
            "deposit": true,
            "prepay": true,
            "postpay": true,
            "breakfast": true,
            "lunch": true,
            "dinner": true
        },
        "publicRateBlacklist": [
            "Gold"
        ]
    },
    "returnCompleteNightlyRateBreakdown": true
}

Response

The response for all SearchComplete requests uses the same structure, regardless of the search criteria sent.

The following example has been edited for readability to return only one instance of several objects that would typically return many more instances. PropertyItems has been edited to return only 1 instance but could return up to 100. Within that single instance of PropertyItems, roomTypes was edited to show only one instance and would typically return many more. Within that single instance of roomTypes, rates was edited to show only two instances, and typically many more rates would be returned for a room type. The response remains a complete response and shows at least one instance of all objects that would typically be returned in a SearchComplete response. Although SearchComplete responses can exceed 500,000 lines, the edited example below is less than 800 lines long.

Base response structure

traceId

Identifier used to correlate API invocations across long-running or multi-call business flows. Customer created.


transactionId

Unique transaction, correlation, or tracking identifier for a single request and response, i.e. for a single transaction. Also known as E2ETrackingId.


pagination

Object describing the paging method used for this response. Properties:

page: Number of the current page.

pageSize: Number of items per page.

totalPages: Number of total pages.

totalItems: Number of total items.

paginationToken: The token used to retrieve the next page. This token is not returned if fewer than 100 properties are returned.


hotelsResponse

Object containing all information for the properties, rooms, and rates for this transaction. Properties:

checkInDateLocal: The local date the guest will check in.

checkOutDateLocal: The local date the guest will check out.

Includes the searchPoint and propertyItems objects.


searchPoint

Object containing the resolved geocode of search by location request. Properties:

latitude: The latitudinal coordinates. May be negative.

longitude: The longitudinal coordinates. May be negative.


propertyItems

Array. Each instance is a unique property. Properties:

name: Name of the property.

brandCode: The brand code of the property.

chainCode: The chain code of the property.

propertyCode: The unique property ID of the property. Travelport creates a unique five-character alphanumeric property ID for each property.

estimatedPropertyType: The type of property using OTA definitions supported by Travelport.

longDescription: The detailed description of the property.

knowBeforeYouGo: Helpful information provided by the property.

availability: Boolean. If true, the property has availability. If false, property does not have availability matching your request.

Includes the dataQualitySummaryScore, lastSeenAvailable, availabilityNotes, lowestPublicAvailableRate, lowestPrivateAvailableRate, lowestFilteredPublicAvailableRate, lowestFilteredPrivateAvailableRate, lowestUnfilteredPublicAvailableRate, lowestUnfilteredPrivateAvailableRate, propertyInfo, rateSummary, and roomTypes objects.


dataQualitySummaryScore

Top level object of summary quality scores evaluated for a property and its rooms and rates.

Includes the propertySummary object.


propertySummary

All summary level quality scores for a property and its rooms and rates. Properties:

merchandisingQualityScore: Integer between 0 and 100. A score representing the overall quality of property, room, and rate information to allow comparison between properties.

propertyContentQualityScore: Integer between 0 and 100. A score that measures important components of the property object.

averageVendorRateQualityScore: Integer between 0 and 100. An average score of all vendorRateQualityScores for this property in this transaction, rounded.

averageAugmentedRateQualityScore: Integer between 0 and 100. An average score of all augmentedRateQualityScores for this property in this transaction, rounded.

averageVendorRoomQualityScore: Integer between 0 and 100. An average score of all vendorRoomQualityScores for this property in this transaction, rounded.

averageAugmentedRoomQualityScore: Integer between 0 and 100. An average score of all augmentedRoomQualityScores for this property in this transaction, rounded.


lastSeenAvailable

Array. Shows when the different rate types were last seen available. Properties:

authority: The authority of the rate type last seen available

publicRates: The date and time the public rates were last seen available

negotiatedRates: The date and time the negotiated rates were last seen available

geniusRates: The date and time the genius rates were last seen available


availabilityNotes

Array. Returned when the property is not available. Properties:

authority: The authority from where the availability note originates.

Supported values:

  • TVPT

  • BKNG

message: The body of the availability note, maximum 512 characters.


lowestPublicAvailableRate

The lowest public available rate according to the requested filters. If exact match is not found for the requested filters, the generic lowest public rate will be returned. See lowestAvailableRate table below.

lowestPublicAvailableRate is marked for deprecation and will be removed in a future version.

lowestPrivateAvailableRate

The lowest private available rate according to the requested filters. If exact match is not found for the requested filters, the generic lowest private rate will be returned. See lowestAvailableRate table below.

lowestPrivateAvailableRate is marked for deprecation and will be removed in a future version.

lowestFilteredPublicAvailableRate

The lowest public available rate according to the requested filters. If exact match is not found for the requested filters, it will not be populated. See object breakdown below.


lowestFilteredPrivateAvailableRate

The lowest private available rate according to the requested filters. If exact match is not found for the requested filters, it will not be populated. See object breakdown below.


lowestUnfilteredPublicAvailableRate

The lowest unfiltered public available rate. See lowestAvailableRate table below.


lowestUnfilteredPrivateAvailableRate

The lowest unfiltered private available rate. See lowestAvailableRate table below.


propertyInfo

Property specific information. See propertyInfo table below.


rateSummary

A summary of private and negotiated rates returned in the hotel response. See rateSummary table below.


roomTypes

Detailed information of each room type provided by this property. See roomTypes table below.


lowestAvailableRate objects (lowestFilteredPublicAvailableRate, lowestFilteredPrivateAvailableRate, lowestUnfilteredPublicAvailableRate, and lowestUnfilteredPrivateAvailableRate, lowestPublicAvailableRate, lowestPrivateAvailableRate)

All of these objects include the objects in the table below. The only difference is in what the amounts and other details apply to: the lowest filtered public available rate, lowest filtered private available rate, and so on.

lowestPublicAvailableRate and lowestPrivateAvailableRate are marked for deprecation and will be removed in a future version.



 

Example response SearchComplete

{
 "traceId": "05f75ed0-a3a3-43e5-bc49-9c704eb28279",
 "transactionId": "3fe59112-1684-456b-a662-5775622be830",
 "pagination": {
  "page": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalItems": 1
 },
 "hotelsResponse": {
  "searchPoint": {
   "latitude": 42.8843,
   "longitude": -85.5305
  },
  "checkInDateLocal": "2025-10-30",
  "checkOutDateLocal": "2025-10-31",
  "propertyItems": [
   {
    "name": "Holiday Inn Exp Stes Airport N",
    "brandCode": "6C",
    "chainCode": "HI",
    "propertyCode": "E2310",
    "estimatedPropertyType": "Hotel",
    "longDescription": "HOLIDAY INN EXPRESS GRAND RAPIDS AIRPORT HOTEL PROVIDES QUALITY AND COMFORT.",
    "knowBeforeYouGo": "Guests are required to show a photo identification and credit card upon check-in. Please note that all Special Requests are subject to availability and additional charges may apply. .",
    "dataQualitySummaryScore": {
     "propertySummary": {
      "merchandisingQualityScore": 79,
      "propertyContentQualityScore": 75,
      "averageVendorRateQualityScore": 40,
      "averageAugmentedRateQualityScore": 82,
      "averageVendorRoomQualityScore": 56,
      "averageAugmentedRoomQualityScore": 81
     }
    },
    "availability": true,
    "lowestPublicAvailableRate": {
     "totalPrice": {
      "amount": 129.8
     },
     "base": {
      "amount": 110
     },
     "totalTaxes": {
      "amount": 19.8
     },
     "averageNightlyTotalPrice": {
      "amount": 129.8
     },
     "averageNightlyBase": {
      "amount": 110
     },
     "averageNightlyTotalTaxes": {
      "amount": 19.8
     },
     "currencyCode": "USD",
     "rateKey": {
      "value": "7ae97cfd8dd77ee62c263e7d3ebab12dfd80c405302b494e7abdb2c3fde7bf9d:0e7a75ef6a89e01c87d22db348cfd2e1",
      "authority": "TVPT"
     },
     "rateCodeInfo": {
      "rateCategoryCode": 13,
      "rateType": "Public",
      "rateClassificationCode": 3
     },
     "shortRoomDescription": "1 King Bed(s) Room",
     "terms": {
      "ratePaymentInfo": "PrePay",
      "guaranteeType": "DepositRequired",
      "customerLoyaltyIDRequiredAtReservation": false,
      "rateQualificationIDRequiredAtCheckIn": false,
      "refundable": false,
      "cancelPenalties": [
       {
        "deadlineLocal": "2025-09-30T00:00:00-04:00",
        "cancelShortDescription": "A standard estimated cancellation fee of 129.80 USD applies starting from 2025-09-30T00:00-04:00[America/Detroit] (estimated). Cancel policy may be more restrictive based on rate / room booked, season or special events. Please use the rule API to confirm.",
        "penalty": {
         "estimatedAmount": true,
         "currencyAmount": {
          "amount": 129.8,
          "currency": "USD"
         },
         "originalPenaltyInfo": "1 Night"
        }
       }
      ],
      "description": [
       "Book Early Advance Purchase",
       "1 King Standard 247 Square Feet Room With Microwave",
       "And Minifridge"
      ]
     }
    },
    "lowestPrivateAvailableRate": {
     "totalPrice": {
      "amount": 147.65
     },
     "base": {
      "amount": 125.13
     },
     "totalTaxes": {
      "amount": 22.52
     },
     "averageNightlyTotalPrice": {
      "amount": 147.65
     },
     "averageNightlyBase": {
      "amount": 125.13
     },
     "averageNightlyTotalTaxes": {
      "amount": 22.52
     },
     "currencyCode": "USD",
     "rateKey": {
      "value": "7ae97cfd8dd77ee62c263e7d3ebab12dfd80c405302b494e7abdb2c3fde7bf9d:7010c5c3aa609d7d41f88d3c8b692e15",
      "authority": "TVPT"
     },
     "rateCodeInfo": {
      "rateCode": "THR",
      "ratePlanID": "THORPREFERRED",
      "rateCategory": "MultiLevel/Negotiated/Secure",
      "rateCategoryCode": 10,
      "rateType": "Private",
      "rateClassificationCode": 13
     },
     "shortRoomDescription": "1 King Bed(s) Accessible Room",
     "terms": {
      "ratePaymentInfo": "PrePay",
      "guaranteeType": "DepositRequired",
      "customerLoyaltyIDRequiredAtReservation": false,
      "rateQualificationIDRequiredAtCheckIn": false,
      "refundable": true,
      "cancelPenalties": [
       {
        "deadlineLocal": "2025-10-30T18:00:00-04:00",
        "cancelShortDescription": "Cancellations are free if made before 2025-10-30T18:00-04:00[America/Detroit], after this time, an estimated cancellation fee of 147.65 USD applies.",
        "penalty": {
         "estimatedAmount": true,
         "currencyAmount": {
          "amount": 147.65,
          "currency": "USD"
         },
         "originalPenaltyInfo": "1 Night"
        }
       }
      ],
      "description": [
       "Thor",
       "1 King Standard Communications Accessible 247",
       "Square Feet Room With Microwave And Minifridge"
      ]
     }
    },
    "lowestUnfilteredPublicAvailableRate": {
     "totalPrice": {
      "amount": 129.8
     },
     "base": {
      "amount": 110
     },
     "totalTaxes": {
      "amount": 19.8
     },
     "averageNightlyTotalPrice": {
      "amount": 129.8
     },
     "averageNightlyBase": {
      "amount": 110
     },
     "averageNightlyTotalTaxes": {
      "amount": 19.8
     },
     "currencyCode": "USD",
     "rateKey": {
      "value": "7ae97cfd8dd77ee62c263e7d3ebab12dfd80c405302b494e7abdb2c3fde7bf9d:0e7a75ef6a89e01c87d22db348cfd2e1",
      "authority": "TVPT"
     },
     "rateCodeInfo": {
      "rateCategoryCode": 13,
      "rateType": "Public",
      "rateClassificationCode": 3
     },
     "shortRoomDescription": "1 King Bed(s) Room",
     "terms": {
      "ratePaymentInfo": "PrePay",
      "guaranteeType": "DepositRequired",
      "customerLoyaltyIDRequiredAtReservation": false,
      "rateQualificationIDRequiredAtCheckIn": false,
      "refundable": false,
      "cancelPenalties": [
       {
        "deadlineLocal": "2025-09-30T00:00:00-04:00",
        "cancelShortDescription": "A standard estimated cancellation fee of 129.80 USD applies starting from 2025-09-30T00:00-04:00[America/Detroit] (estimated). Cancel policy may be more restrictive based on rate / room booked, season or special events. Please use the rule API to confirm.",
        "penalty": {
         "estimatedAmount": true,
         "currencyAmount": {
          "amount": 129.8,
          "currency": "USD"
         },
         "originalPenaltyInfo": "1 Night"
        }
       }
      ],
      "description": [
       "Book Early Advance Purchase",
       "1 King Standard 247 Square Feet Room With Microwave",
       "And Minifridge"
      ]
     }
    },
    "lowestUnfilteredPrivateAvailableRate": {
     "totalPrice": {
      "amount": 147.65
     },
     "base": {
      "amount": 125.13
     },
     "totalTaxes": {
      "amount": 22.52
     },
     "averageNightlyTotalPrice": {
      "amount": 147.65
     },
     "averageNightlyBase": {
      "amount": 125.13
     },
     "averageNightlyTotalTaxes": {
      "amount": 22.52
     },
     "currencyCode": "USD",
     "rateKey": {
      "value": "7ae97cfd8dd77ee62c263e7d3ebab12dfd80c405302b494e7abdb2c3fde7bf9d:7010c5c3aa609d7d41f88d3c8b692e15",
      "authority": "TVPT"
     },
     "rateCodeInfo": {
      "rateCode": "THR",
      "ratePlanID": "THORPREFERRED",
      "rateCategory": "MultiLevel/Negotiated/Secure",
      "rateCategoryCode": 10,
      "rateType": "Private",
      "rateClassificationCode": 13
     },
     "shortRoomDescription": "1 King Bed(s) Accessible Room",
     "terms": {
      "ratePaymentInfo": "PrePay",
      "guaranteeType": "DepositRequired",
      "customerLoyaltyIDRequiredAtReservation": false,
      "rateQualificationIDRequiredAtCheckIn": false,
      "refundable": true,
      "cancelPenalties": [
       {
        "deadlineLocal": "2025-10-30T18:00:00-04:00",
        "cancelShortDescription": "Cancellations are free if made before 2025-10-30T18:00-04:00[America/Detroit], after this time, an estimated cancellation fee of 147.65 USD applies.",
        "penalty": {
         "estimatedAmount": true,
         "currencyAmount": {
          "amount": 147.65,
          "currency": "USD"
         },
         "originalPenaltyInfo": "1 Night"
        }
       }
      ],
      "description": [
       "Thor",
       "1 King Standard Communications Accessible 247",
       "Square Feet Room With Microwave And Minifridge"
      ]
     }
    },
    "propertyInfo": {
     "geolocation": {
      "center": {
       "latitude": 42.9129,
       "longitude": -85.5329
      }
     },
     "distanceFromSearchPoint": {
      "unitOfDistance": "Miles",
      "value": 1.98
     },
     "address": {
      "street": "5405 28TH ST COURT SE",
      "city": "GRAND RAPIDS",
      "stateProvince": "MI",
      "countryCode": "US",
      "postalCode": "49546"
     },
     "phone": {
      "phoneNumber": "16162653333"
     },
     "fax": {
      "phoneNumber": "16169570390"
     },
     "checkInTimeLocal": "15:00:00",
     "checkOutTimeLocal": "11:00:00",
     "adaCompliant": false,
     "features": {
      "openingYear": 2018,
      "accessibility": {
       "adaCompliant": false
      }
     },
     "ratings": [
      {
       "value": 2,
       "provider": "NTM"
      },
      {
       "value": 2,
       "provider": "Booking"
      }
     ],
     "imageURLs": [
      {
       "curatedImage": false,
       "curatedImageCategory": "Other",
       "curatedImageTier": 0,
       "imageSize": "Medium",
       "caption": "Hotel Exterior",
       "dimensions": {
        "width": 350,
        "height": 233
       },
       "pictureCategory": 1,
       "url": "https://travelport.leonardocontentcloud.com/imageRepo/6/0/102/440/771/GRRET_5785955932_H.jpg"
      },
      {
       "curatedImage": false,
       "curatedImageCategory": "Other",
       "curatedImageTier": 0,
       "imageSize": "Medium",
       "caption": "Hotel Lobby",
       "dimensions": {
        "width": 350,
        "height": 233
       },
       "pictureCategory": 2,
       "url": "https://travelport.leonardocontentcloud.com/imageRepo/6/0/102/440/795/GRRET_5785955779_H.jpg"
      },
      {
       "curatedImage": false,
       "curatedImageCategory": "Other",
       "curatedImageTier": 0,
       "imageSize": "Medium",
       "caption": "Swimming Pool",
       "dimensions": {
        "width": 350,
        "height": 233
       },
       "pictureCategory": 3,
       "url": "https://travelport.leonardocontentcloud.com/imageRepo/6/0/102/440/729/GRRET_5785955914_H.jpg"
      },
      {
       "curatedImage": false,
       "curatedImageCategory": "Other",
       "curatedImageTier": 0,
       "imageSize": "Medium",
       "caption": "Need protein? Omelets & fresh cooked scrambled eggs for breakfast.",
       "dimensions": {
        "width": 350,
        "height": 234
       },
       "pictureCategory": 4,
       "url": "https://travelport.leonardocontentcloud.com/imageRepo/7/0/126/706/416/GRRET_6470137503_H.jpg"
      }
     ],
     "amenities": [
      {
       "description": "Indoor pool",
       "code": 54,
       "category": "Indoor Pool"
      },
      {
       "description": "Fire safety compliant",
       "code": 264,
       "category": "Fire Safety Compliant"
      },
      {
       "description": "Continental breakfast",
       "code": 159,
       "category": "Breakfast"
      },
      {
       "description": "Hot breakfast",
       "code": 252,
       "category": "Breakfast"
      },
      {
       "description": "Golf",
       "code": 236,
       "category": "Golf"
      },
      {
       "description": "Phone services",
       "code": 190,
       "category": "Business Services"
      },
      {
       "description": "Meeting rooms",
       "code": 269,
       "category": "Meeting Facilities"
      },
      {
       "description": "Private bath or shower",
       "code": 263,
       "category": "Room Amenities"
      },
      {
       "description": "Free transportation",
       "code": 43,
       "category": "Shuttle Service"
      },
      {
       "description": "High speed internet access",
       "code": 259,
       "category": "High-Speed Internet"
      },
      {
       "description": "Air conditioning",
       "code": 5,
       "category": "Air Conditioning"
      },
      {
       "description": "Health club",
       "code": 48,
       "category": "Fitness Center / Gym"
      },
      {
       "description": "Child programs",
       "code": 235,
       "category": "Child Programs"
      },
      {
       "description": "Pool",
       "code": 71,
       "category": "Pool"
      },
      {
       "description": "Non-smoking rooms (generic)",
       "code": 198,
       "category": "Non-Smoking"
      },
      {
       "description": "Business center",
       "code": 228,
       "category": "Business Center"
      },
      {
       "description": "Safe deposit box",
       "code": 78,
       "category": "Safe Deposit Box"
      },
      {
       "description": "Photocopy center",
       "code": 69,
       "category": "Printing Services Available"
      }
     ],
     "featuredPropertyInd": false
    },
    "roomTypes": [
     {
      "estimatedRoomTypeOTACode": 42,
      "shortRoomDescription": "1 King Bed(s) Accessible Room",
      "characteristics": {
       "category": {
        "code": 42,
        "description": "Room"
       },
       "bedTypes": [
        {
         "bedType": "King Bed(s)",
         "quantity": 1,
         "size": "180 cm X 200 cm"
        }
       ],
       "maxOccupancy": 2,
       "accessible": true
      },
      "bedTypes": [
       {
        "bedType": "King Bed(s)",
        "quantity": 1,
        "size": "180 cm X 200 cm"
       }
      ],
      "roomImageURLs": [
       {
        "curatedImage": false,
        "curatedImageCategory": "Other",
        "curatedImageTier": 0,
        "imageSize": "Medium",
        "caption": "Holiday Inn Express Grand Rapids Airport North Guest Bathroom",
        "dimensions": {
         "width": 350,
         "height": 233
        },
        "pictureCategory": 21,
        "url": "https://travelport.leonardocontentcloud.com/imageRepo/6/0/102/428/835/GRRET_5785955885_H.jpg"
       }
      ],
      "roomAmenities": [
       {
        "description": "Non-smoking",
        "code": 74
       }
      ],
      "rates": [
       {
        "createdAt": "2025-09-30T22:34:45.367023757Z",
        "rateKey": {
         "value": "7ae97cfd8dd77ee62c263e7d3ebab12dfd80c405302b494e7abdb2c3fde7bf9d:7010c5c3aa609d7d41f88d3c8b692e15",
         "authority": "TVPT"
        },
        "bookingCode": "KHATHR",
        "rateDescription": "Thor",
        "roomDescription": "1 King Standard Communications Accessible 247 Square Feet Room With Microwave And Minifridge",
        "rateCodeInfo": {
         "rateCode": "THR",
         "ratePlanID": "THORPREFERRED",
         "rateCategory": "MultiLevel/Negotiated/Secure",
         "rateCategoryCode": 10,
         "rateType": "Private",
         "rateClassificationCode": 13
        },
        "dataQualityScore": {
         "vendorRateQualityScore": 40,
         "augmentedRateQualityScore": 85,
         "rateNotes": [
          {
           "message": "Supplier returned inadequate rate description."
          },
          {
           "message": "Supplier returned inadequate accessibility information."
          },
          {
           "message": "Supplier returned inadequate smoking information."
          }
         ],
         "vendorRoomQualityScore": 55,
         "augmentedRoomQualityScore": 80,
         "roomNotes": [
          {
           "message": "Supplier returned inadequate maximum occupancy value."
          }
         ]
        },
        "quantity": 2,
        "nonSmoking": true,
        "accessibleRoom": true,
        "breakfastIncluded": true,
        "lunchIncluded": false,
        "dinnerIncluded": false,
        "price": {
         "partialPriceCache": true,
         "fullPriceCache": false,
         "currencyCode": "USD",
         "base": {
          "amount": 125.13
         },
         "totalTaxes": {
          "amount": 22.52
         },
         "totalPrice": {
          "amount": 147.65
         },
         "predictedPriceChangeDuringStay": false,
         "taxesIncludedInBase": false,
         "commission": {
          "application": true
         },
         "perStayTaxAndFeeBreakdown": {
          "taxes": [
           {
            "value": {
             "amount": 22.52
            },
            "taxCode": "8",
            "description": "Lodging tax",
            "purpose": "Lodging tax"
           }
          ]
         },
         "nightlyRatesBreakdown": [
          {
           "totalPrice": {
            "amount": 147.65
           },
           "localDate": "2025-10-30"
          }
         ],
         "estimatedNightlyBase": false,
         "averageNightlyTotalPrice": {
          "amount": 147.65
         },
         "averageNightlyBase": {
          "amount": 125.13
         },
         "averageNightlyTotalTaxes": {
          "amount": 22.52
         }
        },
        "terms": {
         "ratePaymentInfo": "PrePay",
         "guaranteeType": "DepositRequired",
         "customerLoyaltyIDRequiredAtReservation": false,
         "rateQualificationIDRequiredAtCheckIn": false,
         "refundable": true,
         "cancelPenalties": [
          {
           "deadlineLocal": "2025-10-30T18:00:00-04:00",
           "cancelShortDescription": "Cancellations are free if made before 2025-10-30T18:00-04:00[America/Detroit], after this time, an estimated cancellation fee of 147.65 USD applies.",
           "penalty": {
            "estimatedAmount": true,
            "currencyAmount": {
             "amount": 147.65,
             "currency": "USD"
            },
            "originalPenaltyInfo": "1 Night"
           }
          }
         ],
         "description": [
          "Thor",
          "1 King Standard Communications Accessible 247",
          "Square Feet Room With Microwave And Minifridge"
         ]
        }
       },
       {
        "createdAt": "2025-09-30T22:34:45.351168006Z",
        "rateKey": {
         "value": "7ae97cfd8dd77ee62c263e7d3ebab12dfd80c405302b494e7abdb2c3fde7bf9d:9cd884804b90268da8fb4c8c780cc931",
         "authority": "TVPT"
        },
        "bookingCode": "KHAM85P",
        "rateDescription": "1000 Ihg1R Bonus Points Nt Includes Room And",
        "roomDescription": "1000 Ihg One Rewards Bonus Points Person Night. 1 King Standard Communications Accessible 247 Square Feet Room With Microwave And Minifridge",
        "rateCodeInfo": {
         "rateCategoryCode": 13,
         "rateType": "Public",
         "rateClassificationCode": 3
        },
        "dataQualityScore": {
         "vendorRateQualityScore": 40,
         "augmentedRateQualityScore": 85,
         "rateNotes": [
          {
           "message": "Supplier returned inadequate rate description."
          },
          {
           "message": "Supplier returned inadequate accessibility information."
          },
          {
           "message": "Supplier returned inadequate smoking information."
          }
         ],
         "vendorRoomQualityScore": 55,
         "augmentedRoomQualityScore": 80,
         "roomNotes": [
          {
           "message": "Supplier returned inadequate maximum occupancy value."
          }
         ]
        },
        "quantity": 2,
        "nonSmoking": true,
        "accessibleRoom": true,
        "breakfastIncluded": true,
        "lunchIncluded": false,
        "dinnerIncluded": false,
        "price": {
         "partialPriceCache": true,
         "fullPriceCache": false,
         "currencyCode": "USD",
         "base": {
          "amount": 139
         },
         "totalTaxes": {
          "amount": 25.02
         },
         "totalPrice": {
          "amount": 164.02
         },
         "predictedPriceChangeDuringStay": false,
         "taxesIncludedInBase": false,
         "commission": {
          "application": true
         },
         "perStayTaxAndFeeBreakdown": {
          "taxes": [
           {
            "value": {
             "amount": 25.02
            },
            "taxCode": "8",
            "description": "Lodging tax",
            "purpose": "Lodging tax"
           }
          ]
         },
         "nightlyRatesBreakdown": [
          {
           "totalPrice": {
            "amount": 164.02
           },
           "localDate": "2025-10-30"
          }
         ],
         "estimatedNightlyBase": false,
         "averageNightlyTotalPrice": {
          "amount": 164.02
         },
         "averageNightlyBase": {
          "amount": 139
         },
         "averageNightlyTotalTaxes": {
          "amount": 25.02
         }
        },
        "terms": {
         "ratePaymentInfo": "PrePay",
         "guaranteeType": "DepositRequired",
         "customerLoyaltyIDRequiredAtReservation": false,
         "rateQualificationIDRequiredAtCheckIn": false,
         "refundable": true,
         "cancelPenalties": [
          {
           "deadlineLocal": "2025-10-30T18:00:00-04:00",
           "cancelShortDescription": "Cancellations are free if made before 2025-10-30T18:00-04:00[America/Detroit], after this time, an estimated cancellation fee of 164.02 USD applies.",
           "penalty": {
            "estimatedAmount": true,
            "currencyAmount": {
             "amount": 164.02,
             "currency": "USD"
            },
            "originalPenaltyInfo": "1 Night"
           }
          }
         ],
         "description": [
          "1000 Ihg1R Bonus Points Nt Includes Room And",
          "1000 Ihg One Rewards Bonus Points Person Night.",
          "1 King Standard Communications Accessible 247",
          "Square Feet Room With Microwave And Minifridge"
         ]
        }
       }
      ],
      "maxOccupancy": 2
     }
     }
    ]
   }
  ]
 }
}

 


Additional Examples

For additional examples, download the developer toolkits and see Using Postman and Developer Toolkits.

The following example requests show several criteria for the search.