ImmobiNet API Docs - Availability
PMS ImmobiNet - Availability calendar, live search of the free properties and rates of the properties (read only).
Replaces the SOAP calls getDisponibilita and getListinoAperture (and the restrictions of getListinoRegole):
one calendar per property, one entry per day, with the availability and the stay restrictions of the rate plan.
Visibility: the API requires the webservice privilege. Only the properties the API user can see in the
application (the same filter used by /api/v1/properties) and, when the API user has a webservice configuration,
only the properties enabled for it are returned. A property that is not
visible never appears, even if it is named in property_ids or property_codes.
Rate plan: the calendar and the prices are those of a rate plan, which is part of the path
(/api/v1/rate-plans/{ratePlan}/availability, /api/v1/rate-plans/{ratePlan}/rates): its name is one of
/api/v1/rate-plans, the rate plans enabled for the API user. A rate plan that does not exist or is not enabled
returns 404. Each item repeats the rate plan used. The channel is the first enabled channel that contains the rate plan; when none does, it is the channel of the webservice configuration for the rate plan of the configuration, otherwise no channel is used.
Availability: available is true when the property can be booked on that day with that rate plan. The
calendar combines everything that affects the booking of the property in a single value: it does not say why a day
is not available. Days are returned for every date from from to to, both included.
Limits: the range from from to to (inclusive) is at most 366 days; dates are YYYY-MM-DD; an invalid or
impossible date (for example 2026-02-30), to before from or a longer range returns 400. property_ids and
property_codes together accept at most 50 values (more returns 400); with both, a property matching either is
returned. Without filters, all the properties
available to the API user are listed, 1 to 50 per page (paging_limit, default 20), ordered by property_id: follow
_pagination.next_cursor in next_cursor until it is null. A cursor is valid only with the same filters it was
issued for; an unusable cursor returns 400.
Restrictions of the stay: min_stay, max_stay, arrival_allowed and departure_allowed are always
present in every day. They are null when the restrictions are not available for this installation. When they are available they come from the rules and blocks of the
rate plan (and of the channel, if any): a day with no rule has
min_stay 1, no max_stay (null) and both arrival_allowed and departure_allowed true.
Search (/api/v1/search/available-properties, a live search, replaces the SOAP call ricercaDisponibilita): the properties free
from arrival to departure (the departure day is not a night of the stay), one item per property with the
lowest price among the enabled rate plans in which the property is free (on equal prices the first enabled
rate plan wins: the one of the webservice configuration, then those of the enabled channels). rate_plan
restricts the search to that rate plan (400 if it does not exist, is not enabled, or does not belong to the requested
channel); channel restricts it to
the rate plans of that channel plus the one of the configuration (400 if the channel does not exist or is not
enabled); without an enabled rate plan (for example no webservice configuration) no items are returned.
guests keeps only the properties for at least that many guests, and the rate plans that accept them.
Amounts are decimal numbers in euro (not in cents): amounts.stay is the price of the stay (the price items that make
the price), amounts.total the sum of all the amounts.price_items (discounts subtracted) and
amounts.undiscounted_total the same total before the discounts. A free property
without a price for the whole stay in any enabled rate plan is not returned, so a page can be shorter than
paging_limit, or even empty, with a non-null next_cursor (_pagination.total_items counts the free
properties, with or without a price): keep following next_cursor until it is null. The stay is
at most 60 nights; departure must be after arrival; the filters and the pagination are the ones of the
calendar.
When property_ids or property_codes name only properties that are not visible, the list is empty (200),
as for the calendar.
/api/v1/rate-plans/{ratePlan}/rates, replaces the SOAP calls getListino and getListinoPersone): the prices of a rate
plan per property, as periods with a price for each number of guests, in euro, with any markup of the channel of the
webservice configuration already applied. What price means depends on the type of the rate plan (type in
/api/v1/rate-plans, rate_plan_type in each item):
per_night:priceis the total price of one night for those guests;fixed:priceis one flat amount for a stay inside that period, whatever the number of nights (rules on the length of stay and on the arrival day are not part of this API). On afixedrate plan only percentage supplements per number of guests are given (the flat amount increased by that percentage); supplements in euro are charged per night, so they cannot be one flat amount and are not given: those numbers of guests show the flat amount without them. A stay that runs across two or more periods of afixedrate plan pays the flat amount of each period it touches: this API does not add them up, so for the price of a specific stay useGET /api/v1/search/available-properties.
paging_limit (even none): keep following next_cursor until it is null. The range, the filters and the
pagination follow the rules of /api/v1/rate-plans/{ratePlan}/availability./api/v1/rate-plans): the rate plans enabled for
the API user, which are the ones accepted as {ratePlan} in /api/v1/rate-plans/{ratePlan}/availability and
/api/v1/rate-plans/{ratePlan}/rates and as the rate_plan parameter of /api/v1/search/available-properties. They are the rate plan of the webservice
configuration of the API user followed by the rate plans of the enabled channels. Without a webservice
configuration the list is empty.
