GET hotels/{hotelId}/reservations?key={key}&date={date}

Gets all Reservations for the hotel specified that have been created on a specific date.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
hotelId

Hotel-Id => checked against the calling applications permissions

string

Required

key

API - Key identifying the caller

string

Required

date

Date when reservations have been created, Format YYYY-MM-DD

date

Required

Body Parameters

None.

Response Information

Resource Description

List of reservations

Collection of Reservation
NameDescriptionTypeAdditional information
ReservationID

reservation ID

integer

None.

CreatedDate

Date and Time the reservation was created

date

None.

CheckInDate

Date the guest will / has checked in

date

None.

LengthOfStay

Number of days the guests will stay

integer

None.

CancellationDate

Date the reservation was cancelled - will be January 1, 0001 if the reservation wasn't cancelled

date

None.

RoomType

Name of the reserved room type

string

None.

RoomID

Room ID

string

None.

Adults

Number of adults

integer

None.

Youth

Number of Children

integer

None.

NumberOfRooms

Number of rooms the guest reserved

integer

None.

ReservationDeposit

Amount of deposit the guest pays

decimal number

None.

NightlyAmount

Average amount the guest pays for each night and room (not including taxes).

decimal number

None.

NonRoomAmount

Amount of non-room related charges the guest spend during his stay (not including taxes), i.e. all transactions that are not configured as Room Charges nor Payments in RoomKey (Transaction Codes).

decimal number

None.

Status

The latest status of reservation

string

None.

SOB

Source of business

string

None.

GuestID

Guest ID - unique with HotelId used in the call

integer

None.

GroupId

string

None.

GroupName

string

None.

CorporateId

string

None.

CorporateName

string

None.

WholeSalerId

string

None.

WholeSalerName

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ReservationID": 1,
    "CreatedDate": "2022-10-05T23:37:35.5997593-07:00",
    "CheckInDate": "2022-10-05T23:37:35.5997593-07:00",
    "LengthOfStay": 4,
    "CancellationDate": "2022-10-05T23:37:35.5997593-07:00",
    "RoomType": "sample string 6",
    "RoomID": "sample string 7",
    "Adults": 8,
    "Youth": 9,
    "NumberOfRooms": 10,
    "ReservationDeposit": 11.0,
    "NightlyAmount": 12.0,
    "NonRoomAmount": 13.0,
    "Status": "sample string 14",
    "SOB": "sample string 15",
    "GuestID": 16,
    "GroupId": "sample string 17",
    "GroupName": "sample string 18",
    "CorporateId": "sample string 19",
    "CorporateName": "sample string 20",
    "WholeSalerId": "sample string 21",
    "WholeSalerName": "sample string 22"
  },
  {
    "ReservationID": 1,
    "CreatedDate": "2022-10-05T23:37:35.5997593-07:00",
    "CheckInDate": "2022-10-05T23:37:35.5997593-07:00",
    "LengthOfStay": 4,
    "CancellationDate": "2022-10-05T23:37:35.5997593-07:00",
    "RoomType": "sample string 6",
    "RoomID": "sample string 7",
    "Adults": 8,
    "Youth": 9,
    "NumberOfRooms": 10,
    "ReservationDeposit": 11.0,
    "NightlyAmount": 12.0,
    "NonRoomAmount": 13.0,
    "Status": "sample string 14",
    "SOB": "sample string 15",
    "GuestID": 16,
    "GroupId": "sample string 17",
    "GroupName": "sample string 18",
    "CorporateId": "sample string 19",
    "CorporateName": "sample string 20",
    "WholeSalerId": "sample string 21",
    "WholeSalerName": "sample string 22"
  }
]

application/xml, text/xml

Sample:
<ArrayOfReservation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models">
  <Reservation>
    <Adults>8</Adults>
    <CancellationDate>2022-10-05T23:37:35.5997593-07:00</CancellationDate>
    <CheckInDate>2022-10-05T23:37:35.5997593-07:00</CheckInDate>
    <CorporateId>sample string 19</CorporateId>
    <CorporateName>sample string 20</CorporateName>
    <CreatedDate>2022-10-05T23:37:35.5997593-07:00</CreatedDate>
    <GroupId>sample string 17</GroupId>
    <GroupName>sample string 18</GroupName>
    <GuestID>16</GuestID>
    <LengthOfStay>4</LengthOfStay>
    <NightlyAmount>12</NightlyAmount>
    <NonRoomAmount>13</NonRoomAmount>
    <NumberOfRooms>10</NumberOfRooms>
    <ReservationDeposit>11</ReservationDeposit>
    <ReservationID>1</ReservationID>
    <RoomID>sample string 7</RoomID>
    <RoomType>sample string 6</RoomType>
    <SOB>sample string 15</SOB>
    <Status>sample string 14</Status>
    <WholeSalerId>sample string 21</WholeSalerId>
    <WholeSalerName>sample string 22</WholeSalerName>
    <Youth>9</Youth>
  </Reservation>
  <Reservation>
    <Adults>8</Adults>
    <CancellationDate>2022-10-05T23:37:35.5997593-07:00</CancellationDate>
    <CheckInDate>2022-10-05T23:37:35.5997593-07:00</CheckInDate>
    <CorporateId>sample string 19</CorporateId>
    <CorporateName>sample string 20</CorporateName>
    <CreatedDate>2022-10-05T23:37:35.5997593-07:00</CreatedDate>
    <GroupId>sample string 17</GroupId>
    <GroupName>sample string 18</GroupName>
    <GuestID>16</GuestID>
    <LengthOfStay>4</LengthOfStay>
    <NightlyAmount>12</NightlyAmount>
    <NonRoomAmount>13</NonRoomAmount>
    <NumberOfRooms>10</NumberOfRooms>
    <ReservationDeposit>11</ReservationDeposit>
    <ReservationID>1</ReservationID>
    <RoomID>sample string 7</RoomID>
    <RoomType>sample string 6</RoomType>
    <SOB>sample string 15</SOB>
    <Status>sample string 14</Status>
    <WholeSalerId>sample string 21</WholeSalerId>
    <WholeSalerName>sample string 22</WholeSalerName>
    <Youth>9</Youth>
  </Reservation>
</ArrayOfReservation>