Availability Feed - API

Method to retrieve current room availability

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

URL Endpoints

/manage/availability
/manage/availability/{roomcode}

Warning

This method is only accessible using a Hotelier API account.

This method is only accessible using a GET request.

This method is only available in JSON. Make sure you send the Accept: application/json header.

Terms

This method should be called only for user-initiated actions.

Scheduled (automated) calls on this method are only allowed if they happen a few times per day.

This method is NOT a replacement of channel-management functionality.

This method should NOT be used to feed 3rd party systems without our consent.

API usage is closely monitored and improper usage will result in a ban.


Method parameters

NAME TYPE RANGE / SET REQUIRED DEFAULT EXAMPLE NOTES
from date (ISO 8601) * YES – &from=2024-10-29  
to date (ISO 8601) today + 3 years YES – &to=2025-10-29  

Method Output

All Rooms

The feed for all room types has the following structure:

{
"ROOMCODE":
	[
		{
			"from":ISO 8601, // Start of date range, mutually exclusive with "date"
			"to":ISO 8601, // End of date range, mutually exclusive with "date"
			"date":ISO 8601, // Single-date record, mutually exclusive with "from" and "to"
			"allot":INTEGER, // Allotment for this record
			"stopsell":BOOLEAN, // 1=Stop Sell Restriction, 0=No restriction (optional, default=0)
			"minstay":INTEGER, // Minimum stay in days (optional, default=1)
			"maxstay":INTEGER, // Maximum stay in days (optional, default=no restriction)
			"checkin":BOOLEAN // 1=Check-in is allowed, 0=Check-in not allowed (optional, default=1)
			"checkout":BOOLEAN // 1=Check-out is allowed, 0=Check-out not allowed (optional, default=1)
		}
	]
}

Single Room

The feed for one room has the following structure:

[
	{
		"from":ISO 8601, // Start of date range, mutually exclusive with "date"
		"to":ISO 8601, // End of date range, mutually exclusive with "date"
		"date":ISO 8601, // Single-date record, mutually exclusive with "from" and "to"
		"allot":INTEGER, // Allotment for this record
		"stopsell":BOOLEAN, // 1=Stop Sell Restriction, 0=No restriction (optional, default=0)
		"minstay":INTEGER, // Minimum stay in days (optional, default=1)
		"maxstay":INTEGER, // Maximum stay in days (optional, default=no restriction)
		"checkin":BOOLEAN // 1=Check-in is allowed, 0=Check-in not allowed (optional, default=1)
		"checkout":BOOLEAN // 1=Check-out is allowed, 0=Check-out not allowed (optional, default=1)
	}
]

JSON Response Example

Response example for All Rooms request.

{
	"DBL": [
		{
			"from": "2024-03-20",
			"to": "2024-03-23",
			"allot": 10,
			"minstay": 2,
			"maxstay": 7
		},
		{
			"from": "2024-03-24",
			"to": "2024-03-30",
			"allot": 10,
			"minstay": 2,
			"maxstay": 7,
			"stopsell": 1
		}
	],
	"QUAD": [
		{
			"from": "2024-03-20",
			"to": "2024-03-30",
			"allot": 2,
			"checkin": 0
		}
	],
	"TRPL": [
		{
			"from": "2024-03-20",
			"to": "2024-03-27",
			"allot": 5,
			"minstay": 2
		},
		{
			"from": "2024-03-28",
			"to": "2024-03-30",
			"allot": 5
		}
	]
}

Response example for a Sigle Room request.

[
	{
		"from": "2024-03-20",
		"to": "2024-03-23",
		"allot": 10,
		"minstay": 2,
		"maxstay": 7
	},
	{
		"from": "2024-03-24",
		"to": "2024-03-30",
		"allot": 10,
		"minstay": 2,
		"maxstay": 7,
		"stopsell": 1
	}
]