Get Rates

Overview

The getRates operation can be used to retrieve rate information for rates currently configured in the IBE.

Request

Element	Type	Description
siteIDList	Array	(Mandatory) A list of property IDs for which rates should be returned. This must be a subset of properties that are enabled for your API.
channelIDList	Array	If specified, all publicly available rates on the specified channel will be returned. If not specified, the default website channel will be assumed. List of Channels
rateIDList	Array	If specified results will be returned for only the rates specified. If not specified, results will be returned for all publicly available rates on the specified channel.
startDate	String	An ISO 8601 format date string indicating the start date for which rate results should be returned. This must be a future date. If not specified, the current date will be used.
inventoryHorizon	Integer	An integer in the range 1-30. If provided, results will be included for the specified number of successive dates after the specified start date. If not specfied, a value of 1 will be used.
losOptions	Array	A list (not more than 7) of integer values in the range 1-30. If provided, results will be returned for each length-of-stay (LOS) provided. If not specified, a value of [1] will be used.

Sample

{
    "userAuth": {
        "username": "username",
        "password": "password"
    },
    "operation": "getRates",
    "siteIDList": [
        1853
    ],
    "channelIDList": [
    ],
    "rateIDList": [
        4194375
    ],
    "startDate": "2024-12-01",
    "inventoryHorizon": 2,
    "losOptions": [
        1,
        2
    ]
}

Response

Element				Type	Description
siteList				Array	The siteList array will contain an entry for each site as requested in the siteIDList section of the request.
	siteID			Integer	The internal siteID of the property in the IBE.
	primaryName			String	Property name.
	rates			Array	The rates array will contain an entry for each rate / room that has availability matching the criteria in the request.
		rateID		Integer	The internal rateID for the rate in the IBE.
		roomID		Integer	The internal roomID for the room in the IBE.
		checkin		String	The checkin date.
		occupancy		Array	The occupancy array will outline the min and max adults and the max occupancy for this rate / room.
			minA	Integer	This is the minimum adult occupancy for this rate / room.
			maxA	Integer	This is the maximum adult occupancy for this rate / room.
			maxO	Integer	This is the maxmium total occupancy for this rate / room.
		price		Array	The price array will outline the price details for this rate / room.
			los	Integer	This indicates the length of stay that the price relates to.
			type		This indicates the price type for this price option. This will be “basic” or “advanced”. List of Price Types
			pr		The price per room.
			pa		The price per adult.
			pr1	Integer	The price for 1 adult.
			pr2	Integer	The price for 2 adults.
			pr3	Integer	The price for 3 adults.
			pr4	Integer	The price for 4 adults.
			pr5	Integer	The price for 5 adults.
			xadu	Integer	The price for additional adults above pr5.
			chi1	Integer	The price for 1 child.
			chi2	Integer	The price for 2 children.
			chi3	Integer	The price for 3 children.
			inf	Integer	The price for infants.
			available	Integer	This is the number of this room type available on this rate.

Price Types

Price Type	Price Components	Description
basic	pa, pr	Basic price type applies to a rate where the pricing is based either on “per adult” or “per room.
advanced	pr1, pr2, pr3, pr4, pr5, chi1, chi3, chi3, inf	Advanced pricing applies where pricing for different occupancy levels can be set explicitly.

Sample

{
    "siteList": [
        {
            "siteID": 1853,
            "primaryName": "TestHotel Mahony",
            "rates": [
                {
                    "rateID": 4194375,
                    "roomID": 4194374,
                    "checkin": "2019-12-02",
                    "occupancy": {
                        "minA": 1,
                        "maxA": 2,
                        "maxO": 2
                    },
                    "price": [
                        {
                            "los": 1,
                            "type": "advanced",
                            "pr1": 100,
                            "pr2": 165,
                            "inf": 0,
                            "available": 6
                        },
                        {
                            "los": 2,
                            "type": "advanced",
                            "pr1": 200,
                            "pr2": 330,
                            "inf": 0,
                            "available": 6
                        }
                    ]
                },
                {
                    "rateID": 4194375,
                    "roomID": 4194466,
                    "checkin": "2019-12-02",
                    "occupancy": {
                        "minA": 1,
                        "maxA": 7,
                        "maxO": 8
                    },
                    "price": [
                        {
                            "los": 1,
                            "type": "advanced",
                            "pr1": 130,
                            "pr2": 145,
                            "pr3": 160,
                            "pr4": 210,
                            "pr5": 260,
                            "xadu": 50,
                            "chi1": 5,
                            "chi2": 10,
                            "chi3": 15,
                            "inf": 0,
                            "available": 10
                        },
                        {
                            "los": 2,
                            "type": "advanced",
                            "pr1": 260,
                            "pr2": 290,
                            "pr3": 320,
                            "pr4": 420,
                            "pr5": 520,
                            "xadu": 100,
                            "chi1": 10,
                            "chi2": 20,
                            "chi3": 30,
                            "inf": 0,
                            "available": 10
                        }
                    ]
                }
            ]
        }
    ]
}