Availability

Availability is the availability of a property for a given date range. It is used to determine whether a property is available for a given date range for a given number of guests and country.

Fields

GET Property Availabilities with Dates

Field	Type	Description
propertyId	string	Unique Identifier of the property.
roomId	string	Unique Identifier of the room type or room.
dateWiseAvailability.date	string	Date for the availability.
dateWiseAvailability.status	string	Status of the availability.
dateWiseAvailability.unitsAvailable	number	If applicable, number of units of the same property/room type available for a reservation.
dateWiseAvailability.price.amount	number	Nightly price of the property.
dateWiseAvailability.price.currency	string	Currency of the nightly price.
dateWiseAvailability.minimumNights	number	Min. nights to stay at the property.
dateWiseAvailability.maximumNights	number	Max. nights to stay at the property.
dateWiseAvailability.reservationIds	string[]	Existing reservations on that date.

GET All Availabilities

Field	Type	Description
arrivalDate	string	Arrival date for the availability.
departureDate	string	Departure date for the availability.
numberOfGuests	number	Optional. Number of guests for the availability.
country	string	Optional. Country of the property.
propertyCount	number	Optional. Total number of available properties.
properties	object	Optional. Array of property availability details.

Properties

Field	Type	Description
propertyId	string	Unique identifier for the property.
createdAt	string	Creation date of the property entry.
updatedAt	string	Last updated date of the property entry.
name	string	Name of the property.
internalName	string	Internal name of the property.
description	string	Description of the property.
thumbnailUrl	string	URL of the property's thumbnail image.
pictures	Array	Array of pictures of the property.
address	object	Address of the property.
geolocation	object	Geolocation of the property.
language	string	Language of the property listing.
maximumNights	number	Maximum nights of stay.
minimumNights	number	Minimum nights of stay.
maxOccupancy	number	Maximum occupancy of the property.
numberOfChildren	number	Number of children allowed at the property.
numberOfInfants	number	Number of infants allowed at the property.
numberOfPets	number	Number of pets allowed at the property.
startPrice	number	Starting price for the property.
currency	string	Currency for pricing.
timeZone	string	Time zone of the property location.
rating	object	Rating of the property.
rooms	object	Room details of the property.

Enums

dateWiseAvailability.status

AVAILABLE = "AVAILABLE"
NOT_AVAILABLE = "NOT_AVAILABLE"

Supported fields in each source system

GET Property Availabilities with Dates

Field	Hostaway	Smoobu	Lodgify	Beds24	Guesty	Hostfully	Hostify	OwnerRez	FantasticStay	Hospitable	Hostex	BookingSync
propertyId	✅	🔜	✅	✅	✅	✅	✅	✅	✅	✅	🔜	✅
roomId	-	🔜	✅	✅	-	-	-	-	-	-	🔜	-
dateWiseAvailability.date	✅	🔜	✅	✅	✅	✅	✅	✅	✅	✅	🔜	✅
dateWiseAvailability.status	✅	🔜	✅	✅	✅	✅	✅	✅	✅	✅	🔜	✅
dateWiseAvailability.unitsAvailable	-	🔜	✅	✅	-	-	-	-	-	-	🔜	-
dateWiseAvailability.price.amount	✅	🔜	✅	✅	✅	✅	✅	✅	✅	✅	🔜	✅
dateWiseAvailability.price.currency	🔜	🔜	-	🔜	✅	✅	✅	🔜	✅	✅	🔜	✅
dateWiseAvailability.minimumNights	✅	🔜	✅	✅	✅	✅	✅	✅	🔜	🔜	🔜	✅
dateWiseAvailability.maximumNights	-	🔜	✅	✅	-	✅	-	-	-	🔜	🔜	🔜
dateWiseAvailability.reservationIds	✅	🔜	✅	-	✅	✅	✅	✅	✅	✅	🔜	🔜

Supported methods

Methods	Hostaway	Hostify	Smoobu	Lodgify	Uplisting	Guesty	Hostfully	OwnerRez	Beds24	Hospitable	FantasticStay	Hostex	BookingSync
Get All Availabilities	✅	✅	🔜	✅	🔜	✅	✅	🔜	🔜	✅	✅	🔜	🔜
Get a Property's Availabilities for a specific date range	✅	✅	🔜	✅	🔜	✅	✅	✅	✅	✅	✅	🔜	✅
Batch Availabilities	-	-	-	✅	-	✅	✅	✅	✅	-	-	-	✅
Update Property Availability with Dates	✅	✅	🔜	🔜	🔜	✅	✅	✅	✅	🔜	🔜	🔜	🔜