Skip to main content

Availability Rules API

Overview​

Configures seasonal date-range availability rules, day types (WEEKDAY, WEEKEND, PUBLIC_HOLIDAY), minimum stay requirements, and nightly pricing overrides for a hotel or room.

  • Endpoint: /api/availability/rules
  • Method: POST (Create) / GET (List)

Request Body Schema (Create - POST)​

FieldTypeRequiredDescription
hotelIdString (UUID)ConditionalTarget hotel ID
hotelRoomIdString (UUID)ConditionalTarget room ID
dayTypeEnumNoWEEKDAY, WEEKEND, PUBLIC_HOLIDAY (Default: WEEKDAY)
dayOfWeekNumber (Integer)NoSpecific day of week (0=Sunday to 6=Saturday)
availableFromStringYesStart date (YYYY-MM-DD)
availableUntilStringNoEnd date (YYYY-MM-DD)
minimumStayNightsNumberNoMinimum stay nights (Default: 1)
pricePerNightNumberNoOverridden nightly price
availableRoomsCountNumberNoOverridden room capacity

Request Body Example​

{
"hotelId": "7a8b9c1d-2e3f-4a5b-6c7d-8e9f0a1b2c3d",
"dayType": "WEEKEND",
"dayOfWeek": 6,
"availableFrom": "2026-10-01",
"availableUntil": "2026-12-31",
"minimumStayNights": 2,
"pricePerNight": 5500.00
}

Delete Availability Rule (POST /api/availability/rules/delete)​

Overview​

Deactivates an availability rule by setting active: false.

Request Body Schema​

FieldTypeRequiredDescription
idString (UUID)ConditionalRule ID to deactivate
ruleIdString (UUID)ConditionalAlias for rule ID

Request Body Example​

{
"id": "rule_99887766"
}

Response Example (200 OK)​

{
"success": true,
"data": {
"id": "rule_99887766",
"active": false
},
"message": "Availability rule deleted successfully"
}