ImmobiNet
ImmobiNet API Docs - Availability

AvailableProperties

AvailableProperty

property_id
​integer
rate_plan
​string

Name of the rate plan with the lowest price for the stay.

Amounts in euro.

Example: {"stay":700,"total":760,"undiscounted_total":760,"price_items":[{"type":"prenotazione","amount":700},{"type":"pulizie","amount":60}]}

AvailablePropertyAmounts

Amounts in euro.
stay
​number · double

Price of the stay (sum of the price items that make the price, discounts subtracted).

Example: 120.5
total
​number · double

Total of all the price_items (discounts subtracted).

Example: 120.5
undiscounted_total
​number · double

Total before the discounts, the sum of the price_items with a positive amount. Equal to total when there are no discounts; undiscounted_total minus total is the amount of the discounts, so it can be shown as the price before and after the discount.

Example: 120.5
​PriceItem[]

The items that make the price (rent, cleaning, discounts, ...), in the order of the pricing engine. Their amounts add up to total.

PriceItem

type
​string

Type of the price item (for example prenotazione, the rent). The values are the names of the price components of the installation; there is no catalog of them yet, so do not rely on a fixed list.

amount
​number · double

Amount of the item, negative for discounts (the amounts of all the items add up to amounts.total).

Example: 120.5

Availability

PropertyAvailability

property_id
​integer
rate_plan
​string

Name of the rate plan used for the calendar.

One entry per date from from to to, in ascending order.

AvailabilityDay

date
​string

Day, YYYY-MM-DD.

Example: 2027-07-01
available
​boolean

true when the property can be booked on this day with the rate plan (bookings, blocks, rules and prices all taken into account).

min_stay
​integer | null

Minimum number of nights for a stay that starts this day (1 when the rate plan sets no minimum). null only when restrictions are not available.

max_stay
​integer | null

Maximum number of nights for a stay that starts this day. null when there is no maximum or restrictions are not available.

arrival_allowed
​boolean | null

Whether a stay can start (check-in) on this day: false when the rate plan rules or a block forbid arrivals this day. null only when restrictions are not available.

departure_allowed
​boolean | null

Whether a stay can end (check-out) on this day: false when the rate plan rules or a block forbid departures this day. null only when restrictions are not available.

RatePlan

code
​string

Name of the rate plan, the {ratePlan} of the availability and rates calls.

Example: www
name
​string

Description of the rate plan.

Example: Website
min_guests
​integer

Minimum number of guests the rate plan accepts.

max_guests
​integer

Maximum number of guests the rate plan accepts.

type
​string · enum

What the price of /api/v1/rate-plans/{ratePlan}/rates means for this rate plan: per_night, the price of one night; fixed, one flat amount for a stay inside a period, whatever the number of nights.

Enum values:
per_night
fixed
Example: per_night

Rates

​object

RateProperty

property_id
​integer
rate_plan
​string

Name of the rate plan used.

rate_plan_type
​string · enum

Type of the rate plan used (the type of /api/v1/rate-plans): it says what price means.

Enum values:
per_night
fixed
Example: per_night
​RatePeriod[]

Periods with prices, in ascending order of date; days without a price are not covered by any period. Never empty.

RatePeriod

from
​string

First day of the period, YYYY-MM-DD.

Example: 2027-06-01
to
​string

Last day of the period (inclusive), YYYY-MM-DD. Periods are cut to the from-to range of the request; for a fixed rate plan the flat price is the one of the whole period of the rate plan all the same.

Example: 2027-06-30
​GuestPrice[]

Price by number of guests, valid for every day of the period, in ascending order of guests. Never empty. Consecutive numbers of guests with the same price share a row. A number of guests with no price has no row, so the ranges may not be contiguous.

GuestPrice

min_guests
​integer

Smallest number of guests this price applies to.

Example: 1
max_guests
​integer

Largest number of guests this price applies to (inclusive).

Example: 4
price
​number · double

In euro, by the type of the rate plan (rate_plan_type). per_night: total price of one night for that number of guests (not a supplement), the price of the rate plan for that night, as the SOAP getListino gives it: the components added by the application when a stay is quoted (offers, cleaning fees) are not included, so GET /api/v1/search/available-properties with guests can give a different total. fixed: one flat amount for a stay inside the period for that number of guests, whatever the number of nights; a percentage supplement for extra guests increases it, a supplement in euro (charged per night) is not included. price is what a stay of the whole period pays: when the channel markup is rounded (e.g. up to the euro), the rounding applies to each night, so a shorter stay inside the period can pay a slightly different total. Periods of the rate plan that overlap are not repeated: on the days they share, the period that starts later wins (on the same start, the one that ends first).

Example: 120

Amount

number · double

Amount of money in euro (e.g. 120.50).

Example: 120.5