SearchHotelPrices
Version 5.1 by Giorgi Mdivnishvili on 2023/12/14 12:20
Contents
Method Description
The initial method of the integration process is authorization. You will be provided with a test user username and password to generate the access token that you will need to pass in all the following methods.
Endpoint URL - [POST]
Request Parameters
Request Body
{
"countryCode": "string",
"locations": [
{
"type": "string",
"parent": "string",
"label": "string",
"subLabel": "string",
"value": "string",
"tag": "string"
}
],
"checkInDate": "2023-12-14T08:09:42.770Z",
"checkInDateTo": "2023-12-14T08:09:42.770Z",
"checkOutDate": "2023-12-14T08:09:42.770Z",
"stayDays": 0,
"stayDaysTo": 0,
"adults": 0,
"children": 0,
"childrenAges": [
0
],
"extendedSearch": true,
"totalPriceFrom": 0,
"totalPriceTo": 0,
"recommended": true,
"popular": true,
"freeSale": true,
"groupByHotel": true,
"hotelCodes": [
"string"
],
"mealPlans": [
"string"
],
"hotelClasses": [
"string"
],
"hotelTypes": [
"CityHotel"
],
"hotelServices": [
"HasAlcohol"
],
"pagingId": "string",
"pageNumber": 0,
"pageRowCount": 0
}
"countryCode": "string",
"locations": [
{
"type": "string",
"parent": "string",
"label": "string",
"subLabel": "string",
"value": "string",
"tag": "string"
}
],
"checkInDate": "2023-12-14T08:09:42.770Z",
"checkInDateTo": "2023-12-14T08:09:42.770Z",
"checkOutDate": "2023-12-14T08:09:42.770Z",
"stayDays": 0,
"stayDaysTo": 0,
"adults": 0,
"children": 0,
"childrenAges": [
0
],
"extendedSearch": true,
"totalPriceFrom": 0,
"totalPriceTo": 0,
"recommended": true,
"popular": true,
"freeSale": true,
"groupByHotel": true,
"hotelCodes": [
"string"
],
"mealPlans": [
"string"
],
"hotelClasses": [
"string"
],
"hotelTypes": [
"CityHotel"
],
"hotelServices": [
"HasAlcohol"
],
"pagingId": "string",
"pageNumber": 0,
"pageRowCount": 0
}
Request Body example
{
"countryCode": "AE",
"checkInDate": "2024-02-15T08:00:00.000Z",
"checkInDateTo": "2024-02-20T08:00:00.000Z",
"stayDays": 4,
"stayDaysTo": 6,
"adults": 1,
"children": 1,
"childrenAges": [
1
],
"extendedSearch": false,
"totalPriceFrom": 10,
"totalPriceTo": 10000,
"recommended": false,
"popular": true,
"freeSale": true,
"groupByHotel": true,
"hotelCodes": [
],
"mealPlans": [
],
"hotelClasses": [
],
"hotelTypes": [
],
"hotelServices": [
],
"pagingId": "",
"pageNumber": 3,
"pageRowCount": 10
}
"countryCode": "AE",
"checkInDate": "2024-02-15T08:00:00.000Z",
"checkInDateTo": "2024-02-20T08:00:00.000Z",
"stayDays": 4,
"stayDaysTo": 6,
"adults": 1,
"children": 1,
"childrenAges": [
1
],
"extendedSearch": false,
"totalPriceFrom": 10,
"totalPriceTo": 10000,
"recommended": false,
"popular": true,
"freeSale": true,
"groupByHotel": true,
"hotelCodes": [
],
"mealPlans": [
],
"hotelClasses": [
],
"hotelTypes": [
],
"hotelServices": [
],
"pagingId": "",
"pageNumber": 3,
"pageRowCount": 10
}
Response Body
[
{
"hotelCode": "string",
"hotelName": "string",
"hotelClass": "string",
"cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"countryCode": "string",
"countryName": "string",
"districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"cityName": "string",
"districtName": "string",
"hotelType": "CityHotel",
"latitude": "string",
"longitude": "string",
"hasAlcohol": true,
"hasFreeWifi": true,
"hasMetro": true,
"hasPool": true,
"hasMall": true
}
]
{
"hotelCode": "string",
"hotelName": "string",
"hotelClass": "string",
"cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"countryCode": "string",
"countryName": "string",
"districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"cityName": "string",
"districtName": "string",
"hotelType": "CityHotel",
"latitude": "string",
"longitude": "string",
"hasAlcohol": true,
"hasFreeWifi": true,
"hasMetro": true,
"hasPool": true,
"hasMall": true
}
]
Response Body example
{
"packages": [
{
"id": "onlyhotel:c4e23e7e-3d54-4efa-a3db-88508230ce91:504f63ca-6dd5-4d84-8245-cf7e77ccff73",
"priceCurrency": "USD",
"totalPrice": 381.7,
"agentCommissionPercent": 0.0,
"agentCommissionAmount": 0.0,
"hotel": {
"hotelPriceId": "504f63ca-6dd5-4d84-8245-cf7e77ccff73",
"providerId": 13,
"hotelName": "Golden Tulip Al Barsha Hotel",
"hotelCode": "ed0820c5-29b0-4e1b-8bcf-9f3c181e7961",
"nigths": 4,
"mealPlan": "RO",
"hotelClass": "4",
"availabilityType": "FreeSale",
"availableRoomsCount": 0,
"fewRooms": true,
"roomCategoryCode": "e63ea5ac-4883-4059-bb0a-795a534bbbfb",
"roomCategoryName": "Superior Twin",
"placementTypeName": "SNGL + CHILD(6-11.99)sharing",
"checkInDate": "2024-02-17T08:00:00.000Z",
"checkOutDate": "2024-02-21T08:00:00.000Z",
"adults": 1,
"children": 1,
"districtUID": "4c65f6ed-902b-4fd8-9419-af7884c22c5e",
"districtName": "Al Barsha",
"cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
"cityName": "Dubai",
"countryCode": "AE",
"countryName": "United Arab Emirates",
"hasAlcohol": true,
"hasFreeWifi": true,
"hasMetro": false,
"hasPool": true,
"hasMall": false,
"cancellationPolicyDescription": "Cancellation Policy: 15 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %",
"cancellationPolicy": {
"noShowChargeValue": 100.0,
"noShowChargeValueType": "%",
"earlyDepartureChargeValue": 100.0,
"earlyDepartureChargeValueType": "%",
"conditions": [
{
"timeunits": 15,
"timeunitType": "Day",
"timeOffsetTypeName": "Before Arrival",
"chargeValue": 100.0,
"chargeValueType": "%"
}
]
}
},
"extraServices": []
},
"packages": [
{
"id": "onlyhotel:c4e23e7e-3d54-4efa-a3db-88508230ce91:504f63ca-6dd5-4d84-8245-cf7e77ccff73",
"priceCurrency": "USD",
"totalPrice": 381.7,
"agentCommissionPercent": 0.0,
"agentCommissionAmount": 0.0,
"hotel": {
"hotelPriceId": "504f63ca-6dd5-4d84-8245-cf7e77ccff73",
"providerId": 13,
"hotelName": "Golden Tulip Al Barsha Hotel",
"hotelCode": "ed0820c5-29b0-4e1b-8bcf-9f3c181e7961",
"nigths": 4,
"mealPlan": "RO",
"hotelClass": "4",
"availabilityType": "FreeSale",
"availableRoomsCount": 0,
"fewRooms": true,
"roomCategoryCode": "e63ea5ac-4883-4059-bb0a-795a534bbbfb",
"roomCategoryName": "Superior Twin",
"placementTypeName": "SNGL + CHILD(6-11.99)sharing",
"checkInDate": "2024-02-17T08:00:00.000Z",
"checkOutDate": "2024-02-21T08:00:00.000Z",
"adults": 1,
"children": 1,
"districtUID": "4c65f6ed-902b-4fd8-9419-af7884c22c5e",
"districtName": "Al Barsha",
"cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
"cityName": "Dubai",
"countryCode": "AE",
"countryName": "United Arab Emirates",
"hasAlcohol": true,
"hasFreeWifi": true,
"hasMetro": false,
"hasPool": true,
"hasMall": false,
"cancellationPolicyDescription": "Cancellation Policy: 15 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %",
"cancellationPolicy": {
"noShowChargeValue": 100.0,
"noShowChargeValueType": "%",
"earlyDepartureChargeValue": 100.0,
"earlyDepartureChargeValueType": "%",
"conditions": [
{
"timeunits": 15,
"timeunitType": "Day",
"timeOffsetTypeName": "Before Arrival",
"chargeValue": 100.0,
"chargeValueType": "%"
}
]
}
},
"extraServices": []
},
Schema
SearchOnlyHotelPackagesResponse{
packages [
nullable: true
OnlyHotelPackage{
id string
nullable: true
priceCurrency string
nullable: true
totalPrice number($double)
agentCommissionPercent number($double)
agentCommissionAmount number($double)
hotel PackageHotel{
hotelPriceId string
nullable: true
providerId integer($int32)
hotelName string
nullable: true
hotelCode string
nullable: true
nigths integer($int32)
mealPlan string
nullable: true
hotelClass string
nullable: true
availabilityType RoomAvailabilityTypeEnumstring
Enum:
[ OnRequest, FreeSale, StopSale ]
availableRoomsCount integer($int32)
fewRooms boolean
roomCategoryCode string
nullable: true
roomCategoryName string
nullable: true
placementTypeName string
nullable: true
placementDescription string
nullable: true
checkInDate string($date-time)
checkOutDate string($date-time)
adults integer($int32)
children integer($int32)
districtUID string($uuid)
nullable: true
districtName string
nullable: true
cityUID string($uuid)
nullable: true
cityName string
nullable: true
countryCode string
nullable: true
countryName string
nullable: true
hasAlcohol boolean
hasFreeWifi boolean
hasMetro boolean
hasPool boolean
hasMall boolean
cancellationPolicyDescription string
nullable: true
cancellationPolicy CancellationPolicyExchange{
cancellationPolicyCode string
nullable: true
noShowChargeValue number($double)
nullable: true
noShowChargeValueType string
nullable: true
earlyDepartureChargeValue number($double)
nullable: true
earlyDepartureChargeValueType string
nullable: true
conditions [
nullable: true
CancellationPolicyConditionExchange{
timeunits integer($int32)
timeunitType string
nullable: true
timeOffsetTypeName string
nullable: true
chargeValue number($double)
nullable: true
chargeValueType string
nullable: true
}]
}
}
extraServices [
nullable: true
HotelExtraServiceBase{
extraServiceCode string
nullable: true
extraServiceTypeCode string
nullable: true
isMandatory integer($int32)
extraServiceName string
nullable: true
minimalServiceAmount number($double)
includedPriceCode string
nullable: true
prices [
nullable: true
HotelExtraServicePriceBase{
extraServicePriceCode string
nullable: true
displayName string
nullable: true
restrictionInfo string
nullable: true
additionalInfo string
nullable: true
price number($double)
extraPrice number($double)
currency string
nullable: true
}]
}]
}]
pagingId string
nullable: true
pageNumber integer($int64)
pageCount integer($int64)
}
packages [
nullable: true
OnlyHotelPackage{
id string
nullable: true
priceCurrency string
nullable: true
totalPrice number($double)
agentCommissionPercent number($double)
agentCommissionAmount number($double)
hotel PackageHotel{
hotelPriceId string
nullable: true
providerId integer($int32)
hotelName string
nullable: true
hotelCode string
nullable: true
nigths integer($int32)
mealPlan string
nullable: true
hotelClass string
nullable: true
availabilityType RoomAvailabilityTypeEnumstring
Enum:
[ OnRequest, FreeSale, StopSale ]
availableRoomsCount integer($int32)
fewRooms boolean
roomCategoryCode string
nullable: true
roomCategoryName string
nullable: true
placementTypeName string
nullable: true
placementDescription string
nullable: true
checkInDate string($date-time)
checkOutDate string($date-time)
adults integer($int32)
children integer($int32)
districtUID string($uuid)
nullable: true
districtName string
nullable: true
cityUID string($uuid)
nullable: true
cityName string
nullable: true
countryCode string
nullable: true
countryName string
nullable: true
hasAlcohol boolean
hasFreeWifi boolean
hasMetro boolean
hasPool boolean
hasMall boolean
cancellationPolicyDescription string
nullable: true
cancellationPolicy CancellationPolicyExchange{
cancellationPolicyCode string
nullable: true
noShowChargeValue number($double)
nullable: true
noShowChargeValueType string
nullable: true
earlyDepartureChargeValue number($double)
nullable: true
earlyDepartureChargeValueType string
nullable: true
conditions [
nullable: true
CancellationPolicyConditionExchange{
timeunits integer($int32)
timeunitType string
nullable: true
timeOffsetTypeName string
nullable: true
chargeValue number($double)
nullable: true
chargeValueType string
nullable: true
}]
}
}
extraServices [
nullable: true
HotelExtraServiceBase{
extraServiceCode string
nullable: true
extraServiceTypeCode string
nullable: true
isMandatory integer($int32)
extraServiceName string
nullable: true
minimalServiceAmount number($double)
includedPriceCode string
nullable: true
prices [
nullable: true
HotelExtraServicePriceBase{
extraServicePriceCode string
nullable: true
displayName string
nullable: true
restrictionInfo string
nullable: true
additionalInfo string
nullable: true
price number($double)
extraPrice number($double)
currency string
nullable: true
}]
}]
}]
pagingId string
nullable: true
pageNumber integer($int64)
pageCount integer($int64)
}