2019
September 2019
During September we fixed a few bugs and created a new method that provides you with the list of sources that property has available.
| Endpoint(s) | Description |
|---|---|
| getSources (new) | New method that returns all reservation sources enabled or created in a property account. |
| getRate and getRatePlans | Improved validation of the number of children and adults. |
August 2019
Lately, we've been focusing on maintenance, but we also found time to add two new API methods that allow you to see the reservation and guest notes.
| Endpoint(s) | Description |
|---|---|
| getReservationNotes (new) | See reservation notes filtered by reservationID. |
| getGuestNotes (new) | See guest notes filtered by guestID. |
| oauth | Added state parameter that allows passing dynamic parameters in the OAuth URL. |
| getReservations | Added the list of unassigned rooms within the guest details. |
June 2019
In June, the following improvements to our API
| Endpoint | Change |
|---|---|
| getRooms, getAvailableRoomTypes, getReservations, getReservationAssignments, getRoomsUnassigned, getReservationRoomDetails | Added dormRoomName field that provides the name of the room in the shared room type. Helps with understanding which beds belong to the same physical room. |
| getTransactions | Added the filter by transactionID |
April/May 2019
In our API Documentation we've added a label "Group account support" to all the endpoints that can provide you with the data of the group properties without the need for calling each property.
This works only if your app has Supporting Group Accounts enabled.
| Endpoint | Change |
|---|---|
| getReservationsWithRateDetails | Added reservationID parameter |
| deleteItemFromReservation | Method was deprecated, use postVoidItem instead |
March 2019
Updates to Housekeeping related API calls
We added new housekeeping endpoints that allow you to manage Housekeepers. As a part of this project, some of our other housekeeping calls were improved. Now, new scope housekeeping is a requirement for Housekeeping-related calls.
| Endpoint(s) | Description |
|---|---|
| getHousekeepers (new) | Provides the list of housekeepers available in myfrontdesk with name and ID. |
| putHousekeeper (new) | Allows the housekeeper's name to be edited. |
| postHousekeeper (new) | A housekeeper can be added to myfrontdesk. |
| postHousekeepingAssignment (new) | Assign rooms (single or multiple) to an existing housekeeper |
| postHousekeepingStatus | Added parameter “status”which allows you to set a specific status instead of switching the status dirty/clean. |
| getHousekeepingStatus | Added possibility to filter by housekeeperID |
| getHousekeepingStatus & getRooms | Information about blocked rooms (by out of service block or courtesy holds) was added to the response to these calls. |
Changes and new endpoints
| Endpoint(s) | Description |
|---|---|
| userinfo (new) | To OAuth flow, we added this new endpoint which allows you to identify and see email information from the user that has authorized/approved the application connection. |
| putResesrvationDetails & getPaymentRecent | These calls were soft deprecated and we won't develop and fix them going forward. |
| getRoomsUnassigned & getRooms | We clarified the description for parameters startDate/endDate. These are not check-in check-out dates and can be used as “stay dates”. |
| getReservationRoomDetails | Added all guests to the response. |
| getReservationInvoiceInformation, getPayments & getTransactions | Added UTC time |
February 2019
API Rate Throttling
On the 7th of February, we rolled out rate limiting for application and individual property API users.
API users that exceed request limits will be restricted at the application level.
API rate limits:
5 requests per second for individual or group properties
10 requests per second for applications/technology partners
New API methods and changes
| Method | Change |
|---|---|
| getTaxesAndFees (new) | It shows property's taxes and fees along with their associated details. |
| getReservationRoomDetails | Parameter reservationRoomID has been soft deprecated. |
| postItem | Added subReservationID parameter |
| getReservation | Added guestGender to results |
| getReservationInvoiceInformation | Added taxID and itemCode to results |
January 2019
Improvements to refresh token flow
We made an improvement to the OAuth flow. The old refresh token won't be invalidated until you used the access token from the new pair. This will enable you to obtain new access tokens several times in case of outages and maintenances on our end.
Edit the redirect URI on App Details page
Now you can change your redirect URI anytime in your Cloudbeds Tech Partner Account’s > App Details page.
Changes to API methods
| Method | Change |
|---|---|
| getTransactions, getHouseAccountDetails | Added parentTransactionID. Parent transaction is a transaction to which this current transaction is strongly related to or derived from. Example: Parent transaction to a room rate tax is a room rate. This parent transaction ID will mostly be present on transactions that are taxes, fees and voids. It will not be present on room rates, items and payments. |
| postReservation | Added reservation statuses confirmed and not_confirmed to the call response. Not confirmed corresponds to Confirmation Pending in the myfrontdesk UI and is applied when MFD user sets this in the Policies settings. |
| putReservationDetails | We now show a failed message when an API user is trying to set checked_in status if the previous reservations haven’t been checked out of the room or rooms aren’t assigned. It’s not possible to check in a guest if those conditions aren’t met. |
| getReservationRoomDetails | Added the subReservationID request parameter so that the system can be queried using this value. |
| getGuestsByStatus | Added the response parameter isDeleted as a flag for deleted reservations/guests. |
| getGuest, getGuestList, getGuestsByStatus, getGuestsModified, getReservation, getReservations, | Included Tax ID, Company Tax ID and Company name to the results for guest details in multiple methods that contain guest details. |
| postAppState, getAppState and integration webhook | The scope parameter was removed. You don’t need to send us scope for these calls anymore. |