Skip to main content

Check Stay Availability API

Overview

Validates check-in to check-out stay dates for requested rooms count and guest capacity, calculating total stay price and nightly breakdown.

  • Endpoint: /api/availability/check
  • Method: POST / GET

Request Body / Query Schema

FieldTypeRequiredDescription
hotelIdString (UUID)YesTarget hotel ID
hotelRoomIdString (UUID)NoTarget specific room ID
checkInStringYesCheck-in date (YYYY-MM-DD)
checkOutStringYesCheck-out date (YYYY-MM-DD)
roomsNumberNoRequested rooms count (Default: 1)
guestsNumberNoGuest count (Default: 1)

Response Example (200 OK)

{
"success": true,
"data": {
"checkIn": "2026-10-01",
"checkOut": "2026-10-05",
"stayNights": 4,
"requestedRooms": 1,
"availableCount": 1,
"availableRooms": [
{
"roomId": "11223344-5566-7788-9900-aabbccddeeff",
"roomType": "DELUXE",
"roomName": "Ocean Deluxe Suite",
"maxOccupancy": 3,
"stayNights": 4,
"totalPrice": 18000,
"averagePricePerNight": 4500,
"nightlyBreakdown": []
}
]
},
"message": "Stay availability check completed"
}