Booking Engine

Booking Engine

Use the Availability API

If you want to build a fully custom booking experience on your frontend, you can fetch room availability directly via the public API.

Endpoint

POST /api/v1/get-new-avilablilty

Example curl Request

curl "/api/v1/get-new-avilablilty" \
  -H "accept: application/json, text/plain, */*" \
  -H "content-type: application/json" \
  -H "origin: https://docs.hostelmate.co" \
  --data-raw '{
    "dates":["2024-10-04","2024-10-05"],
    "property":"bedb0caf-099b-4cd8-b009-7830211f3c59"
  }'

Request Payload

Field	Type	Description
dates	array	Dates to check availability for (format: YYYY-MM-DD).
property	string	Your property ID (UUID).

Response

The API will return available rooms, rates, and related availability info for the specified date(s).

Response Structure

{
    "days": [
        {
            "room_id": "265b373a-6248-4424-bf18-dc2bbf63a920",
            "room_name": "Deluxe Mixed Room",
            "room_description": "this is the room description test ",
            "date": [
                {
                    "date": "2025-10-02",
                    "price": 108
                }
            ],
            "image_fullpath": [
                "https://cdn.domain.com/room_image/oyY8W97TnEpRv7XDGCFWpIbFr.jpg",
                "https://cdn.domain.com/room_image/s2N7hsqPWECSTlGdS1JAsgS1B.jpg",
                "https://cdn.domain.com/room_image/D3HkQXEyB0w3n4bOiEVzAiwL8.jpg",
                "https://cdn.domain.com/room_image/MG30KI5I9s6GTSYMkE4C5Z3LN.jpg"
            ]
        }
    ],
    "name": "Alphatel Dubai World Trade Center",
    "city": "Dubai",
    "country": "United Arab Emirates",
    "postal_code": "00000",
    "payment_gateway": {
        "status": true,
        "currency": "aed",
        "options": [
            "nomod"
        ]
    },
    "state": "UK",
    "rate": "12",
    "phone": "+00000000000",
    "description": "",
    "googleMapLink": "https://www.google.com/maps?q=PLACEHOLDER",
    "address": "8th Floor, Building, UK",
    "website": "https://domain.com/",
    "main-image": "https://cdn.domain.com/property_image/kF3Ekirdo60z5e3r5HNCgMpBv.jpg",
    "howToReachUsLink": "https://www.google.com/maps?q=PLACEHOLDER",
}

Response Fields

Field	Type	Description
days	array	Array of available rooms for the requested dates
days[].room_id	string	Unique identifier for the room (UUID)
days[].room_name	string	Name of the room
days[].room_description	string	Description of the room
days[].date	array	Array of date and price information for this room
days[].date[].date	string	Date in YYYY-MM-DD format
days[].date[].price	number | false	Room price for the selected date; ‘false’ means no availability.
days[].image_fullpath	array	Array of image paths for the room
name	string	Property name
city	string	City where the property is located
country	string	Country where the property is located
postal_code	string	Postal code of the property
payment_gateway	object	Payment gateway configuration
payment_gateway.status	boolean	Whether payment gateway is enabled
payment_gateway.currency	string	Currency code (e.g., "aed")
payment_gateway.options	array	Available payment options
state	string	State/province where the property is located
rate	string	Property rating
phone	string	Property phone number
description	string	Property description
googleMapLink	string	Google Maps link to the property
address	string	Full address of the property
website	string	Property website URL
main-image	string	URL of the main property image
howToReachUsLink	string	Link with directions to reach the property