Skip to content
ipro-dave edited this page Aug 25, 2021 · 24 revisions

Request Url: /apis/property/{propertyId}/rates?startDate=2018-02-28&nextWeeks=4

  • propertyId is the property id, it is integer.

  • startDate this call will show all rates after this date (rates are only available for future dates, not dates in the past).

  • We have RateMode with Fixed = 0, ByGroupSize = 1

  • NightlyRateMode & MonthlyRateMode's value type is RateMode.

  • RateGroupTypeId can be None = 0, Nightly = 1, Weekly = 2, Monthly = 3

  • PricingGroupsRates filled when "Enable Pricing Groups" is enabled for property. Rates are taken from Pricing Groups page.

  • nextWeeks this call will show all rates up to provided number of weeks forward (should be used together with startDate) Response:

[
    {
        "Id": 16648,
        "StartDate": "2015-11-24",
        "EndDate": "2016-02-20",
        "WeeklyRate": null,
        "BookingFee": £40,
        "InclusiveExtras": £100,
        "DisplayPrice": £1,640,
        "NightlyRate": null,
        "WeekendRate": null,
        "DiscountWeeklyRate": null,
        "DiscountWeekendRate": null,
        "DiscountNightlyRate": null,
        "DiscountMonthlyRate": null,
        "ThreeNightShortBreakRate": null,
        "FourNightShortBreakRate": null,
        "MonthlyRate": null,
        "MinimumCharge": 10,
        "Currency": "£",
        "CurrencyISO": "GBP",
        "Occupancy": null,
        "OccupancyIncrement": 1,
        "ExtraAdults": null,
        "ExtraChildren": null,
        "MinStay": 7,
        "ChangeoverDays": {
            "Id": 10678,
            "Arrival": "Any",
            "Departure": "Any"
        },
        "NightlyRateMode": 1,
        "NightlyRates": null,
        "MonthlyRateMode": 0,
        "ByLengthOfStay": true,
        "GroupSizeRates": [
            {
                "RateGroupTypeId": 1,
                "Guests": 2,
                "LengthOfStay": 1,
                "Amount": 69.29,
                "BookingFee": 40,
                "InclusiveExtras": 50,
                "DisplayPrice": 490
            },
            {
                "RateGroupTypeId": 1,
                "Guests": 2,
                "LengthOfStay": 3,
                "Amount": 20,
                "BookingFee": 40,
                "InclusiveExtras": 50,
                "DisplayPrice": 490
            },
            {
                "RateGroupTypeId": 1,
                "Guests": 4,
                "LengthOfStay": 1,
                "Amount": 80,
                "BookingFee": 40,
                "InclusiveExtras": 50,
                "DisplayPrice": 490,
            },
            {
                "RateGroupTypeId": 1,
                "Guests": 4,
                "LengthOfStay": 3,
                "Amount": 40,
                "BookingFee": 40,
                "InclusiveExtras": 50,
                "DisplayPrice": 490
            },
            {
                "RateGroupTypeId": 1,
                "Guests": 7,
                "LengthOfStay": 1,
                "Amount": 85
            },
            {
                "RateGroupTypeId": 1,
                "Guests": 7,
                "LengthOfStay": 3,
                "Amount": 80,
                "BookingFee": 40,
                "InclusiveExtras": 50,
                "DisplayPrice": 490
            }
        ],
        "PricingGroupsRates": [
           {
                "Price": 80.00,
                "PricingGroupID": 3
           }
        ],
       "ShortBreaks": [
           "LengthOfStay": [
            {
                 "LengthOfStay": 3,
                 "Amount": 200,
                 "BookingFee": 40,
                 "InclusiveExtras": 50,
                 "DisplayPrice": 290
            },
            {
                 "LengthOfStay": 4,
                 "Amount": 228,
                 "BookingFee": 40,
                 "InclusiveExtras": 50,
                 "DisplayPrice": 290
            },
            {
                 "LengthOfStay": 5,
                 "Amount": 243,
                 "BookingFee": 40,
                 "InclusiveExtras": 50,
                 "DisplayPrice": 290
            },
            {
                 "LengthOfStay": 6,
                 "Amount": 257,
                 "BookingFee": 40,
                 "InclusiveExtras": 50,
                 "DisplayPrice": 290
            }
           ],
           "ChangeoverDays": {
               "Id": 10678,
               "Arrival": "Thursday",
               "Departure": "Sunday"
           }
        ],
    }
]
Clone this wiki locally