You can perform searches using the propertyIDs to get the data you need. The DOCS tab on the Search Playground provides more details.
Note: We do not support searches by location and region.
See it Live
Use the samples provided here and perform live searches on the Search Playground. For list a list of valid sample properties, refer to the Schema and Docs page.
Schema - getPropertiesByIds
type SearchCriteriaByIdsInput: {
propertyIds: [Integer]
occupancies: [Occupancy]
filterBy: [RoomRateFilter]
}
This operation allows you to search for property rates and availability based on the specified propertyIds.
The propertyIds field is mandatory. If it is missing, an error code 1081 is thrown. For more information on the list of error codes, see the Error Codes page.
Query Variables
Below are sample query variables that you should use to perform the search.
Single PropertyID
{
"SearchCriteriaByIds": {
"propertyIds": [
22561686
],
"occupancies": [
{
"checkInDate": "2025-02-19",
"checkOutDate": "2025-02-20",
"guestAges": "45,55"
}
],
"filterBy": {
"includeNREF": "true",
"rateType": "ALL_RATES_PER_ROOM"
}
}
}
Multiple PropertyIDs
{
"SearchCriteriaByIds": {
"propertyIds": [
22561682,
22561686
],
"occupancies": [
{
"checkInDate": "2025-02-11",
"checkOutDate": "2025-02-12",
"guestAges": "25,22"
}
],
"filterBy": {
"includeNREF": "true",
"rateType": "CHEAPEST_RATE_AMONG_ALL_ROOMS"
}
}
}
Sample Request
In this sample, all possible fields are being retrieved. You can choose which fields you need to retrieve in your search.
The search method has a few mandatory fields. See the Mandatory vs. Optional Attributes page for a complete list of mandatory attributes.
query getPropertiesByIds($SearchCriteriaByIds: SearchCriteriaByIdsInput) {
getPropertiesByIds(searchCriteriaByIds: $SearchCriteriaByIds) {
properties {
propertyId
propertyName
occupancies {
occupancyRefId
checkInDate
checkOutDate
guestAges
}
rooms {
occupancyRefId
htIdentifier
roomName
roomCode
rateplanTag
shortDescription
numRoomsAvail
longDescription
consolidatedComments
paymentType
rateInfo {
bar
binding
commissionable
commissionAmount
currency
netPrice
tax
currency
grossPrice
payAtProperty
dailyPrice
dailyTax
aggregateTaxInfo {
payAtBooking {
name
value
currency
description
}
payAtProperty {
name
currency
value
}
}
taxInfo {
payAtBooking {
date
name
currency
description
value
}
payAtProperty {
date
name
currency
description
value
}
}
}
mealplanOptions {
mealplanDescription
mealplanCode
mealplanName
}
refundable
includeNREF
rateType
cancellationPolicies {
startWindowTime
endWindowTime
cancellationCharge
currency
timeZone
timeZoneUTC
}
}
shortDescription
longDescription
city
latitude
longitude
starRating
hotelImageUrl
}
}
}
Sample Response
Single PropertyID Search Response
{
"data": {
"getPropertiesByIds": {
"properties": [
{
"propertyId": 22561686,
"propertyName": "Dingus Property 1302",
"occupancies": [
{
"occupancyRefId": 1,
"checkInDate": "2025-02-19",
"checkOutDate": "2025-02-20",
"numberOfAdults": 2,
"numberOfChildren": 0,
"childrenAges": null,
"guestAges": "45,55"
}
],
"rooms": [
{
"occupancyRefId": 1,
"htIdentifier": "61315162|1311191314151|1419151318131|121012151-10121-11191|121012151-10121-12101|1a1e171f1b1e12191-1f1815171-143e1-1b12101c1-12161d19111e1d1a1c18131b1|1117131918172014121310121|111|XR8s8zYSJlhOBtb6KQsjvw==|RvyNmvpK5kegJHZaK2TYkw==",
"roomName": "Room5",
"shortDescription": "Test",
"longDescription": "",
"paymentType": "DIRECT_BILL",
"consolidatedComments": "",
"roomCode": "R5",
"rateplanTag": "HTFIT-17",
"numRoomsAvail": 20,
"rateInfo": {
"bar": null,
"binding": null,
"commissionable": null,
"commissionAmount": null,
"currency": "USD",
"netPrice": 81.0,
"tax": 1.0,
"grossPrice": 82.0,
"payAtProperty": 0,
"dailyPrice": [81.0],
"dailyTax": [1.0],
"aggregateTaxInfo": {
"payAtBooking": [
{
"description": null,
"name": "T3",
"currency": "USD",
"value": 1.0
}
],
"payAtProperty": []
}
},
"mealplanOptions": {
"mealplanDescription": "Room Only",
"mealplanCode": "RO",
"mealplanName": "Room Only"
},
"refundable": true,
"cancellationPolicies": [
{
"startWindowTime": "2025-02-17 15:00:00",
"endWindowTime": "2025-02-19 15:00:00",
"cancellationCharge": 82.0,
"currency": "USD",
"timeZone": "America/New_York"
}
]
},
{
"occupancyRefId": 1,
"htIdentifier": "61315162|13111913281|1419151318111|121012151-10121-11191|121012151-10121-12101|1a1e171f1b1e12191-1f1815171-143e1-1b12101c1-12161d19111e1d1a1c18131b1|1117131918172014121310121|111|XR8s8zYSJlhOBtb6KQsjvw==|RvyNmvpK5kegJHZaK2TYkw==",
"roomName": "Room3",
"shortDescription": "Test",
"longDescription": "",
"paymentType": "DIRECT_BILL",
"consolidatedComments": "All Inclusive. ",
"roomCode": "R3",
"rateplanTag": "HTFIT-10",
"numRoomsAvail": 20,
"rateInfo": {
"bar": null,
"binding": null,
"commissionable": null,
"commissionAmount": null,
"currency": "USD",
"netPrice": 131.0,
"tax": 1.0,
"grossPrice": 132.0,
"payAtProperty": 0,
"dailyPrice": [131.0],
"dailyTax": [1.0],
"aggregateTaxInfo": {
"payAtBooking": [
{
"description": null,
"name": "T3",
"currency": "USD",
"value": 1.0
}
],
"payAtProperty": []
}
},
"mealplanOptions": {
"mealplanDescription": "All Inclusive",
"mealplanCode": "RO",
"mealplanName": "Room Only"
},
"refundable": true,
"cancellationPolicies": [
{
"startWindowTime": "2025-02-19 15:00:00",
"endWindowTime": "2025-02-19 18:00:00",
"cancellationCharge": 26.4,
"currency": "USD",
"timeZone": "America/New_York"
}
]
},
{
"occupancyRefId": 1,
"htIdentifier": "61315162|1311191312131|14191513142|121012151-10121-11191|121012151-10121-12101|1a1e171f1b1e12191-1f1815171-143e1-1b12101c1-12161d19111e1d1a1c18131b1|1117131918172014121310141|111|XR8s8zYSJlhOBtb6KQsjvw==|RvyNmvpK5kegJHZaK2TYkw==",
"roomName": "Room 2 Double Occupancy",
"shortDescription": "Dummy Desc",
"longDescription": null,
"paymentType": "DIRECT_BILL",
"consolidatedComments": "BF included. ",
"roomCode": "R2",
"rateplanTag": "HTFIT-6",
"numRoomsAvail": 20,
"rateInfo": {
"bar": null,
"binding": null,
"commissionable": null,
"commissionAmount": null,
"currency": "USD",
"netPrice": 171.0,
"tax": 1.0,
"grossPrice": 172.0,
"payAtProperty": 0,
"dailyPrice": [171.0],
"dailyTax": [1.0],
"aggregateTaxInfo": {
"payAtBooking": [
{
"description": null,
"name": "T3",
"currency": "USD",
"value": 1.0
}
],
"payAtProperty": []
}
},
"mealplanOptions": {
"mealplanDescription": "BF included",
"mealplanCode": "BBF",
"mealplanName": "Free Breakfast"
},
"refundable": true,
"cancellationPolicies": [
{
"startWindowTime": "2025-02-17 15:00:00",
"endWindowTime": "2025-02-19 15:00:00",
"cancellationCharge": 172.0,
"currency": "USD",
"timeZone": "America/New_York"
}
]
}
],
"shortDescription": "Test short hotel description",
"longDescription": "Test hotel long description",
"city": "New York",
"latitude": "40.75905",
"longitude": "-73.98844",
"starRating": 4.0,
"hotelImageUrl": null
}
]
}
}
}
Multiple PropertyID Sample Response
{
"data": {
"getPropertiesByIds": {
"properties": [
{
"propertyId": 22561682,
"propertyName": "Dingus Property 1301",
"occupancies": [
{
"occupancyRefId": 1,
"checkInDate": "2025-02-11",
"checkOutDate": "2025-02-12",
"numberOfAdults": 2,
"numberOfChildren": 0,
"childrenAges": null,
"guestAges": "25,22"
}
],
"rooms": [
{
"occupancyRefId": 1,
"htIdentifier": "6131516121|1311191310121|1419151219141|121012151-10121-112|121012151-10121-11121|171e1d10121b131f1-1510171c1-14161d171-191a18121-1210121e141d171c171a131c1|1117131912111617121915221|111|XR8s8zYSJlhOBtb6KQsjvw==|RvyNmvpK5kegJHZaK2TYkw==",
"roomName": "Room 1 Monoparental",
"shortDescription": "Dummy Desc",
"longDescription": null,
"paymentType": "DIRECT_BILL",
"consolidatedComments": "A Resort Fee totaling USD110.00 will be charged for the stay.",
"roomCode": "R1-MONO",
"rateplanTag": "HTFIT-NO",
"numRoomsAvail": 20,
"rateInfo": {
"bar": null,
"binding": null,
"commissionable": null,
"commissionAmount": null,
"currency": "USD",
"netPrice": 80.00,
"tax": 64.00,
"grossPrice": 144.00,
"payAtProperty": 110.00,
"dailyPrice": [
80.00
],
"dailyTax": [
64.00
],
"aggregateTaxInfo": {
"payAtBooking": [
{
"description": null,
"name": "T3",
"currency": "USD",
"value": 64.00
}
],
"payAtProperty": [
{
"description": "",
"name": "T1",
"currency": "USD",
"value": 110.00
}
]
}
},
"mealplanOptions": {
"mealplanDescription": "Room Only",
"mealplanCode": "RO",
"mealplanName": "Room Only"
},
"refundable": false,
"cancellationPolicies": null
},
{
"occupancyRefId": 1,
"htIdentifier": "6131516121|1311191216171|1419151219141|121012151-10121-112|121012151-10121-11121|171e1d10121b131f1-1510171c1-14161d171-191a18121-1210121e141d171c171a131c1|1117131912111617121915221|111|XR8s8zYSJlhOBtb6KQsjvw==|RvyNmvpK5kegJHZaK2TYkw==",
"roomName": "Room 1 Monoparental",
"shortDescription": "Dummy Desc",
"longDescription": null,
"paymentType": "DIRECT_BILL",
"consolidatedComments": "Breakfast for 2 guests. A Resort Fee totaling USD122.00 will be charged for the stay.",
"roomCode": "R1-MONO",
"rateplanTag": "HTFIT-BB",
"numRoomsAvail": 20,
"rateInfo": {
"bar": null,
"binding": null,
"commissionable": null,
"commissionAmount": null,
"currency": "USD",
"netPrice": 120.00,
"tax": 96.00,
"grossPrice": 216.00,
"payAtProperty": 122.00,
"dailyPrice": [
120.00
],
"dailyTax": [
96.00
],
"aggregateTaxInfo": {
"payAtBooking": [
{
"description": null,
"name": "T3",
"currency": "USD",
"value": 96.00
}
],
"payAtProperty": [
{
"description": "",
"name": "T2",
"currency": "USD",
"value": 12.00
},
{
"description": "",
"name": "T1",
"currency": "USD",
"value": 110.00
}
]
}
},
"mealplanOptions": {
"mealplanDescription": "Breakfast for 2 guests",
"mealplanCode": "BBF",
"mealplanName": "Free Breakfast"
},
"refundable": true,
"cancellationPolicies": [
{
"startWindowTime": "2025-02-09 15:00:00",
"endWindowTime": "2025-02-11 15:00:00",
"cancellationCharge": 216.00,
"currency": "USD",
"timeZone": "America/New_York"
}
]
}
],
"shortDescription": "Test short hotel description",
"longDescription": "Test hotel long description",
"city": "New York",
"latitude": "40.75905",
"longitude": "-73.98844",
"starRating": 4.0,
"hotelImageUrl": null
},
{
"propertyId": 22561686,
"propertyName": "Test Property 1302",
"occupancies": [
{
"occupancyRefId": 1,
"checkInDate": "2025-02-11",
"checkOutDate": "2025-02-12",
"numberOfAdults": 2,
"numberOfChildren": 0,
"childrenAges": null,
"guestAges": "25,22"
}
],
"rooms": [
{
"occupancyRefId": 1,
"htIdentifier": "61315162|1311191310171|14191513142|121012151-10121-112|121012151-10121-11121|171e1d10121b131f1-1510171c1-14161d171-191a18121-1210121e141d171c171a131c1|11171319121116171219153|111|XR8s8zYSJlhOBtb6KQsjvw==|RvyNmvpK5kegJHZaK2TYkw==",
"roomName": "Room 2 Double Occupancy",
"shortDescription": "Dummy Desc",
"longDescription": null,
"paymentType": "DIRECT_BILL",
"consolidatedComments": "",
"roomCode": "R2",
"rateplanTag": "HTFIT",
"numRoomsAvail": 20,
"rateInfo": {
"bar": null,
"binding": null,
"commissionable": null,
"commissionAmount": null,
"currency": "USD",
"netPrice": 110.00,
"tax": 10.00,
"grossPrice": 120.00,
"payAtProperty": 0,
"dailyPrice": [
110.00
],
"dailyTax": [
10.00
],
"aggregateTaxInfo": {
"payAtBooking": [
{
"description": null,
"name": "T3",
"currency": "USD",
"value": 10.00
}
],
"payAtProperty": []
}
},
"mealplanOptions": {
"mealplanDescription": "Room Only",
"mealplanCode": "RO",
"mealplanName": "Room Only"
},
"refundable": true,
"cancellationPolicies": [
{
"startWindowTime": "2025-02-09 15:00:00",
"endWindowTime": "2025-02-11 15:00:00",
"cancellationCharge": 120.00,
"currency": "USD",
"timeZone": "America/New_York"
}
]
}
],
"shortDescription": "Test short hotel description",
"longDescription": "Test hotel long description",
"city": "New York",
"latitude": "40.75905",
"longitude": "-73.98844",
"starRating": 4.0,
"hotelImageUrl": null
}
]
}
}
}