Rate Filter

Search for rates associated with a Rate Filter code.

Note: Rates associated with a Loyalty Program and Level are considered protected and not returned if assigned to a Rate Filter. To return loyalty rates, search by Loyalty Program and Level or by Booking Engine Template.

Parameter	Description	Type
rateFilter	Code associated with a rate filter	[String]
onlyCheckRequested	If true, the system will only check for product availability based upon the requested parameters.	Boolean

Sample Request

/v1/api/hotel/availability?hotelId=13098&chainId=12723&adults=2&startDate=2022-12-17&endDate=2022-12-20&numRooms=1&primaryChannel=WEB&secondaryChannel=WEB&onlyCheckRequested=true&rateFilter=HOTELRF

Successful Response (partial)

A successful response will return rates that match the rate filter HOTELRF and the corresponding Ref and RefValue parameters will also indicate the association to the rate filter.

Parameter	Description	Type
productAvailability/Prices/Product/@Ref	Indicates what reference was used to return the product. Values: AccessCode, AccessGeoLocation, Agent, ChannelizedRateAccessCode, Corporate, Group, Loyalty, Rate, RateClass, RateFilter, Room, RoomFeature, Template, Unknown	String
productAvailability/Prices/Product/@RefValue	Value of Ref	String

{
    "productAvailability": {
        "Prices": [{
            "Product": {
                "Rate": {
                    "Code": "ADVPUR"
                },
                "Room": {
                    "Code": "SUPK"
                },
                "Ref": "RateFilter",
                "RefValue": "HOTELRF"
            }
        }],
        "ProductResult": "Success"
    }
}