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

Availabilities

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

PropertyAvailability

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

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	✅	✅	🔜	✅	🔜	✅	✅	✅	🔜	🔜	🔜	🔜	🔜
Update Property Availability with Dates	✅	✅	🔜	🔜	🔜	✅	✅	✅	🔜	🔜	🔜	🔜	🔜