Single-Property Calendar Availability - API

Returns allotment in calendar format with pricing information.

Warning

In case you want guaranteed availability results and flexibility over the stay parameters please use the Flexible Calendar Availability.

Table of Contents
  1. URL Endpoint
  2. Method Parameters
  3. JSON Response Schema
  4. JSON Response Example

URL Endpoint

/availability/{propertycode}/calendar

Method Parameters

Basic parameters

NAME TYPE RANGE / SET REQUIRED DEFAULT EXAMPLE NOTES
fromd date (ISO 8601) from today
to (today + 3 years)		 YES – &fromd=2024-11-05  
tod date (ISO 8601) from (checkin + 1)
to (checkin + 3 months) 		YES* checkin + 1 day &tod=2024-11-12
adults integer 1 – max capacity NO 1 &adults=2 The value is PER ROOM. Maximum value is automatically calculated based on the property's maximum possible room capacity.
children integer 0 – (max capacity-1) NO 0 &children=1 The value is PER ROOM. Maximum value equals (maximum capacity - 1).

Advanced parameters

NAME TYPE RANGE / SET REQUIRED DEFAULT EXAMPLE NOTES
room string varchar(6) NO – &room=DBL Only returns availability for specified room type
rate integer NO – &rate=448033 Only returns availability for specified rate

JSON Response Schema

{
	"method": "http://rest.reserve-online.net/availability/DEMO/calendar",
	"http_method": "GET",
	"http_code": 200,
	"error_code": "OK",
	"error_msg": "",
	"params": [
		{
			"type": "URL",
			"name": "fromd",
			"value": "2024-11-05"
		},
		{
			"type": "URL",
			"name": "tod",
			"value": "2024-11-12"
		}
	],
	"data": {
		"days": [ // Calendar days allotment and pricing breakdown 
			{
				"date":ISO 8601, // Check-in date
				"allot":INTEGER, // Number of available rooms
				"price":MONEY, // Total rate price
				"min_stay":INTEGER, // Minimum stay in days
				"max_stay":INTEGER // Maximum stay in days, -1 if no max stay defined 
				"checkin":BOOLEAN, // 1=Check-in is allowed, 0=Check-in not allowed
			}
		]
	}
}

JSON Response Example