Room Availibility
Returns rates and availability on all room types for specified properties. Multiple rooms of the same type may be requested by including multiple instances of the occupancy parameter. No more than 8 rooms may be requested at a time - if you need to book more than 8 rooms at once, please consult with your account manager about our group booking partnership.
Parameters
Name
Description
Accept
string
( header )
*required application/json
Accept - Encoding
string
( header )
*required gzip
Authorization
string
( header )
*required Your PID
*required Your API Key
Customer-Ip
string
( header )
*required IP address of the customer, as captured by your integration. Send IPV4 addresses only.
Ensure your integration passes the customer’s IP, not your own. This value helps determine their location and other settings.
Also used for fraud recovery and other important analytics.
apiKey
string
( query )
*required a valid API Key
The API Key provided to you is critical to the security of your request data – treat it like a password. Never include the raw value in any publicly accessible site or app code. You will be provided with an API key when you are approved to integrate TPS API.
ModeType
string
( query )
*required either "Test" or "LIVE"
Your application *needs an approval from adivaha® Personnel.
pid
string
( query )
*required "{Your Partner ID}" as a parameter
action
string
( query )
*required "roomAvalibility" as a parameter
ResultIndex
string
( query )
*required The ResultIndex of the property you want to gather information for.
hotelId
string
( query )
*required The ID of the property you want to gather information for.
TraceId
string
( query )
*required The TraceId of the property you want to gather information for.
Trace id is valid for 15 Minutes only and should be same throughout the booking process.
REQUEST
API Endpoint: https://your-end-point/api/v1/travel-api/hotels/
header: array(
'Content-Type:application/json',
'Accept-encoding: gzip',
'PID:'ADD-YOUR-PID',
'x-api-key:'ADD-YOUR-KEY'
);
POST:
{
"action": "roomAvalibility",
"mode": "Test",
"ResultIndex": "3",
"hotelId": "31620301",
"TraceId": "8e3db358-d185-4eda-a81d-15dcdba77217"
}
Response
The API returns an HTTP response, which generally includes the result of the request invocation
{
"status": "200",
"status_message": "OK",
"responseData": {
"GetHotelRoomResult": {
"ResponseStatus": 1,
"Error": {
"ErrorCode": 0,
"ErrorMessage": ""
},
"TraceId": "8e3db358-d185-4eda-a81d-15dcdba77217",
"IsUnderCancellationAllowed": true,
"IsPolicyPerStay": false,
"HotelRoomsDetails": [
{
"AvailabilityType": "Confirm",
"ChildCount": 0,
"RequireAllPaxDetails": true,
"RoomId": 0,
"RoomStatus": 0,
"RoomIndex": 4,
"RoomTypeCode": "214522545|250132887$37407^^1^^214522545|250132887|37407|141~!:~4",
"RoomDescription": "16 Bed Mixed Dorm Ac,1 Twin Bunk Bed,Nonsmoking",
"RoomTypeName": "16 Bed Mixed Dorm Ac,1 Twin Bunk Bed,Nonsmoking",
"RatePlanCode": "214522545|250132887|37407|141",
"RatePlan": 0,
"RatePlanName": "Free WiFi ",
"InfoSource": "FixedCombination",
"SequenceNo": "TH~~31620301~4",
"DayRates": [
{
"Amount": 386.32,
"Date": "2021-09-16T00:00:00"
}
],
"IsPerStay": false,
"SupplierPrice": null,
"Price": {
"CurrencyCode": "INR",
"RoomPrice": 386.32,
"Tax": 8.57,
"ExtraGuestCharge": 0,
"ChildCharge": 0,
"OtherCharges": 59.27,
"Discount": 0,
"PublishedPrice": 454.16,
"PublishedPriceRoundedOff": 454,
"OfferedPrice": 454.16,
"OfferedPriceRoundedOff": 454,
"AgentCommission": 0,
"AgentMarkUp": 0,
"ServiceTax": 16.43,
"TCS": 0,
"TDS": 0,
"ServiceCharge": 0,
"TotalGSTAmount": 16.43,
"GST": {
"CGSTAmount": 0,
"CGSTRate": 0,
"CessAmount": 5.71,
"CessRate": 10,
"IGSTAmount": 10.71,
"IGSTRate": 18,
"SGSTAmount": 0,
"SGSTRate": 0,
"TaxableAmount": 59.24
}
},
"RoomPromotion": "",
"Amenities": [
"Free WiFi "
],
"Amenity": [
"Free WiFi "
],
"SmokingPreference": "NoPreference",
"BedTypes": [],
"HotelSupplements": [],
"LastCancellationDate": "2021-08-10T23:59:59",
"CancellationPolicies": [
{
"Charge": 100,
"ChargeType": 2,
"Currency": "INR",
"FromDate": "2021-08-11T00:00:00",
"ToDate": "2021-09-05T23:59:59"
},
{
"Charge": 100,
"ChargeType": 2,
"Currency": "INR",
"FromDate": "2021-09-06T00:00:00",
"ToDate": "2021-09-17T23:59:59"
}
],
"LastVoucherDate": "2021-08-11T00:00:00",
"CancellationPolicy": "16 Bed Mixed Dorm Ac,1 Twin Bunk Bed,Nonsmoking#^#100.00% of total amount will be charged, If cancelled between 11-Aug-2021 00:00:00 and 05-Sep-2021 23:59:59.|100.00% of total amount will be charged, If cancelled between 06-Sep-2021 00:00:00 and 17-Sep-2021 23:59:59.|#!#",
"Inclusion": [
"Free WiFi "
],
"IsPassportMandatory": false,
"IsPANMandatory": true
},
{
"AvailabilityType": "Confirm",
"ChildCount": 0,
"RequireAllPaxDetails": true,
"RoomId": 0,
"RoomStatus": 0,
"RoomIndex": 5,
"RoomTypeCode": "214522540|250132890$37407^^1^^214522540|250132890|37407|141~!:~5",
"RoomDescription": "8 Bed Mixed Dorm Non Ac,1 Twin Bunk Bed,Nonsmoking",
"RoomTypeName": "8 Bed Mixed Dorm Non Ac,1 Twin Bunk Bed,Nonsmoking",
"RatePlanCode": "214522540|250132890|37407|141",
"RatePlan": 0,
"RatePlanName": "Free WiFi ",
"InfoSource": "FixedCombination",
"SequenceNo": "TH~~31620301~5",
"DayRates": [
{
"Amount": 386.32,
"Date": "2021-09-16T00:00:00"
}
],
"IsPerStay": false,
"SupplierPrice": null,
"Price": {
"CurrencyCode": "INR",
"RoomPrice": 386.32,
"Tax": 8.57,
"ExtraGuestCharge": 0,
"ChildCharge": 0,
"OtherCharges": 59.27,
"Discount": 0,
"PublishedPrice": 454.16,
"PublishedPriceRoundedOff": 454,
"OfferedPrice": 454.16,
"OfferedPriceRoundedOff": 454,
"AgentCommission": 0,
"AgentMarkUp": 0,
"ServiceTax": 16.43,
"TCS": 0,
"TDS": 0,
"ServiceCharge": 0,
"TotalGSTAmount": 16.43,
"GST": {
"CGSTAmount": 0,
"CGSTRate": 0,
"CessAmount": 5.71,
"CessRate": 10,
"IGSTAmount": 10.71,
"IGSTRate": 18,
"SGSTAmount": 0,
"SGSTRate": 0,
"TaxableAmount": 59.24
}
},
"RoomPromotion": "",
"Amenities": [
"Free WiFi "
],
"Amenity": [
"Free WiFi "
],
"SmokingPreference": "NoPreference",
"BedTypes": [],
"HotelSupplements": [],
"LastCancellationDate": "2021-08-10T23:59:59",
"CancellationPolicies": [
{
"Charge": 100,
"ChargeType": 2,
"Currency": "INR",
"FromDate": "2021-08-11T00:00:00",
"ToDate": "2021-09-05T23:59:59"
},
{
"Charge": 100,
"ChargeType": 2,
"Currency": "INR",
"FromDate": "2021-09-06T00:00:00",
"ToDate": "2021-09-17T23:59:59"
}
],
"LastVoucherDate": "2021-08-11T00:00:00",
"CancellationPolicy": "8 Bed Mixed Dorm Non Ac,1 Twin Bunk Bed,Nonsmoking#^#100.00% of total amount will be charged, If cancelled between 11-Aug-2021 00:00:00 and 05-Sep-2021 23:59:59.|100.00% of total amount will be charged, If cancelled between 06-Sep-2021 00:00:00 and 17-Sep-2021 23:59:59.|#!#",
"Inclusion": [
"Free WiFi "
],
"IsPassportMandatory": false,
"IsPANMandatory": true
}
],
"RoomCombinations": {
"InfoSource": "FixedCombination",
"IsPolicyPerStay": false,
"RoomCombination": [
{
"RoomIndex": [
4
]
},
{
"RoomIndex": [
5
]
}
]
}
}
}
}