Params

Name Type Requireness Default value Description
property_uid string required none UID of property.
from_date string required none YYYY-MM-DD First date of the period.
to_date string required none YYYY-MM-DD Last date of the period.

Description

Returns the property's calendar data for the period (no more than a year)

This endpoint requires one of the following scopes: calendar-control, direct-bookings, pricing-management

Response sample

{
    "data": [
        {
            "date": "2019-09-07",
            "currency": "CAD",
            "is_available": 1,
            "price": 300,
            "base_price": 400,
            "notes": "weekend",
            "min_stay": 2,
            "base_min_stay": 1
        }
    ],
    "meta": {
        "page": 1,
        "has_next_page": true
    }
}
  • 'base_price' is the base nightly rate before applying any discounts set with iGMS Pricing Management feature.
  • 'price' is the final nightly price after applying every discounts set with iGMS Pricing Management feature.
  • 'base_min_stay' is the base minimum stay nights value before applying any min stay limits set with iGMS Pricing Management feature.
  • 'min_stay' is the final minimum stay nights value after applying every min stay limits set with iGMS Pricing Management feature.