Eres
Provides statistical hotel-information
| API | Description | Last Change Date |
|---|---|---|
| GET hotels/{hotelId}/eres/prices?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets all the configured rates by room type on a specific date range (max. 60 days) |
2015-12-29 |
Groups
| API | Description | Last Change Date |
|---|---|---|
| GET hotels/{hotelId}/groups/availability?key={key}&fromDate={fromDate}&toDate={toDate}&tRateIds={tRateIds} |
Gets all group availabilities on a specific date range (max. 60 days) and assigned to any of the Template Rates passed |
2015-12-29 |
| GET hotels/{hotelId}/groups?key={key}&date={date} |
Gets all Groups for the hotel specified on a specific date. |
2015-12-29 |
CityLedger
| API | Description | Last Change Date |
|---|---|---|
| GET hotels/{hotelId}/cityledger/agedbalance?key={key}&date={date} |
Gets the Aged Balance Report raw data |
2019-10-01 |
Maintenance
Used for maintenance and configuration
| API | Description | Last Change Date |
|---|---|---|
| GET ping |
Are you there? This is a health check endpoint |
2015-12-29 |
Guest
Supplies Guests and Guest-related information and allows to create and update Guests. The calling application can only retrieve and manipulate Information related to a property enabled for that application The mapping is done based on the supplied API-Key
| API | Description | Last Change Date |
|---|---|---|
| GET hotels/{hotelId}/guests?key={key}&date={date} |
Gets all Guests for the hotel specified that have been created on a specific date. |
2015-12-29 |
| GET hotels/{hotelId}/guests?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets all Guests for the hotel specified that have been created on a specific date range (max. 60 days). |
2015-12-29 |
| GET hotels/{hotelId}/guests/{guestId}?key={key} |
Gets a Guest by its ID for the hotel specified |
2015-12-29 |
| GET hotels/{hotelId}/guests/roominquiry?key={key}&roomNumber={roomNumber} |
Gets GuestInRoomInfo by its Room Number for the hotel specified |
2015-12-29 |
Hotel
Supplies Hotel and hotel-related Data Calling applications can only access Hotels they have been assigned to, this mapping is done based on the supplied API-Key
| API | Description | Last Change Date |
|---|---|---|
| GET hotels?key={key} |
Gets all Hotels available to the calling API Key |
2015-12-29 |
| GET hotels/{hotelId}?key={key} |
Gets the Hotel specified by the HotelId parameter. Returns 404 (not found) if the hotel doesn't exist. |
2015-12-29 |
| GET hotels/{hotelId}/server?key={key} |
Gets the Server name of the Hotel specified by the HotelId parameter. Returns 404 (not found) if the hotel doesn't exist. |
2017-11-07 |
| GET hotels/{hotelId}/availabilities?key={key}&date={date} |
Gets Room Availability for the hotel specified on a specific date |
2015-12-29 |
| GET hotels/{hotelId}/availabilities?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets Room Availability for the hotel specified on a specific date range |
2015-12-29 |
ReservationRateDetail
| API | Description | Last Change Date |
|---|---|---|
| GET hotels/{hotelId}/reservations/reservationratedetail/cancellations?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets all Reservations with rate detail for the hotel specified that have been cancelled on a specific date range (max. 60 days) and their related Guest Profiles. |
2019-09-17 |
| GET hotels/{hotelId}/reservations/reservationratedetail?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets all Reservations with rate detail for the hotel specified that have arrived on a specific date range (max. 60 days) and their related Guest Profiles. Checked-in, checked-out and cancelled reservations are not returned. |
2019-09-17 |
| GET hotels/{hotelId}/reservations/reservationratedetail/reserved?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets all Reservations with rate detail for the hotel specified that have been created on a specified date range (max. 60 days) and their related Guest Profiles. Checked-in, checked-out and cancelled reservations are not returned. |
2019-09-17 |
| GET hotels/{hotelId}/reservations/reservationratedetail/inhouse?key={key} |
Gets all Reservations In House with rate detail for the hotel specified and their related Guest Profiles. |
2019-09-17 |
| GET hotels/{hotelId}/reservations/reservationratedetail/checkedout?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets all Reservations with rate detail for the hotel specified that have been checked-out on a specific date range (max. 60 days) and their related Guest Profiles. |
2019-09-17 |
Rate
Supplies Hotel and hotel-related Data Calling applications can only access Hotels they have been assigned to, this mapping is done based on the supplied API-Key
| API | Description | Last Change Date |
|---|---|---|
| GET hotels/{hotelId}/rates?key={key}&date={date} |
Gets all Rate Codes for the hotel specified on a specific date. |
2015-12-29 |
| GET hotels/{hotelId}/rates?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets all Rate Codes for the hotel specified on a specific date range |
2015-12-29 |
| GET hotels/{hotelId}/ratetemplates?key={key} |
Gets all RateTemplates for the hotel specified |
2015-12-29 |
| GET hotels/{hotelId}/ratecategories?key={key} |
Gets all RateCategories for the hotel specified |
2015-12-29 |
| GET hotels/{hotelId}/ratesandroomtypes?key={key} |
Gets all active Rates and their Roomtypes for the hotel specified |
2015-12-29 |
Transactions for Reservations
Supplies Transactions and Transaction-related information for reservations only (does not include Sundry Sales, City Ledger, or Posting Folios; for full transactions, refer to Receipts Endpoint under Statistics). The calling application can only retrieve Information related to a property enabled for that application The mapping is done based on the supplied API-Key
| API | Description | Last Change Date |
|---|---|---|
| GET hotels/{hotelId}/transactions?key={key}&date={date} |
Gets all Transactions created on a specific Date for the hotel specified. |
2015-12-29 |
| GET hotels/{hotelId}/transactions?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets all Transactions created during a specific Date Range for the hotel specified. |
2015-12-29 |
| POST hotels/{hotelId}/transactions/roomcharges?key={key} |
Posts room related charges to the RoomKey Backend |
2015-12-29 |
Statistics
Provides statistical hotel-information
| API | Description | Last Change Date |
|---|---|---|
| GET hotels/{hotelId}/statistics/operation?key={key}&date={date} |
Gets operational forecast analysis for the hotel specified on a specific date. Valid for future dates only. |
2015-12-29 |
| GET hotels/{hotelId}/statistics/operation?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets daily operational forecast analysis for the hotel specified on a specific date range. The maximum date range is limited to 60 days. Valid for future dates only. |
2015-12-29 |
| GET hotels/{hotelId}/statistics/prices?key={key}&date={date} |
Gets all the configured rates by room type on a specific date |
2015-12-29 |
| GET hotels/{hotelId}/statistics/prices?key={key}&date={date}&rateId={rateId}&roomTypeId={roomTypeId} |
Gets all the configured rates of a room type on a specific date |
2015-12-29 |
| GET hotels/{hotelId}/statistics/prices?key={key}&fromDate={fromDate}&toDate={toDate}&rateId={rateId}&roomTypeId={roomTypeId} |
Gets all the configured rates of a room type on a specific date range (max. 60 days) |
2015-12-29 |
| GET hotels/{hotelId}/statistics/prices?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets all the configured rates by room type on a specific date range (max. 60 days) |
2015-12-29 |
| GET hotels/{hotelId}/statistics/summary?key={key}&date={date} |
Gets a operational statistics-summary for the hotel specified on a specific date |
2015-12-29 |
| GET hotels/{hotelId}/statistics/summary?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets a daily operational statistics-summary for the hotel specified on a specific date range |
2015-12-29 |
| GET hotels/{hotelId}/statistics/receipts?key={key}&date={date} |
Gets all Receipts for the hotel specified on a date |
2019-09-17 |
| GET hotels/{hotelId}/statistics/roomtypeinventory?key={key}&fromDate={fromDate}&toDate={toDate} |
Get the inventory calendar for the specified hotel on a specific date range The maximum date range is limited to 30 days. |
2015-12-29 |
Reservation
| API | Description | Last Change Date |
|---|---|---|
| GET hotels/{hotelId}/reservations?key={key}&date={date} |
Gets all Reservations for the hotel specified that have been created on a specific date. |
2017-10-10 |
| GET hotels/{hotelId}/reservations?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets all Reservations for the hotel specified that have been created on a specific date range (max. 60 days). |
2017-10-10 |
| GET chains/{chainId}/reservations/cancellations?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets all Reservations Cancellations for the hotel chain specified that have been cancelled on a specific date range (max. 60 days). |
2021-01-28 |
| GET hotels/{hotelId}/reservations/guestprofile/cancellations?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets all Reservations for the hotel specified that have been cancelled on a specific date range (max. 60 days) and their related Guest Profiles. |
2021-01-28 |
| GET hotels/{hotelId}/reservations/guestprofile?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets all Reservations for the hotel specified that will arrive on a specific date range (max. 60 days) and their related Guest Profiles. Checked-in, checked-out and cancelled reservations are not returned. |
2021-01-28 |
| GET hotels/{hotelId}/reservations/guestprofile/reserved?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets all Reservations for the hotel specified that have been created on a specified date range (max. 60 days) and their related Guest Profiles. Checked-in, checked-out and cancelled reservations are not returned. |
2021-01-28 |
| GET hotels/{hotelId}/reservations/guestprofile/inhouse?key={key} |
Gets all Reservations In House for the hotel specified and their related Guest Profiles. |
2021-01-28 |
| GET hotels/{hotelId}/reservations/guestprofile/checkedout?key={key}&fromDate={fromDate}&toDate={toDate} |
Gets all Reservations for the hotel specified that have been checked-out on a specific date range (max. 60 days) and their related Guest Profiles. |
2021-01-28 |