Get Demand

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

Overview

The getDemand operation will return a demand data based checkin and stay dates for a 180 day future period.

Request

Element	Type	Description
SiteIDList	Array	Mandatory A list of property IDs for which transaction details should be returned. This must be a subset of properties that are enabled for your API. At least 1 siteID is required

Sample

{
    "userAuth": {
        "username": "username",
        "password": "password"
    },
    "operation": "getDemand",
    "siteIDList": [
        1853
    ]
}

Request

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			String	The internal siteID of the proprty in the IBE.
	siteName			String	Property name.
	dates			Array	A list of dates containing demand data.
		date		String	The date the demand data applies to.
		checkinDemand		Integer	The total demand for this date based on date of checkin.
		stayDemand		Integer	The total demand for this date based on date of stay.
		rooms		Object	Details of demand data for a specific room.
			roomID	Integer	The internal roomID of the room in the IBE.
			roomCode	String	The internal code of the room in the IBE.
			available	Integer	The number of this room available on this date.
			numActive	Integer	The number of active bookings on this room / date.
			numCancelled	Integer	The number of cancellations on this room / date.
			adrActive	Float	The average daily rate for this room on this date based on active bookings.
			adrCancelled	Float	The average daily rate for this room based on cancelled bookings.

Sample

{
  "siteList": [
    {
      "siteID": 1853,
      "siteName": "TestHotel Mahony",
      "dates": [
        {
          "date": "2024-05-21",
          "checkinDemand": 0,
          "stayDemand": 0,
          "rooms": [
            {
              "roomID": 4194373,
              "roomCode": "SGL",
              "available": "49",
              "numActive": 1,
              "adrActive": "150.00",
              "numCancelled": 0,
              "adrCancelled": "0.00"
            }
          ]
        },
        {
          "date": "2024-05-23",
          "checkinDemand": "5",
          "stayDemand": "5",
          "rooms": [
            {
              "roomID": 4194373,
              "roomCode": "SGL",
              "available": "47",
              "numActive": 2,
              "adrActive": "150.00",
              "numCancelled": 1,
              "adrCancelled": "150.00"
            }
          ]
        },
        {
          "date": "2024-06-20",
          "checkinDemand": "5",
          "stayDemand": "5",
          "rooms": [
            {
              "roomID": 4194374,
              "roomCode": "DBL",
              "available": "47",
              "numActive": 3,
              "adrActive": "180.00",
              "numCancelled": 0,
              "adrCancelled": "0.00"
            }
          ]
        },
        {
          "date": "2024-06-21",
          "checkinDemand": "0",
          "stayDemand": "5",
          "rooms": [
            {
              "roomID": 4194374,
              "roomCode": "DBL",
              "available": "48",
              "numActive": 2,
              "adrActive": "175.00",
              "numCancelled": 0,
              "adrCancelled": "0.00"
            }
          ]
        },
        {
          "date": "2024-06-25",
          "checkinDemand": 0,
          "stayDemand": 0,
          "rooms": [
            {
              "roomID": 4194374,
              "roomCode": "DBL",
              "available": "48",
              "numActive": 2,
              "adrActive": "200.00",
              "numCancelled": 0,
              "adrCancelled": "0.00"
            }
          ]
        },
        {
          "date": "2024-06-26",
          "checkinDemand": 0,
          "stayDemand": 0,
          "rooms": [
            {
              "roomID": 4194374,
              "roomCode": "DBL",
              "available": "48",
              "numActive": 2,
              "adrActive": "200.00",
              "numCancelled": 0,
              "adrCancelled": "0.00"
            }
          ]
        },
        {
          "date": "2024-06-27",
          "checkinDemand": 0,
          "stayDemand": 0,
          "rooms": [
            {
              "roomID": 4194374,
              "roomCode": "DBL",
              "available": "48",
              "numActive": 2,
              "adrActive": "200.00",
              "numCancelled": 0,
              "adrCancelled": "0.00"
            }
          ]
        },
        {
          "date": "2024-07-17",
          "checkinDemand": "1",
          "stayDemand": "1",
          "rooms": []
        },
        {
          "date": "2024-07-19",
          "checkinDemand": 0,
          "stayDemand": 0,
          "rooms": [
            {
              "roomID": 4194374,
              "roomCode": "DBL",
              "available": "48",
              "numActive": 2,
              "adrActive": "175.00",
              "numCancelled": 0,
              "adrCancelled": "0.00"
            }
          ]
        },
        {
          "date": "2024-07-20",
          "checkinDemand": 0,
          "stayDemand": 0,
          "rooms": [
            {
              "roomID": 4194374,
              "roomCode": "DBL",
              "available": "48",
              "numActive": 2,
              "adrActive": "175.00",
              "numCancelled": 0,
              "adrCancelled": "0.00"
            }
          ]
        },
        {
          "date": "2024-07-21",
          "checkinDemand": 0,
          "stayDemand": 0,
          "rooms": [
            {
              "roomID": 4194374,
              "roomCode": "DBL",
              "available": "48",
              "numActive": 2,
              "adrActive": "175.00",
              "numCancelled": 0,
              "adrCancelled": "0.00"
            }
          ]
        }
      ]
    }
  ]
}