Reservation State Update
With this endpoint, PMS will be able to change state of a reservation to 'confirmed' or 'canceled' . The capability of the state updates on a reservation is indicated with 'requires_response' key in reservation object. If this key is true, then PMS will be able to update state.
Request
// Example Request Snippet for JavaScript XHR
var settings = {
"async": true,
"crossDomain": true,
"url": "https://app.hotelrunner.com/api/v2/apps/reservations/fire?token=TOKEN&hr_id=HR_ID&hr_number=R387266425&event=EVENT&cancel_reason=CANCEL+REASON",
"method": "PUT",
"headers": {
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
The above command returns json structured like this:
{
"status": "ok",
}
or
{
"status": "error",
"message": "state_change_is_not_available"
}
Query Parameters
// Example Request Snippet for JavaScript XHR var settings = { "async": true, "crossDomain": true, "url": "https://app.hotelrunner.com/api/v2/apps/reservations/fire?token=TOKEN&hr_id=HR_ID&hr_number=R387266425&event=EVENT&cancel_reason=CANCEL+REASON", "method": "PUT", "headers": { "cache-control": "no-cache", } } $.ajax(settings).done(function (response) { console.log(response); });
The above command returns json structured like this:
{
"status": "ok",
}
or
{
"status": "error",
"message": "state_change_is_not_available"
}
| Parameter | Default | Required | Description |
|---|---|---|---|
| hr_number | - | Yes | Reservation code on HotelRunner |
| event | - | Yes | Next state events. Can be one of the followings: confirm, cancel. |
| cancel_reason | - | Yes | If event is cancel, then cancel reason must be one of the followings: customer, no_room, no_show, invalid_price . |