Skip to main content

Rate Code

Rate Code

Search for a specific rate using a rate code.

 

ParameterDescriptionType
rateCodeCode associated with a Rate[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&rateCode=BAR

 

Successful Response (partial)

A successful response will return the rate code BAR and the corresponding Ref and RefValue parameters will also indicate the association to the rate code. 
 

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": "BAR"
                },
                "Room": {
                    "Code": "SUPK"
                },
                "Ref": "Rate",
                "RefValue": "BAR"
            }
        }],
        "ProductResult": "Success"
    }
}