February 27, 2025

Change Summary

Support for filtering searches by refundable or non-refundable rates and rate types added.

Previous 

{
  "SearchCriteriaByIds": {
    "propertyIds": [2254894],
    "occupancies": [
      {
        "checkInDate": "2025-07-24",
        "checkOutDate": "2025-07-27",
        "guestAges": "30,5"
      }
    ]
  }
}

New

{
  "SearchCriteriaByIds": {
    "propertyIds": [22561682],
    "occupancies": [
      {
        "checkInDate": "2025-02-08",
        "checkOutDate": "2025-02-09",
        "guestAges": "25,22"
      }
    ],
    "filterBy": {
      "includeNREF": "true",
      "rateType": "CHEAPEST_RATE_PER_ROOM_WITH_MEAL"
    }
  }
}

The rateType variable accepts the following:

  1. CHEAPEST_RATE_PER_ROOM
  2. ALL_RATES_PER_ROOM
  3. CHEAPEST_RATE_AMONG_ALL_ROOMS
  4. CHEAPEST_RATE_PER_ROOM_WITH_MEAL

The includeNREF and rateType parameters are optional. If they are not provided, the search response will still return one REF (refundable) and one NREF (non-refundable) cheapest rate for each room in the property.

End-points impacted

Search