Skip to main content

Rate Class

Rate Class

Include or exclude rates assigned to a rate class from the search by passing in one or more rateClass or rateClassExclude values.

Note: A request can contain both rateClass and rateClassExclude parameters.

 

ParameterDescriptionType
rateClassRate class types to include 
Values: Association,Convention, Corporate,Government,Military, Negotiated, Package,Promotional, Rack, Senior, TravelIndustry,Weekend
[String]
rateClassExcludeRate class types to exclude 
Values: Association,Convention, Corporate,Government,Military, Negotiated, Package,Promotional, Rack, Senior, TravelIndustry,Weekend
[String]
onlyCheckRequestedIf 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&rateClass=Negotiated&rateClassExclude=Senior,Government,Military

 

Successful Response (partial)

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

 

ParameterDescriptionType
productAvailability/Prices/Product/@RefIndicates 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/@RefValueValue of RefString

 

{
    "productAvailability": {
        "Prices": [{
            "Product": {
                "Rate": {
                    "Code": "MOB1"
                },
                "Room": {
                    "Code": "SUPK"
                },
                "Ref": "RateClass",
                "RefValue": "Negotiated"
            }
        }],
        "ProductResult": "Success"
    }
}