Get Rates for Occupancy

1 Overview
2 Request
- 2.1 Sample
3 Response
- 3.1 Sample

Overview

The getRatesForOccupancy operation will return detailed rate information matching the requested occupancy levels.

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.checkinDate
checkinDate			(Mandatory) An ISO 8601 format date string indicating the checkin date. This must be a future date or the current date.
checkoutDate			(Mandatory) An ISO 8601 format date string indicating the checkout date. This must be a future date with at least a 1 day gap between the checkinDate and the checkoutDate.
party		Array	(Mandatory) An array of party objects specifying the occupancy rates are being requested for.
	adults		(Mandatory) The number of adults in the room.
	child1		The number of children in the child1 age category in the room. If not specified, a value of 0 is assumed.
	child2		The number of children in the child2 age category in the room. If not specified, a value of 0 is assumed.
	child3		The number of children in the child3 age category in the room. If not specified, a value of 0 is assumed.
	child4		The number of children in the child4 age category in the room. If not specified, a value of 0 is assumed.
	infants		The number of infants in the infant age category in the room. If not specified, a value of 0 is assumed.

Sample

{
    "userAuth": {
        "username": "username",
        "password": "password"
    },
    "operation": "getRatesForOccupancy",
    "siteIDList": [
        1853
    ],
    "channelIDList": [
    ],
    "rateIDList": [
    ],
    "checkinDate": "2024-12-12",
    "checkoutDate": "2024-12-13",
    "party": [
        {
            "adults": 2,
            "child1": 1
        },
        {
            "adults": 3
        }
    ]
}

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 IBE siteID of the property.
	primaryName			String	Property name.
	currency			String	Property currency.
	rates			Array	The rates array will contain an entry for each rate that has availability matching the criteria in the request.
		rateID		Integer	The internal rateID for the rate in the IBE.
		bestPrice		Integer\|Float	The best price available matching the criteria in the request.
		bestPriceRooms		Array	The bestPriceRooms array will contain an entry containing the room with the best price for each of the parties in the request.
			roomID	Integer	The internal roomID for the room in the IBE.
			partyIndex	Integer	The index of the party in the request.
			price	Integer\|Float	The price for this room matching the party criteria at this index in the request.
			strikePrice	Integer\|Float	If strike pricing is configured and valid for this room/rate this will indicate the value of the corresponding strike price.
		allRoomOptions		Array
			roomID	Integer	The internal roomID for the room in the IBE.
			partyIndex	Integer	The index of the party in the request.
			price	Integer\|Float	The price for this room matching the party criteria at this index in the request.
			strikePrice	Integer\|Float	If strike pricing is configured and valid for this room/rate this will indicate the value of the corresponding strike price.

Sample

{
  "siteList": [
    {
      "siteID": 1853,
      "primaryName": "TestHotel Mahony",
      "currency": "EUR",
      "rates": [
        {
          "rateID": 4241302,
          "bestPrice": 450,
          "bestPriceRooms": [
            {
              "roomID": 4239871,
              "partyIndex": 1,
              "price": 250
            },
            {
              "roomID": 4239871,
              "partyIndex": 2,
              "price": 200
            }
          ],
          "allRoomOptions": [
            {
              "roomID": 4239871,
              "partyIndex": 1,
              "price": 250
            },
            {
              "roomID": 4239871,
              "partyIndex": 2,
              "price": 200
            }
          ]
        },
        {
          "rateID": 4208974,
          "bestPrice": 665,
          "bestPriceRooms": [
            {
              "roomID": 4194466,
              "partyIndex": 1,
              "price": 315
            },
            {
              "roomID": 4194466,
              "partyIndex": 2,
              "price": 350
            }
          ],
          "allRoomOptions": [
            {
              "roomID": 4194466,
              "partyIndex": 1,
              "price": 315
            },
            {
              "roomID": 4194466,
              "partyIndex": 2,
              "price": 350
            }
          ]
        }
      ]
    }
  ]
}