Hotelumo API 1.0.0

GET/api/hotels/{hotelId}/availability

Find public room offers for a stay

Returns sanitized room-type offers for the requested dates and occupancy. Prices and inventory are calculated by the server.

Parameters

Responses

POST/api/hotels/{hotelId}/book-reservation

Request a room reservation

Revalidates the selected offer, then creates a REQUESTED reservation with one unassigned PENDING room for hotel staff to approve.

Responses

GET/api/dailyRates

List daily rates

Reads per-day prices/inventory for a rate plan over a date window (the ARI surface). Pass hotelId, ratePlanId, dateFrom and dateTo. Requires the rates:read scope.

Parameters

Responses

POST/api/dailyRates

Upsert daily rates

Batch-upserts per-day prices/inventory (max 500 per call). Requires the rates:write scope.

Responses

GET/api/guests

List guests

Lists the guests of your organization, optionally filtered by hotelId, email or _ids. Requires the guests:read scope.

Parameters

Responses

POST/api/guests

Create a guest

Requires the guests:write scope.

Responses

GET/api/guests/{guestId}

Get a guest

Returns a single guest by id. Guests belonging to another organization respond 404. Requires the guests:read scope.

Parameters

Responses

PUT/api/guests/{guestId}

Update a guest

Updates a guest by id. Guests belonging to another organization respond 404. Requires the guests:write scope.

Parameters

Responses

DELETE/api/guests/{guestId}

Delete a guest

Deletes a guest by id. Guests belonging to another organization respond 404. Requires the guests:write scope.

Parameters

Responses

GET/api/ratePlans

List rate plans

Lists the rate plans for a hotel (pass hotelId). Rate plans are part of the ARI pricing surface, so this requires the rates:read scope.

Parameters

Responses

POST/api/ratePlans

Create or update a rate plan

Requires the rates:write scope.

Responses

GET/api/reservations

List reservations

Lists the reservations of your organization. Optionally filter by hotelId, guestId, a legacy startTime/endTime window, or an overlapping stay window with stayDateFrom/stayDateTo. Requires the reservations:read scope.

Parameters

Responses

POST/api/reservations

Create a reservation

Creates a reservation (and its ReservationRooms from the rooms array). Requires the reservations:write scope.

Responses

GET/api/reservations/{reservationId}

Get a reservation

Returns a single reservation by id, with its rooms. Reservations belonging to another organization respond 404. Requires the reservations:read scope.

Parameters

Responses

PUT/api/reservations/{reservationId}

Update a reservation

Updates a reservation by id. Reservations belonging to another organization respond 404. Requires the reservations:write scope.

Parameters

Responses

DELETE/api/reservations/{reservationId}

Delete a reservation

Deletes a reservation by id (cascading its rooms, folio and charges). Reservations belonging to another organization respond 404. Requires the reservations:write scope.

Parameters

Responses

POST/api/reservations/{reservationId}/approve

Approve a requested reservation

Rechecks inventory, promotes the parent to CONFIRMED and each PENDING room to CONFIRMED, then starts the normal folio/reminder workflow. Requires the reservations:write scope.

Responses

GET/api/rooms

List rooms

Lists the physical rooms of your organization, optionally filtered by hotelId or roomTypeId. Requires the rooms:read scope.

Parameters

Responses

POST/api/rooms

Create a room

Requires the rooms:write scope.

Responses

GET/api/roomTypes

List room types

Lists the room types of your organization, optionally filtered by hotelId. Room types are part of the physical inventory, so this requires the rooms:read scope.

Parameters

Responses

POST/api/roomTypes

Create a room type

Requires the rooms:write scope.

Responses

GET/api/webhooksubscriptions

List webhook subscriptions

Webhook subscriptions deliver reservation.created, reservation.updated, reservation.deleted, guest.created, guest.updated and guest.deleted events to your server as signed POST requests (X-Hotelumo-Signature: t=<timestamp>,v1=<hex HMAC-SHA256 of "timestamp.body">). An endpoint failing 20 times in a row is disabled automatically. Subscriptions are managed with an operator access token; the secret is only returned once, on create.

Responses

POST/api/webhooksubscriptions

Create a webhook subscription

The response includes the signing secret exactly once — store it; it cannot be retrieved again.

Request body application/json

Responses

PUT/api/webhooksubscriptions/{webhookSubscriptionId}

Update a webhook subscription

url, events and active are editable; the secret and hotel are immutable. Re-enabling an auto-disabled endpoint is done by setting active back to true.

Parameters

Responses

DELETE/api/webhooksubscriptions/{webhookSubscriptionId}

Delete a webhook subscription

Delete a webhook subscription

Parameters

Responses