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 - Basic Search Complete request (only property 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 sending location details and optional search modifiers based on property characteristics.

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.

  • Apartment

  • Bed and breakfast

  • Cabin or bungalow

  • Chalet

  • Condominium

  • Guest house limited service

  • Health spa

  • Hostel

  • Hotel

  • Inn

  • Lodge

  • Motel

  • Resort

  • Vacation home

  • Villa

  • Full service

  • Historical

  • Vacation rental

amenityCategories

Top level object for the category of amenities.

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

  • Air conditioning

  • Free airport shuttle

  • Free parking

  • Parking

  • Pool

  • Restaurant

  • Spa

  • Lounges/bars

  • Non-smoking rooms (generic)

  • Free high speed internet connection

  • Pets allowed

  • Complimentary breakfast

  • Accessible rooms

  • Meeting rooms

  • Smoke-free property

  • No parking available

  • Fitness center

  • AHLA Safe Stay compliant

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.

  • All

  • Association

  • Business

  • BusinessStandard

  • Club

  • Convention

  • Corporate

  • Consortiums

  • Discount

  • Credential

  • Employee

  • FamilyPlan

  • FullInclusive

  • Government

  • Inclusive

  • Industry/TravelAgentRate

  • Leisure

  • Military

  • Monthly

  • Multi-DayPackage

  • MultiLevel/Negotiated/Secure

  • Other

  • Package

  • PrePaid

  • Promotional

  • RackGeneral

  • SeniorCitizen

  • Standard

  • Tour

  • VIP

  • Weekend

  • Weekly

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.

  • All

  • Association

  • Business

  • BusinessStandard

  • Club

  • Convention

  • Corporate

  • Consortiums

  • Discount

  • Credential

  • Employee

  • FamilyPlan

  • FullInclusive

  • Government

  • Inclusive

  • Industry/TravelAgentRate

  • Leisure

  • Military

  • Monthly

  • Multi-DayPackage

  • MultiLevel/Negotiated/Secure

  • Other

  • Package

  • PrePaid

  • Promotional

  • RackGeneral

  • SeniorCitizen

  • Standard

  • Tour

  • VIP

  • Weekend

  • Weekly

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* - sends location details and optional search modifiers based on property characteristics

propertyFilter*

Top level object for hotel search data. Filters are used to restrict which properties are returned in a response.

maxWaitTime : The maximum wait time for the property to respond in milliseconds.

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

roomFilter

Top-level object that filters room qualifiers. Filter applies only to the lowest filtered available rates.

nonSmoking : Boolean. If true, only rates with non-smoking rooms will be a candidate for the lowest filtered available rate. If false, only rates with smoking rooms will candidate for the lowest filtered available rate.

balcony : Boolean. If true, only rates with balcony rooms be a candidate for the lowest filtered available rate.

accessible : Boolean. If true, only rates with accessible rooms will be a candidate for the lowest filtered available rate. If false, only rates with non-accessible rooms will candidate for the lowest filtered available rate.

connecting : Boolean. If true, only rates with connecting rooms will be a candidate for the lowest filtered available rate.

family : Boolean. If true, only rates with family rooms will be a candidate for the lowest filtered available rate.

highFloor : Boolean. If true, only rates with high floor rooms will be a candidate for the lowest filtered available rate.

maxOccupancy : Only rates with rooms which can accommodate this amount of guests will be a candidate for the lowest filtered rate.

amenityCodes : Array of up to three room level amenity codes (OTA codes) to include in the search. Only rates with rooms which match at least one of the amenity codes will be a candidate for the lowest filtered rate.

recommendedRoomAmenitiesInd : Boolean. If true, a limited set of room amenities will be returned in the response. If false, or omitted a full set of room amenities will be returned in the response.

bedConfiguration

Object to request the number and type of beds.

minimumQuantity : Numeric. Limit the room choice to this minimum number of beds.

type : String. Limit the room choice to this bed type. Accepted values are:

King, Queen, Double, Twin, Sofa, Other.

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

rateFilter

Top-level object containing filter types that restrict which rates can be considered for lowest rate available. Includes rateFlags and publickRateBlacklist.

rateFlags

Object containing specific elements to help limit rates considered for lowest available rate.

refundable : Boolean. Default is false. If true, only refundable rooms will be a candidate for the lowest filtered available rate. If false, only non-refundable rates will be a candidate for the lowest filtered available rate.

commissionable : Boolean. Default is false. If true, only commissionable rates will be a candidate for the lowest filtered available rate. If false, only non-commissionable rates will be a candidate for the lowest filtered available rate.

deposit : Boolean. Default is false. If true, only rates with deposit will be a candidate for the lowest filtered available rate. If false, only rates without deposit will be a candidate for the lowest filtered available rate.

prepay : Boolean. Default is false. If true, only prepay rates will be a candidate for the lowest filtered available rate.

postpay : Boolean. Default is false. If true, only postpay rates will be a candidate for the lowest filtered available rate.

breakfast : Boolean. Default is false. If true, only rates with breakfast will be a candidate for the lowest filtered available rate.

lunch : Boolean. Default is false. If true, only rates with lunch will be a candidate for the lowest filtered available rate.

dinner : Boolean. Default is false. If true, only rates with dinner will be a candidate for the lowest filtered available rate.

publicRateBlacklist

Array. Send public rate types to exclude from the response.

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 flows. If not sent in the response, the API creates a unique identifier and returns it in the response header and payload. See Transaction and Trace IDs for details.

transactionId

This object has no purpose and can be ignored. See Transaction and Trace IDs for details.

pagination

Describes 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.

  • Apartment

  • Bed and breakfast

  • Cabin or bungalow

  • Chalet

  • Condominium

  • Guest house limited service

  • Health spa

  • Hostel

  • Hotel

  • Inn

  • Lodge

  • Motel

  • Resort

  • Vacation home

  • Villa

  • Full service

  • Historical

  • Vacation rental

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.

lowestXXAvailableRate

Objects and properties in all types of lowest available rates. Properties:

currencyCode: Standard three-character currency code.

shortRoomDescription: A concise edited form of the current room description.

totalPrice

Total price of the stay. Properties:

amount: The total price of the stay in decimal form.

base

Total base rate of the stay. Properties:

amount: The total base rate of the stay in decimal form.

totalTaxes

Total taxes for the stay. Properties:

amount: The total taxes for the stay in decimal form.

totalIncludedFees

The total fees for the stay that are included in the total price. Properties:

amount: The amount of the total fees for the stay in decimal form.

averageNightlyTotalPrice

Average nightly total price across the stay. Properties:

amount: The average nightly total price in decimal form.

averageNightlyBase

Average nightly base rate across the stay. Properties:

amount: The average nightly base price in decimal form.

averageNightlyTotalTaxes

Average nightly tax amount across the stay. Properties:

amount: The average nightly tax amount in decimal form.

averageNightlyIncludedFees

Average nightly fees amount included within the total price. Properties:

amount: The amount of the included average nightly fee in decimal form.

rateKey

Object identifying the rate for future use in Rules and Reservation. Properties:

value: The unique identifier for the rate.

authority: Name of the authoritative system that created this key.

Supported four-character values:

  • TVPT Travelport

  • BKNG Booking.com

rateCodeInfo

Rate code definitions associated with this specific rate. Properties:

rateCode: Rate access code.

rateCategoryCode: Number. Category code using OTA rate plan type code list.

  • 1 Association

  • 2 Club/concierge

  • 3 Convention

  • 4 Corporate

  • 7 Family plan

  • 8 Government

  • 9 Military

  • 10 Negotiated

  • 11 Package

  • 12 Promotional

  • 13 Regular/rack

  • 14 Senior citizen

  • 15 Tour/wholesale

  • 16 Travel industry

  • 17 Weekend

  • 26 Multi-day package

  • 27 Weekly

  • 28 Monthly

rateType: Rate type.

  • Consortia

  • Negotiated

  • Public

  • Private

  • TMC

rateClassificationCode: Number. Classification code using OTA rate category code list.

  • 1 Government

  • 2 Business

  • 3 Leisure

  • 4 Employee

  • 5 VIP

  • 6 All

  • 7 Association

  • 8 Business standard

  • 9 Corporate

  • 10 Industry

  • 11 Fully inclusive

  • 12 Inclusive

  • 13 Negotiated

  • 14 Promotional

  • 15 Credential

  • 16 Standard

  • 17 Consortiums

  • 18 Conventions

  • 19 Prepaid rates

terms

Definition of all terms and conditions associated with this rate. Properties:

partialTermsCache: Boolean. If true, the Terms have been partially obtained from the rules cache.

fullTermsCache: Boolean. If true, the Terms have been fully obtained from the rules cache.

ratePaymentInfo: The terms of the payment.

Supported values:

  • PrePay

  • PostPay

  • Unknown

guaranteeType: Defines the guarantee applied to this rate at reservation.

Supported values:

  • GuaranteeRequired

  • NoGuaranteesAccepted

  • DepositRequired

  • PrepayRequired

paymentTypeEstimated: Boolean. If true, the payment type is estimated.

freeCancellationWithin24Hours: Boolean. If true, the property only allows free cancellation within 24 hours.

customerLoyaltyIDRequiredAtReservation: Boolean. If true, the rate returned is contingent on a membership number to be included within the reservation request, typically associated to frequent guest or frequent flyer loyalty numbers.

rateQualificationIDRequiredAtCheckIn: Boolean. If true, the discounted rate returned may be denied at the property if guest does not show proof of qualifying, typically a government/military/workplace/association/membership ID.

refundable: Boolean. If true, the rate is refundable.

cancelNote: When cancellation information is incomplete or missing, a cancellation note is included with a 512-character maximum.

description: Array. Descriptions of the rate.

Includes changes, cancelPenalties, and lengthOfStay objects.

changes

Policy applied to this rate regarding modification or cancellation. Properties:

changesPermitted: Boolean. If true, changes are permitted.

numberOfDaysBeforeCheckIn: The number of days before check in when changes are permitted.

description: The changes policy.

cancelPenalties

Array of objects describing the cancel penalties associated with this rate. Properties:

deadlineLocal: The local date and time of the deadline of the cancel penalty.

estimatedDeadlineLocal: Boolean. If true, the deadline is estimated.

cancelShortDescription: A short description of the cancel penalty.

penaltyNotes: Array of notes about the penalty, maximum of 512 characters.

Includes penalty object.

penalty

Definition of penalty imposed with cancel policy. Properties:

estimatedAmount: Boolean. Default is false. If true, the penalty amount is an estimated amount.

originalPenaltyInfo: If estimatedAmount is true, the original provider cancel penalty (nights, percent) information will be added here as text.

Includes currencyAmount object.

currencyAmount

The currency code and amount of the penalty. Properties:

amount: The penalty amount in decimal form.

currency: Standard three-character currency code.

lengthOfStay

Length of stay parameters associated with the rate. Properties:

minNightCount: The minimum number of nights the guest must stay.

maxNightCount: The maximum number of nights the guest can stay.

propertyInfo

Property-specific information. Properties:

email: Property email address.

checkInTimeLocal: The local time the guest can check in.

checkOutTimeLocal: The local check out time.

adaCompliant: Boolean. If true, the property is ADA compliant

acceptedCreditCards: Array of accepted credit cards

featuredPropertyInd: Boolean. If true, designates this property as a featured for advertising purposes.

Includes geolocation, distanceFromSearchPoint, address, phone, fax, features, ratings, imageURLs, and amenities objects.

geolocation

Geographical coordinates of the property.

Includes center object.

center

Geographical coordinates of property. Properties:

latitude: The latitudinal coordinates. May be negative.

longitude: The longitudinal coordinates. May be negative.

distanceFromSearchPoint

Distance of the property from the search point. Properties:

unitOfDistance: The unit of distance (miles or kilometers).

value: Number. The distance of the property from the search point.

address

The property address details. Properties:

street: Property street address.

city: City of the property.

stateProvince: The state or province of the property.

countryCode: Two-character country code.

postalCode: Property postal code.

phone

The property phone number. Properties:

phoneNumber: Telephone number including country and area codes.

fax

The property fax number. Properties:

phoneNumber: Fax number including country and area codes.

features

Property details. Properties:

minimumCheckInAge: The minimum age required to check in.

adultsOnly: Boolean. If true, the property is for adults only.

openingYear: The year the property opened.

renovationCompletionYear: the year the property was last renovated.

requestableItems: Array of traveler requests.

Supported values:

  • Crib

  • ExtraAdult

  • ExtraChild

  • RollawayAdult

  • RollawayChild

Includes childPolicies and accessibility objects.

childPolicies

The child policies of the property. Properties:

inclusiveRates: Boolean. If true, the rates are inclusive.

kidsStayFree: Boolean. If true, children stay free.

maxFreeChildAge: The maximum age of a child that can stay for free

maxFreeChildrenPerAdult: The maximum number of children that can stay for free per adult

accessibility

The accessibility information of the property. Properties:

adaCompliant: Boolean. If true, the property is ADA compliant.

Includes options object.

options

Array of accessibility options. Properties:

code: The code of the accessibility option.

description: The description of the accessibility option.

availability: The availability of the accessibility option.

ratings

Array. The rating provider and value pair of the property. Properties:

provider: The rating provider.

value: The rating value.

imageURLs

Array of image objects holding the url, size, caption, and other image information. Properties:

recommendedHero: Boolean. If true, this image is recommended as the top image of the property.

curatedImage: Boolean. If true, this image is carefully chosen from a wider selection of images.

curatedImageCategory: Category of image.

  • Exterior

  • GuestRoom

  • Interior

  • Lobby

  • Restaurant

  • Studio

  • Suite

  • SwimmingPool

  • Other

curatedImageTier: Integer. 0 = not curated. 1 = highest level, both manually and algorithmically graded. 2 = manually graded. 3 = algorithmically graded.

imageSize: Indicates the size of the image.

Supported values:

  • Large

  • Medium

  • Small

  • Thumbnail

  • ExtraLarge

caption: The caption of the image

pictureCategory: The category of the picture. (MK: list of supported values needs verification)

  • 1 Exterior view

  • 2 Lobby view

  • 3 Pool view

  • 4 Restaurant

  • 5 Health club

  • 6 Guest room

  • 7 Suite

  • 8 Meeting room

  • 9 Ballroom

  • 10 Golf course

  • 11 Beach

  • 12 Spa

  • 13 Bar/Lounge

  • 14 Recreational facility

  • 15 Logo

  • 16 Basics

  • 17 Map

  • 18 Promotional

  • 19 Hot news

  • 20 Miscellaneous

  • 21 Guest room amenity

  • 22 Property amenity

  • 23 Business center

  • 24 Nearby attractions

  • 25 Accessibility

  • 26 View from property

  • 27 Shuttle/Transfer

  • 28 Certificates

  • 29 Sustainability

url: The URL of the image.

Includes dimensions object.

dimensions

The dimensions of the image. Properties:

width: Width of image in pixels

height: Height of image in pixels

kiloBytes: Size of image in kilobytes

amenities

Array. Details of property-level amenities available at this property. Properties:

code: The OTA hotel amenity code.

description: The description of the amenity.

category: The category of the amenity.

  • Air conditioning

  • Free airport shuttle

  • Free parking

  • Parking

  • Pool

  • Restaurant

  • Spa

  • Lounges/bars

  • Non-smoking rooms (generic)

  • Free high speed internet connection

  • Pets allowed

  • Complimentary breakfast

  • Accessible rooms

  • Meeting rooms

  • Smoke-free property

  • No parking available

  • Fitness center

  • AHLA Safe Stay compliant

rateSummary

A summary of private and negotiated rates returned in the hotel response.

Includes authorityCounts, consortiaCodeCounts, negotiatedCodeCounts, tmcCodeCounts, and categoryCounts objects.

authorityCounts

Array. The quantity of rates returned by authority. Properties:

authority: The aggregatorClosed A platform that consolidates travel services, schedules, prices, and other details from multiple suppliers into a single interface. providing the rates. Possible values are TVPT for Travelport and BKNG for Booking.com.

count: The number of rates provided by that aggregator.

consortiaCodeCounts

Array. The list of consortia codes returned. Properties:

code: The consortia rate code.

count: The number of rates returned with this rate code type.

negotiatedCodeCounts

Array. The list of negotiated rate codes returned. Properties:

code: The negotiated rate code.

count: The number of rates returned with this rate code type.

tmcCodeCounts

Array. The list of TMC designated rate codes returned. Properties:

code: The TMC designated rate code.

count: The number of rates returned with this rate code type.

categoryCounts

Array. The list of rate categories returned. Properties:

count: The number of rates returned with this rate code type.

Includes subCategories object.

subCategories

Array. The quantity of rates belonging to a sub category. Properties:

class: The class of category.

count: The quantity of the rates belonging to a sub category.

roomTypes

roomTypes

Array. Detailed information of each room type provided by this property. Properties:

estimatedRoomTypeOTACode: OTA code set Guest Room Info (GRI).

shortRoomDescription: A concise edited form of the current room description.

maxOccupancy: The maximum number of people permitted to occupy the room.

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

Includes characteristics, view, bedTypes, roomImageURLs, roomAmenities, and rates objects.

view and bedTypes are marked for deprecation and will be removed in a future version.

characteristics

Object defining the group of characteristics for this room type. Properties:

maxOccupancy: The maximum number of people permitted to occupy the room.

otherFeatures: Array of other room features.

numberOfBedrooms: The number of bedrooms for this room type.

numberOfOtherRooms: The number of other rooms for this room type (e.g., lounge, kitchen).

numberOfBathrooms: The number of bathrooms for this room type.

accessible: Boolean. If true, this room is designed to be easy for people with disabilities to enter and leave, and to move around comfortably.

Includes category, class, uniqueDetails, roomSize, bedTypes, view, balconyType, and locationInfo objects.

category

Object defining the room category. Travelport uses portions of the OTA Guest Room Info Codeset (GRI). Properties:

code: OTA code for the room category.

  • 1 Accessible rooms

  • 3 Suites

  • 13 Apartments

  • 15 Penthouses

  • 16 Studios

  • 22 Freestanding units

  • 25 Condos

  • 36 Family/oversized accommodations

  • 38 Cabin

  • 39 Cottage

  • 42 Room

  • 44 Bungalow

  • 45 Villa

  • 46 Efficiency

  • 60 Junior suite

  • 61 Jacuzzi suite

  • 62 Run of the house

  • 75 Classic

  • 76 Comfort

  • 77 Deluxe

  • 78 Deluxe suite

  • 79 Economy

  • 80 Luxury

  • 81 Premier

  • 82 Standard

  • 83 Superior

  • 84 Dormitory

  • 86 Chalet

  • 88 House

description: The description of the room category code.

class

Object defining the classification of the room type. Travelport uses the segment category list as below. Properties:

code: The Travelport code for room classification.

  • 1 All suite

  • 2 Budget

  • 3 Corporate business transient

  • 4 Deluxe

  • 5 Economy

  • 6 Extended stay

  • 7 First class

  • 8 Luxury

  • 9 Meeting/Convention

  • 10 Moderate

  • 11 Residential apartment

  • 12 Resort

  • 13 Tourist

  • 14 Upscale

  • 15 Efficiency

  • 16 Standard

  • 17 Midscale

  • 18 Moderate 2

  • 19 Quality

  • 20 Quality 2

  • 21 Unknown

  • 22 Midscale without F&B

  • 23 Upper upscale

  • 24 Romantic

  • 25 Boutique

  • 26 Pet-Friendly

  • 27 Beach

  • 28 Family

  • 29 Adult Only

  • 30 All Inclusive

description: The description of the room classification code.

roomSize

The size of the room. Properties:

value: The size of the room.

unit: The unit of measurement of the room size.

bedTypes

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

Array. Details of all beds available in this room type. Properties:

bedType: The type of bed.

Supported values:

  • King Bed(s)

  • Queen Bed(s)

  • Double Bed(s)

  • Twin Bed(s)

  • Sofa Bed(s)

  • Other Bed(s)

quantity: The quantity of the beds.

size: The size of the bed in centimeters.

view

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

Object defining room view details. Travelport uses the OTA Room View Type Codeset (RVT). Properties:

code: The OTA code for room view.

  • 1 Airport view

  • 2 Bay view

  • 3 City view

  • 4 Courtyard view

  • 5 Golf view

  • 6 Harbor view

  • 7 Intercoastal view

  • 8 Lake view

  • 9 Marina view

  • 10 Mountain view

  • 11 Ocean view

  • 12 Pool view

  • 13 River view

  • 14 Water view

  • 15 Beach view

  • 16 Garden view

  • 17 Park view

  • 18 Forest view

  • 19 Rain forest view

  • 20 Various views

  • 21 Limited view

  • 22 Slope view

  • 23 Strip view

  • 24 Countryside view

  • 25 Sea view

  • 26 Golf view

  • 27 Valley view

  • 28 Desert view

  • 29 Canal view

  • 30 Lagoon view

  • 31 Resort view

  • 32 Vineyard view

  • 33 Atrium view

  • 34 Campus view

  • 35 Coastal view

  • 36 Inland view

  • 37 Island view

  • 38 Landscape view

  • 39 Panoramic view

  • 40 Sound view

  • 41 Sunrise view

  • 42 Sunset view

  • 43 Waterfall view

  • 44 Wharf view

  • 45 Street view

description: The description of the room view code.

balconyType

Balcony details. Properties:

code: OTA code.

description: The description of the balcony details code.

locationInfo

Information about the location of the room. Properties:

floor: The floor of the room.

wing: The wing of the room.

building: The building of the room.

proximity: The proximity of the room.

roomImageURLs

Details for all images relating to the room and guest room amenities associated with this room. Properties:

recommendedHero: Boolean. If true, this image is recommended as the top image of the property.

curatedImage: Boolean. If true, this image is carefully chosen from a wider selection of images.

curatedImageCategory: Category of image.

  • Exterior

  • GuestRoom

  • Interior

  • Lobby

  • Restaurant

  • Studio

  • Suite

  • SwimmingPool

  • Other

curatedImageTier: Integer. 0 = not curated. 1 = highest level, both manually and algorithmically graded. 2 = manually graded. 3 = algorithmically graded.

imageSize: Indicates the size of the image.

  • Large

  • Medium

  • Small

  • Thumbnail

  • ExtraLarge

caption: The caption of the image

pictureCategory: The category of the picture. (MK: list of supported values needs verification)

  • 1 Exterior view

  • 2 Lobby view

  • 3 Pool view

  • 4 Restaurant

  • 5 Health club

  • 6 Guest room

  • 7 Suite

  • 8 Meeting room

  • 9 Ballroom

  • 10 Golf course

  • 11 Beach

  • 12 Spa

  • 13 Bar/Lounge

  • 14 Recreational facility

  • 15 Logo

  • 16 Basics

  • 17 Map

  • 18 Promotional

  • 19 Hot news

  • 20 Miscellaneous

  • 21 Guest room amenity

  • 22 Property amenity

  • 23 Business center

  • 24 Nearby attractions

  • 25 Accessibility

  • 26 View from property

  • 27 Shuttle/Transfer

  • 28 Certificates

  • 29 Sustainability

url: The URL of the image.

Includes dimensions object.

dimensions

The dimensions of the image. Properties:

width: Width of image in pixels

height: Height of image in pixels

kiloBytes: Size of image in kilobytes

roomAmenities

Array. Groups of room amenity descriptions provided with the rates associated with this room. Travelport uses the OTA Room Amenity Type codeset (RMA). Properties:

code: OTA room amenity type code.

(MK: Need supported values.)

description: The description of the amenity.

category: The amenity category.

rates

Array. Description of all rates available for this room type. Properties:

createdAt: The date and time the rate was created.

updatedAt: The date and time the rate was updated.

bookingCode: The booking code of the rate.

rateDescription: The description of the rate provided by the supplier.

roomDescription: The description of the room provided by the supplier.

quantity: Number of rooms available at this rate.

nonSmoking: Boolean. If true, this is a non smoking room.

accessibleRoom: Boolean. If true, this is an accessible room.

wifiIncluded: Boolean. If true, wifi is included.

breakfastIncluded: Boolean. If true, breakfast is included.

lunchIncluded: Boolean. If true, lunch is included.

dinnerIncluded: Boolean. If true, dinner is included.

freeParkingIncluded: Boolean. If true, free parking is included.

valetParkingIncluded: Boolean. If true, valet parking is included.

priceChangeProbability: The probability of the rate changing for this room. (MK: Not in James' doc)

Supported values:

  • High

  • Medium

  • Low

loyaltyPoints: Loyalty points accrued with this rate.

Includes rateKey, cache, rateCodeInfo, dataQualityScore, price, terms, and credit objects.

rateKey

Object identifying the rate and the system that returned it. Properties:

value: The unique identifier for the rate.

authority: Name of the authoritative system that created this key.

Supported values:

  • TVPT

  • BKNG

cache

The cache information of the rate. Properties:

createdAt: The date and time the rate was created in the cache.

updatedAt: The date and time the rate was updated in the cache.

rateCodeInfo

Object defining certain restricted access rates. Properties:

rateCode: Rate access code.

rateName: Rate code name.

ratePlanID: Rate code identifier.

rateCategory: The type of rate category.

  • All

  • Association

  • Business

  • BusinessStandard

  • Club

  • Convention

  • Corporate

  • Consortiums

  • Discount

  • Credential

  • Employee

  • FamilyPlan

  • FullInclusive

  • Government

  • Inclusive

  • Industry/TravelAgentRate

  • Leisure

  • Military

  • Monthly

  • Multi-DayPackage

  • MultiLevel/Negotiated/Secure

  • Other

  • Package

  • PrePaid

  • Promotional

  • RackGeneral

  • SeniorCitizen

  • Standard

  • Tour

  • VIP

  • Weekend

  • Weekly

rateCategoryCode: Category code using OTA rate type code list.

rateType: Rate type. Possible values:

  • Consortia

  • Negotiated

  • Public

  • Private

  • TMC

rateClassificationCode: Classification code using OTA rate category code list.

  • 1 Government

  • 2 Business

  • 3 Leisure

  • 4 Employee

  • 5 VIP

  • 6 All

  • 7 Association

  • 8 Business standard

  • 9 Corporate

  • 10 Industry

  • 11 Fully inclusive

  • 12 Inclusive

  • 13 Negotiated

  • 14 Promotional

  • 15 Credential

  • 16 Standard

  • 17 Consortiums

  • 18 Conventions

  • 19 Prepaid rates

dataQualityScore

Object of quality scores for room and rate information. Properties:

vendorRateQualityScore: Integer between 0 and 100. A score representing the overall vendor provided rate details for this room rate in this transaction, rounded.

augmentedRateQualityScore: Integer between 0 and 100. A score representing the Travelport improvement of rate details for this room rate in this transaction, rounded.

vendorRoomQualityScore: Integer between 0 and 100. A score representing vendor provided room details for this room in this transaction, rounded.

augmentedRoomQualityScore: Integer between 0 and 100. A score representing Travelport improvement of room details for this room in this transaction, rounded.

Includes rateNotes and roomNotes objects.

rateNotes

Array of information returned by Travelport regarding rate information deficiencies from the supplier. Properties:

message: Rate deficiency information

roomNotes

Array of information returned by Travelport regarding room information deficiencies from the supplier. Properties:

message: Room deficiency information

price

Object defining the price components of the rate. Properties:

partialPriceCache: Boolean. If true, the rate price has been partially obtained from cache. (MK: Not included in James doc but in schema.)

fullPriceCache: Boolean. If true, the rate price has been fully obtained from cache. (MK: Not included in James doc but in schema.)

currencyCode: Standard three-letter currency code.

predictedPriceChangeDuringStay: If true, nightly rate breakdown information is missing or invalid. For exact nightly rate breakdown request Hotel Rules.

taxesIncludedInBase: Boolean. If true, taxes are included in the base price.

resortFeeIncluded: Boolean. If true, resort fee is included.

estimatedNightlyBase: Boolean. If true, nightly rate breakdown information is missing or invalid. For exact nightly rate breakdown request Hotel Rules.

shortRateDescription: A normalized rate description for comparing rates across multiple aggregators.

Includes base, totalTaxes, totalPrice, totalIncludedFees, totalFeesDueAtProperty, commission, perStayTaxAndFeeBreakdown, nightlyRatesBreakdown, averageNightlyTotalPrice, averageNightlyBase, averageNightlyTotalTaxes, averageNightlyIncludedFees, and priceNote objects.

base

Total base price. Properties:

amount: The total base amount in decimal form.

totalTaxes

Total taxes. Properties:

amount: The total taxes amount in decimal form.

totalPrice

Total price. Properties:

amount: The total price amount in decimal form.

totalIncludedFees

Total amount including fees. Properties:

amount: The total amount including fees in decimal form.

totalFeesDueAtProperty

Amount of total fees due at property. Properties:

amount: The total fees amount due at the property in decimal form.

commission

The commission information of the rate. Properties:

application: Boolean. If true, the rate is commissionable

percent: The percentage of commission paid for this rate.

estimatedPercent: Boolean. If true, the penalty percent is an estimate.

originalCommissionInfo: If estimatedPercent is true, the original Provider information will be added here as text.

perStayTaxAndFeeBreakdown

The tax and fee breakdown for the stay.

Includes taxes and fees objects.

taxes

Array. Describes in detail the types and amounts of taxes charged with this rate. Properties:

taxCode: The OTA tax code.

description: The description of the tax.

purpose: The purpose of the tax.

Includes value object.

value

The tax amount for the stay. Properties:

amount: The tax amount in decimal form.

fees

Array. Describes in detail the types and amounts of fees charged with this rate. Properties:

taxCode: The OTA tax code.

description: The description of the fee.

includedInTotalPrice: Boolean. If true, the fee is included in the total price. If false, the fee is paid at the property.

purpose: The purpose of the fee.

feeApplication: Application values like per person, per room.

  • PerPerson

  • PerRoom

  • PerAccommodation

  • PerHouse

  • PerApartment

  • PerAdult

  • PerChild

feeFrequency: Frequency fee is applied like per night, per day.

  • PerNight

  • PerDay

  • PerStay

  • PerWeek

Includes value object.

value

The fee amount for the stay. Properties:

amount: The fees amount in decimal form.

nightlyRatesBreakdown

The nightly rate object containing price information applicable for a night of the stay. Properties:

localDate: The local date of the nightly rate.

Includes base, totalTaxes, totalPrice, totalIncludedFees, and totalFeesDueAtProperty object.

base

Total base price of the nightly rate. Properties:

amount: The total base amount in decimal form.

totalTaxes

Total taxes of the nightly rate. Properties:

amount: The total taxes amount in decimal form.

totalPrice

Total price of the nightly rate. Properties:

amount: The total price amount in decimal form.

totalIncludedFees

Total amount of included fees in the nightly rate. Properties:

amount: Decimal. The amount describes unit and subunit of the currency in a single value, where the integer part (digits before the decimal point) is for the major unit and fractional part (digits after the decimal point) is for the minor unit.

totalFeesDueAtProperty

Amount of total fees due at property for the nightly rate. Properties:

amount: Decimal. The amount describes unit and subunit of the currency in a single value, where the integer part (digits before the decimal point) is for the major unit and fractional part (digits after the decimal point) is for the minor unit.

averageNightlyTotalPrice

The average nightly total price. Properties:

amount: The amount of the averagel nightly rate price, in decimal form.

averageNightlyBase

The average base price of the nightly rate. Properties:

amount: The average amount of the base nightly rate price, in decimal form.

averageNightlyTotalTaxes

Average nightly tax amount across the stay. Properties:

amount: The average nightly tax amount in decimal form.

averageNightlyIncludedFees

Average nightly fees amount included within the total price. Properties:

amount: The amount of the included average nightly fee in decimal form.

priceNote

A note about the price.

Properties:

message: The message of the price note, maximum 512 characters.

terms

Object defining the terms and conditions of the rate. Properties:

partialTermsCache: Boolean. If true, the terms have been partially obtained from cache.

fullTermsCache: Boolean. If true, the terms have been fully obtained from cache.

ratePaymentInfo: The general terms of the payment.

Supported values:

  • PrePay

  • PostPay

  • Unknown

paymentTypeEstimated: Boolean. If true, the payment type is estimated.

guaranteeType: An enumerated type defining the guarantee to be applied to this reservation.

Supported values:

  • GuaranteeRequired

  • NoGuaranteesAccepted

  • DepositRequired

  • PrepayRequired

freeCancellationWithin24Hours: Boolean. If true, the property only allows free cancellation within 24 hours.

customerLoyaltyIDRequiredAtReservation: Boolean. If true, the rate returned is contingent on a membership number to be included within the reservation request, typically associated to frequent guest or frequent flyer loyalty numbers.

rateQualificationIDRequiredAtCheckIn: Boolean. If true, the discounted rate returned may be denied at the property if guest does not show proof of qualifying, typically a government/military/workplace/association/membership ID.

refundable: Boolean. If true, the rate is refundable.

cancelNote: When cancellation information is incomplete or missing, a cancellation note will be included with a 512-character maximum

description: Array. Descriptions of the rate.

Includes changes, cancelPenalties, lengthOfStay, and extraAccommodations objects.

changes

Object defining the restrictions on changes. Properties:

changesPermitted: Boolean. If true, changes are permitted.

numberOfDaysBeforeCheckIn: The number of days before check in when changes are permitted.

cancelPenalties

Array of objects describing the cancel penalties associated with this rate. Properties:

deadlineLocal: The local date and time of the deadline of the cancel penalty.

estimatedDeadlineLocal: Boolean. If true, the deadline is estimated.

cancelShortDescription: A short description of the cancel penalty.

penaltyNotes: Array of notes about the penalty, maximum of 512 characters.

Includes penalty object.

penalty

Definition of penalty imposed with cancel policy. Properties:

estimatedAmount: Boolean. Default is false. If true, the penalty amount is an estimated amount.

originalPenaltyInfo: If estimatedAmount is true, the original provider cancel penalty (nights, percent) information will be added here as text.

Includes currencyAmount object.

currencyAmount

The currency code and amount of the penalty. Properties:

amount: The penalty amount in decimal form.

currency: Standard three-character currency code.

lengthOfStay

Object defining max/min night restrictions. Properties:

minNightCount: The minimum number of nights the guest must stay.

maxNightCount: The maximum number of nights the guest can stay.

extraAccommodations

Extra accommodation object. Properties:

quantity: The quantity of the extra accomodation.

accommodationType: The type of the extra accommodation.

Supported values:

  • Crib

  • ExtraAdult

  • ExtraChild

  • RollawayAdult

  • RollawayChild

credit

Object defining what rate credit is accrued. Properties:

creditType: The type of the rate credit.

frequency: The frequency of the rate credit. Per stay, daily, per person.

Includes value object.

value

Object representing the monetary amount of the credit that can be applied to the next reservation. Properties:

amount: The credit amount in decimal form.

currency: Standard three-letter currency code.

 

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.

{
    "stayDetails": {
        "checkInDateLocal": "2025-10-30",
        "checkOutDateLocal": "2025-10-31",
        "rooms": 1,
        "guests": {
            "adults": 1
        }
    },
    "propertyFilter": {
        "location": {
            "type": "coordinates",
            "details": {
                "latitude": 51.5073,
                "longitude": -0.1277
            },
            "radius": {
                "value": 10,
                "unit": "mi"
            }
        }
    }
}
{
 "stayDetails": {
  "checkInDateLocal": "2025-10-30",
  "checkOutDateLocal": "2025-10-31",
  "rooms": 1,
  "guests": {
   "adults": 1
  }
 },
 "propertyFilter": {
  "location": {
   "type": "address",
   "details": {
    "countryCode": "GB",
    "cityName": "Liverpool"
   },
   "radius": {
    "value": 15,
    "unit": "mi"
   }
  }
 }
}
{
 "requestedCurrency": "EUR",
 "stayDetails": {
  "checkInDateLocal": "2025-10-30",
  "checkOutDateLocal": "2025-10-31",
  "rooms": 1,
  "guests": {
   "adults": 1
  }
 },
 "propertyFilter": {
  "propertyKeys": [
   {
    "chainCode": "HI",
    "propertyCode": "17424"
   },
   {
    "chainCode": "UR",
    "propertyCode": "G3375"
   }
  ]
 }
}