Availability API

This is a key step before making a hotel booking. Unlike the MinRate API, this API provides all available room types and options based on your query. The response from this API is essential to complete the booking process.

API details

POST /api/v1/hotel/booking-api/availability/rooms

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
Accept-Encoding	gzip

Body

Name	Type	Description
hotelIds	Array	Hotel ids in array fomat
fromDate	String	checkin date
toDate	String	checkout date
noOfAdults	Integer	No of adults in a room
noOfChildren	Integer	No of children in a room
childrenAges	Array	Age of each children in a room
nationality	String	nationality of the guest

Sample Request

{
    "hotelIds": [100018,100021],
    "fromDate":"2024-10-17",
    "toDate": "2024-10-20",
    "rooms": [
        {
        "noOfAdults": 1,
        "noOfChildren": 0,
        "childrenAges": []
        }
    ],
    "nationality": "UAE"
}

Response details

Response General data

Name	Type	Description
tokenNumber	String	Unique code for an availability request.
fromDate	String	Checkin Date
toDate	String	Check out Date
nationality	String	Guest Nationality ISO code
roomPaxes	Array	roomPaxes.noOfAdults roomPaxes.noOfChildren roomPaxes.childrenAges[]
noOfNights	Integer	Total stay nights

Response Hotel data

Name	Type	Description
hotelId	Integer	Unique Id for the hotel
hotelName	String	Name of the hotel

Response Room data

Name	Type	Description
rateKey	String	Unique Id for the specific rate
standardName	String	Name of the room provided by room mapping provider
roomName	String	Name of the room provided by supplier
roomMaster	Boolean	true: if room details available in room master false : If room details not available in room master
roomMasterCode	String	Unique room code for mapping from room master
boardName	String	Name of the board type
boardMaster	Boolean	true: if board details available in board master false : If board details not available in board master
boardMasterId	Integer	Unique board code for mapping from board master
occupancies	Array	occupancies.name occupancies.maxCount
netPrice	Number	Total price

Sample Response

{
    "success": true,
    "data": {
        "tokenNumber": "RA_1728408897715",
        "fromDate": "2024-10-17",
        "toDate": "2024-10-19",
        "nationality": "UAE",
        "roomPaxes": [
            {
                "noOfAdults": 1,
                "noOfChildren": 0,
                "childrenAges": []
            }
        ],
        "noOfNights": 2,
        "hotels": [
            {
                "hotel": {
                    "hotelId": 1110023,
                    "hotelName": "White Fort Hotel"
                },
                "rooms": [
					{
                        "standardName": "Standard Room",
                        "rates": [
                            {
                                "rateKey": "90a1ed1be35631e1f272ca0b2fd67968",
                                "roomName": "DOUBLE STANDARD",
                                "roomMaster": true,
                                "roomMasterCode": "X2-4879",
                                "boardName": "room only",
                                "boardMaster": true,
                                "boardMasterId": "10003",
                                "occupancies": {
                                    "name": "double standard",
                                    "maxCount": 1
                                },
                                "netPrice": 39.25
                            },
                            {
                                "rateKey": "cc3841de1a85acd43ffefc0d66dcdce2",
                                "roomName": "DOUBLE STANDARD",
                                "roomMaster": true,
                                "roomMasterCode": "X2-4879",
                                "boardName": "Bed and breakfast",
                                "boardMaster": true,
                                "boardMasterId": "10024",
                                "occupancies": {
                                    "name": "double standard",
                                    "maxCount": 1
                                 },
                                 "netPrice": 53.36   
                            },
                            {
                                "rateKey": "cbf503d70a01b8d99c54de3666ca1571",
                                "roomName": "DOUBLE STANDARD",
                                "roomMaster": true,
                                "roomMasterCode": "X2-4879",
                                "boardName": "Bed and breakfast",
                                "boardMaster": true,
                                "boardMasterId": "10014",
                                "occupancies": {
                                    "name": "double standard",
                                    "maxCount": 1
                                 },
                                 "netPrice": 60.40   
                            },
                            {
                                "rateKey": "cbf503d70a01b8d99c54de3666ca1571",
								"roomName": "DOUBLE STANDARD",
                                "roomMaster": true,
                                "roomMasterCode": "X2-4879",
                                "boardName": "half board",
								"boardMaster": true,
                                "boardMasterId": "10011",
                                "occupancies": {
                                    "name": "double standard",
                                    "maxCount": 1
                                },
								"netPrice": 82.41,
                            },
                            {
                                "rateKey": "e8f8c38a1fce369af9092464c4f835b0",
								"roomName": "DOUBLE STANDARD",
                                "roomMaster": true,
                                "roomMasterCode": "X2-4879",
                                "boardName": "full board",
								"boardMaster": true,
                                "boardMasterId": "10020",
                                "occupancies": {
                                    "name": "double standard",
                                    "maxCount": 1
                                },
								"netPrice": 100.68,
                            }
                        ]
                    },
                    {
                        "standardName": "Standard, Single",
                        "rates": [
                            {
                                "rateKey": "805ae708e85296ad8b701e7eed3aba28",
								"roomName": "SINGLE STANDARD",
                                "roomMaster": true,
                                "roomMasterCode": "X2-9495",
                                "boardName": "room only",
								"boardMaster": true,
                                "boardMasterId": "10003",
                                "occupancies": {
                                    "name": "single standard",
                                    "maxCount": 1
                                },
								"netPrice": 32.47,
                            },
                            {
                                "rateKey": "c7b96703cb2fd452e47312377ad7bed0",
								"roomName": "SINGLE STANDARD",
                                "roomMaster": true,
                                "roomMasterCode": "X1-1095",
                                "boardName": "bed and breakfast",
								"boardMaster": true,
								"boardMasterId": "10014",
                                "occupancies": {
                                    "name": "single standard",
                                    "maxCount": 1
                                }
                                "netPrice": 46.58,
                            },
                            {
                                "rateKey": "92208c46781354d5377b0d11dcb7f46a",
								"roomName": "SINGLE STANDARD",
                                "roomMaster": true,
                                "roomMasterCode": "X1-10095", 
                                "boardName": "half board",
								"boardMaster": true,
								"boardMasterId": "10018",
                                "occupancies": {
                                    "name": "single standard",
                                    "maxCount": 1
                                },
								"netPrice": 53.64,
                            }
                        ]
                    },
                    {
                        "standardName": "Superior, Single",
                        "rates": [
                            {
                                "rateKey": "4f0d1111a4e41a19784d0b7c77d728f6",
								"roomName": "SINGLE SUPERIOR",
                                "roomMaster": false,
                                "roomMasterCode": null,
                                "boardName": "room only",
								"boardMaster": false,
								"boardMasterId": null,
                                "occupancies": {
                                    "name": "single superior",
                                    "maxCount": 1
                                },
								"netPrice": 37.55,
                            }
                        ]
                    }                   
                ]
            }
        ]
    }
}

It is always recommended to request only one hotel per Availability API request. While it is safe to use up to 10 hotels per request, using multiple hotels may occasionally result in the failure to deliver all rates due to limits imposed by the room type aggregation service provider.