Oracle Hospitality Front Desk Operations API
Front Desk module provides APIs related to a guests stay in the property. For example, checking a guest into the property, providing room information, splitting reservations, as well as adding wake-up calls to a reservation. This module goes hand-in-hand with cashiering module.
Operations 61
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/hotels/{hotelId}/authorizationReservations
Find reservations due a batch card authorization · Get resrvation for batch CCAuth
#
Ask an LLM
“Which reservations still need their credit card authorized in the nightly batch?”
“Can I narrow batch authorization candidates by card type or arrival dates?”
Tell an agent
List reservations eligible for batch credit card authorization at hotel {hotel}.
Show batch card authorization candidates at {hotel} arriving between {start} and {end}.
PUT
/hotels/{hotelId}/batchReservationAuthorizations
Run batch credit card authorization · Process batch CC Auth
#
Ask an LLM
“How do I authorize credit cards for many reservations in one run?”
“Can I submit a list of reservations for batch card authorization?”
Tell an agent
Process batch credit card authorization at hotel {hotel} for reservations {reservations}.
Run the batch card authorization for tonight's arrivals at {hotel}.
GET
/hotels/{hotelId}/billingReservations
Find reservations ready for billing · Get Reservations for billing
#
Ask an LLM
“Which reservations have open folios that the cashier needs to bill?”
“What is the maximum date span when searching reservations for billing?”
Tell an agent
List reservations for billing at hotel {hotel}.
Find billing reservations at {hotel} for guest surname {surname} with open folios.
Ask an LLM
“What is on today's daily docket for the front office?”
“Can I pull the daily docket for one department on a given date?”
Tell an agent
Get the daily docket at hotel {hotel} for {date}.
Show the {department} department's daily docket at {hotel}.
Ask an LLM
“Can I edit entries already on the daily docket?”
“How do I correct a daily docket entry after it was created?”
Tell an agent
Update the existing daily docket entries at hotel {hotel} with {entries}.
Edit today's docket entry at {hotel} to change its department.
Ask an LLM
“What do I send to add a new item to the daily docket?”
“Can I create several daily docket entries in one request?”
Tell an agent
Create a new daily docket at hotel {hotel} with {entries}.
Add a new docket entry at {hotel} for the VIP arrival.
Ask an LLM
“How do I remove a daily docket that is no longer needed?”
“Can I delete a single docket by its id?”
Tell an agent destructive · confirm first
Delete daily docket {docket} at hotel {hotel}.
Remove docket {docket}.
POST
/hotels/{hotelId}/externalRoomKeys
Request room keys from an external door lock · Requests room key(s)
#
Ask an LLM
“How does OPERA Cloud send a key request to an external door lock system via outbound configuration?”
“Which encoder and key type fields are required for an external room key request?”
Tell an agent
Send an external door lock key request at hotel {hotel} on encoder {encoder} terminal {terminal} with key type {keyType}.
Ask the external lock system for {count} keys for room {room}.
Ask an LLM
“Can I see a graphical layout of the floors and rooms in my hotel?”
“Where are the elevators and stairways relative to a given room?”
Tell an agent
Get the floor plans for hotel {hotel}.
Show the floor plan containing room {room} at {hotel}.
GET
/hotels/{hotelId}/fulfillmentActivityLogs
Review the fulfillment activity log · Get the fullfillment activity log
#
Ask an LLM
“What fulfillment activity has been logged at my property recently?”
“How far back can the fulfillment activity log be searched?”
Tell an agent
Show the fulfillment activity log at hotel {hotel} from {from} to {to}.
Search fulfillment activity at {hotel} for text {text}.
GET
/hotels/{hotelId}/interfaces/{interfaceId}/roomStatuses
Get room statuses from a property interface · Get room interface status
#
Ask an LLM
“What room statuses is a connected interface reporting for arriving guests?”
“Can I filter interface room statuses by floor or room class?”
Tell an agent
Get room interface statuses from interface {interface} at hotel {hotel}.
Show interface {interface} room status for guest {lastName}.
PUT
/hotels/{hotelId}/interfaces/{interfaceId}/roomStatuses
Change room statuses on a property interface · Change room interface status
#
Ask an LLM
“Can I push an updated reservation status to a connected room interface?”
“How do I reset the interface status for a guest's room?”
Tell an agent
Update room statuses on interface {interface} at hotel {hotel} with {status}.
Change the interface room status for interface {interface}.
GET
/hotels/{hotelId}/keyInterfaces
Get key encoder interface configuration · Get key encoder interface configuration details
#
Ask an LLM
“Which key encoders are configured for my door lock interface?”
“Can I look up key encoder settings for one interface id?”
Tell an agent
Get key encoder interface details at hotel {hotel}.
Show encoder configuration for interface {interface} at {hotel}.
GET
/hotels/{hotelId}/queuedReservations
List queued reservations waiting for rooms · Get the reservation in queue
#
Ask an LLM
“Which arrived guests are waiting in the queue because their room isn't ready?”
“Can I search the room queue by guest name or room type?”
Tell an agent
List queued reservations at hotel {hotel}.
Find queued guests at {hotel} whose name matches {name}.
PUT
/hotels/{hotelId}/queuedReservations/{reservationId}
Add a reservation to the room queue · Add reservation to queue
#
Ask an LLM
“How do I put an arriving guest in the queue until housekeeping readies a room?”
“Can I queue a reservation when no room of its type is available?”
Tell an agent
Add reservation {reservation} at hotel {hotel} to the room queue.
Queue reservation {reservation} until a room is clean.
DELETE
/hotels/{hotelId}/queuedReservations/{reservationId}
Remove a reservation from the room queue · Delete reservation from queue
#
Ask an LLM
“How do I take a guest out of the queue once their room is assigned?”
“Can I remove one reservation from the queued rooms list?”
Tell an agent destructive · confirm first
Remove reservation {reservation} at hotel {hotel} from the queue.
Take {reservation} off the queued reservations list.
GET
/hotels/{hotelId}/reservationSummaries
Search reservation summaries for a hotel · Get reservation summaries
#
Ask an LLM
“Can I get a quick summary list of reservations by membership number or VIP status?”
“Which reservations are staying over a given date range at my hotel?”
Tell an agent
Get reservation summaries at hotel {hotel} arriving from {start} to {end}.
Find reservation summaries at {hotel} for company {company}.
POST
/hotels/{hotelId}/reservations/ai/rooms
Run AI room assignment for arrivals · AI Assign Rooms
#
Ask an LLM
“Can AI allocate rooms to all of today's incoming reservations?”
“How do I trigger automated intelligence room assignment across several hotels?”
Tell an agent
Run AI room assignment at hotel {hotel}.
Use AI to assign rooms for hotels {hotels}.
GET
/hotels/{hotelId}/reservations/ai/rooms
Check the last AI room assignment run · Automated Intelligence Room Assignment last run status
#
Ask an LLM
“Did the last AI room assignment run finish successfully?”
“When did automated intelligence room assignment last run at my property?”
Tell an agent
Get the last AI room assignment run status for hotel {hotel}.
Show me how the most recent AI room assignment at {hotel} went.
POST
/hotels/{hotelId}/reservations/autoRoomAssignments
Auto-assign rooms to reservations · Assign the room automatically
#
Ask an LLM
“Can the system pick and assign rooms automatically based on criteria?”
“What criteria drive the rule-based auto room assignment?”
Tell an agent
Automatically assign rooms at hotel {hotel} using {criteria}.
Auto-assign rooms to unassigned arrivals at {hotel}.
DELETE
/hotels/{hotelId}/reservations/autoRoomAssignments
Automatically unassign rooms from reservations · Auto unassign room
#
Ask an LLM
“How do I clear room assignments in bulk for a date range?”
“Can I auto-unassign rooms only on a particular floor or room type?”
Tell an agent destructive · confirm first
Auto-unassign rooms at hotel {hotel} from {start} to {end}.
Unassign all {roomType} rooms at {hotel} automatically.
POST
/hotels/{hotelId}/reservations/massAdvanceCheckIns
Advance check in many reservations at once · Mass Advance Check in Reservations
#
Ask an LLM
“Can I flag a whole group of today's arrivals as advance checked in?”
“What criteria select reservations for a mass advance check-in?”
Tell an agent
Mass advance check in reservations at hotel {hotel} matching {criteria}.
Advance check in every early-arriving group reservation at {hotel}.
POST
/hotels/{hotelId}/reservations/massCheckIns
Check in many reservations at once · Mass checkin reservations
#
Ask an LLM
“How do I check in a whole tour group in one step?”
“Can I mass check in reservations that match a set of criteria?”
Tell an agent
Check in, in one batch, every arrival at property {hotel} that fits {criteria}.
Fully check in all of today's group arrivals at {hotel}.
POST
/hotels/{hotelId}/reservations/{reservationId}/advanceCheckIns
Advance check in one reservation · Advance checkin a reservation
#
Ask an LLM
“Can a guest who arrived before their room is ready post charges to their folio?”
“How do I flag a single reservation as advance checked in?”
Tell an agent
Advance check in reservation {reservation} at hotel {hotel}.
Mark {reservation} as advance checked in so the guest can charge to the room.
DELETE
/hotels/{hotelId}/reservations/{reservationId}/advanceCheckIns
Reverse an advance check-in · Reverse Advance Checkin
#
Ask an LLM
“How do I undo an advance check-in flagged by mistake?”
“Can I reverse the advance checked-in status on a reservation?”
Tell an agent destructive · confirm first
Reverse the advance check-in on reservation {reservation} at hotel {hotel}.
Remove the advance check-in flag from {reservation}.
DELETE
/hotels/{hotelId}/reservations/{reservationId}/checkIns
Reverse a guest check-in · Revert a checked-in Reservation
#
Ask an LLM
“How do I put a checked-in reservation back to due in status?”
“Can I unassign the room when I reverse a check-in?”
Tell an agent destructive · confirm first
Reverse the check-in for reservation {reservation} at hotel {hotel}.
Undo check-in on {reservation} and set the room status to {status}.
Ask an LLM
“What status must a reservation be in before I can check the guest in?”
“Can I pick an available room as part of checking in a guest?”
Tell an agent
Check in reservation {reservation} at hotel {hotel}.
Check in the guest on {reservation} and send notifications.
GET
/hotels/{hotelId}/reservations/{reservationId}/keyOptions
Get door lock key options for a reservation · Fetch the keysOptions
#
Ask an LLM
“Which areas like the pool or gym can this guest's room key open?”
“What key option preferences are attached to a reservation's room and profile?”
Tell an agent
Get key options for reservation {reservation} at hotel {hotel}.
Show the door lock access options on {reservation}.
GET
/hotels/{hotelId}/reservations/{reservationId}/linked
List reservations linked to a reservation · Get linked reservations
#
Ask an LLM
“Which other reservations are linked to this booking?”
“Can I see all the rooms linked together for a family's stay?”
Tell an agent
Get reservations linked to {reservation} at hotel {hotel}.
Show the linked reservations for {reservation}.
PUT
/hotels/{hotelId}/reservations/{reservationId}/priority
Change a queued reservation's priority · Change the reservation queue priority
#
Ask an LLM
“Can I move a VIP guest up the room-ready queue?”
“How do I set the queue priority on a waiting reservation?”
Tell an agent
Set queue priority {priority} on reservation {reservation} at hotel {hotel}.
Bump {reservation} to the top of the room queue.
POST
/hotels/{hotelId}/reservations/{reservationId}/roomAssignments
Assign a room to a reservation · Assign a Room to a Reservation
#
Ask an LLM
“How do I assign a specific room to a reserved booking?”
“Can I override warnings to force a room assignment?”
Tell an agent
Assign a room to reservation {reservation} at hotel {hotel} using {criteria}.
Give reservation {reservation} room 412, overriding warnings.
GET
/hotels/{hotelId}/reservations/{reservationId}/roomKeys
Get room key details for a reservation · Fetch the room keys
#
Ask an LLM
“What room keys have already been cut for this reservation?”
“Can I include inactive keys when reviewing a guest's room keys?”
Tell an agent
Get room keys for reservation {reservation} at hotel {hotel}.
List active and inactive keys on {reservation}.
POST
/hotels/{hotelId}/reservations/{reservationId}/roomKeys
Request new room keys for a reservation · Requests room key(s)
#
Ask an LLM
“How do I cut new room keys for a reservation through the door lock interface?”
“Can I set how long a new room key stays valid?”
Tell an agent
Create {count} room keys for reservation {reservation} at hotel {hotel}.
Make a new key for {reservation} valid until {end}.
DELETE
/hotels/{hotelId}/reservations/{reservationId}/roomKeys
Delete room keys on a reservation · Delete room key
#
Ask an LLM
“How do I invalidate the room keys issued for a reservation?”
“Can I delete all keys on a booking after a guest loses them?”
Tell an agent destructive · confirm first
Delete room keys on reservation {reservation} at hotel {hotel}.
Cancel every key issued for {reservation}.
PUT
/hotels/{hotelId}/reservations/{reservationId}/roomKeys
Update existing room keys on a reservation · Update room keys
#
Ask an LLM
“Can I change key options or balances on keys already issued with multiple guest keys active?”
“How do I update room key details for guests sharing a room?”
Tell an agent
Update the existing room keys on reservation {reservation} at hotel {hotel} with key options {options}.
Change the issued keys on {reservation} for room {room}.
GET
/hotels/{hotelId}/reservations/{reservationId}/roomMoveHistory
Get a reservation's room move history · Get room move history of a reservation
#
Ask an LLM
“Which rooms has this guest been moved between during their stay?”
“Can I see the history of room changes on a reservation?”
Tell an agent
Get room move history for reservation {reservation} at hotel {hotel}.
Show all room changes on {reservation}.
PUT
/hotels/{hotelId}/reservations/{reservationId}/rooms
Unassign the room from a reservation · Remove an assigned room
#
Ask an LLM
“How do I remove the assigned room from a reserved booking?”
“Can I unassign a room even if the room number is locked?”
Tell an agent destructive · confirm first
Remove the assigned room from reservation {reservation} at hotel {hotel}.
Unassign the room on {reservation}, overriding the room number lock.
PUT
/hotels/{hotelId}/reservations/{reservationId}/rooms/{roomId}/roomMoves
Move an in-house guest to another room · Move in-house guest
#
Ask an LLM
“A checked-in guest wants a different room, how do I move them?”
“Can I record a room move for a guest who is already in house?”
Tell an agent
Move in-house reservation {reservation} at hotel {hotel} from room {room}.
Relocate the guest on {reservation} out of room {room} using {criteria}.
GET
/hotels/{hotelId}/reservations/{reservationId}/suggestedRooms
Get suggested rooms for a reservation · Get Suggested Rooms
#
Ask an LLM
“Which rooms does the system recommend for this reservation?”
“Can I get room suggestions that have a particular feature?”
Tell an agent
Get suggested rooms for reservation {reservation} at hotel {hotel}.
Suggest {roomType} rooms for {reservation} with feature {feature}.
PUT
/hotels/{hotelId}/reservations/{reservationId}/textMessages/{messageType}
Text a queued guest that their room is ready · Deliver Queue rooms text message
#
Ask an LLM
“Can I send a text message to a queued guest when their room is ready?”
“How do I deliver the queue rooms SMS for a reservation?”
Tell an agent
Send the {type} queue text message for reservation {reservation} at hotel {hotel}.
Text the guest on {reservation} with message type {type}.
GET
/hotels/{hotelId}/reservations/{reservationId}/verifyCheckIns
Verify a reservation can be checked in · Verify checkin reservation
#
Ask an LLM
“Is this reservation ready to be checked in, or are there blockers?”
“What checks run before a check-in is allowed?”
Tell an agent
Verify check-in readiness for reservation {reservation} at hotel {hotel}.
Pre-check whether {reservation} passes check-in validation.
GET
/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls
Get wake-up calls on one reservation · Get Wake Up Call
#
Ask an LLM
“What wake-up calls are set for this in-house guest?”
“Can I include completed or no-answer wake-up calls for a single reservation?”
Tell an agent
Get wake-up calls for reservation {reservation} at hotel {hotel}.
Show pending wake-up calls on {reservation} from {begin}.
PUT
/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls
Change a wake-up call · Change Wake Up Call
#
Ask an LLM
“How do I move an existing wake-up call to a different time?”
“Can I edit a wake-up call on an in-house reservation?”
Tell an agent
Update the existing wake-up call on reservation {reservation} at hotel {hotel} with {calls}.
Reschedule the wake-up call on {reservation} to 6:30 am.
DELETE
/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls
Cancel a wake-up call · Delete Wake Up Call
#
Ask an LLM
“How do I cancel a guest's wake-up call?”
“Can I cancel just the wake-up call set for a specific time?”
Tell an agent destructive · confirm first
Cancel the wake-up call on reservation {reservation} at hotel {hotel}.
Cancel the {time} wake-up call for {reservation}.
POST
/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls
Set a wake-up call for a guest · Create Wake Up Call
#
Ask an LLM
“Can I schedule a wake-up call for a guest who hasn't checked in yet?”
“What do I send to set a new wake-up call on a reservation?”
Tell an agent
Create a wake-up call on reservation {reservation} at hotel {hotel} with {calls}.
Set a new 7 am wake-up call for {reservation}.
GET
/hotels/{hotelId}/reservationsKeyOptions
Get key options for several reservations · Fetch keysOptions for the reservation and the guest profile
#
Ask an LLM
“Can I fetch door lock key options for a batch of reservations at once?”
“Which access areas do the keys for a list of reservations allow?”
Tell an agent
Get key options for reservations {reservations} at hotel {hotel}.
Show the combined reservation and profile key options for {reservations}.
Ask an LLM
“Can I read what's encoded on a key card sitting in the encoder?”
“Which room and guest does this key card belong to?”
Tell an agent
Read the room key on encoder terminal {terminal} at hotel {hotel}.
Read the key card on encoder {encoder}.
POST
/hotels/{hotelId}/roomKeysExternal
Request room keys via external lock with key user type · Requests room key(s)
#
Ask an LLM
“What fields like key request time and key user type does the roomKeysExternal endpoint require?”
“Can I send card serial number and print data with an external key request?”
Tell an agent
Request {roomKeyType} keys at {hotel} on encoder {encoder}/{terminal}, key type {keyType}, user type {userType}, at {time}.
Send a roomKeysExternal request for card serial {serial}.
Ask an LLM
“Which clean vacant rooms can I assign to an arriving reservation?”
“Can I search rooms by floor, room class or smoking preference?”
Tell an agent
Find assignable rooms at hotel {hotel} of room type {roomType}.
Search rooms at {hotel} on floor {floor} with status {status}.
Ask an LLM
“How do I hold a room so nobody else assigns it?”
“Can I place several rooms on hold at once?”
Tell an agent
Place rooms on hold at hotel {hotel} with {details}.
Hold room 305 at {hotel} for an incoming VIP.
Ask an LLM
“How do I free up a room that was placed on hold?”
“Can I release held rooms even if another user placed the hold?”
Tell an agent
Release held rooms at hotel {hotel} with {details}.
Release the hold on room 305 at {hotel}.
Ask an LLM
“What open service requests do guests have at my hotel?”
“Can I filter service requests by department or priority?”
Tell an agent
List service requests at hotel {hotel}.
Show service requests at {hotel} for reservation {reservation}.
Ask an LLM
“How do I mark a guest service request as completed?”
“Can I change the details of an existing service request?”
Tell an agent
Update existing service requests at hotel {hotel} with {details}.
Close the broken-AC service request at {hotel}.
POST
/hotels/{hotelId}/serviceRequests
Create a service request on a reservation · Create Service Requests
#
Ask an LLM
“Can I log a guest complaint as a service request to track and follow up?”
“What does a new service request need to include?”
Tell an agent
Create a service request at hotel {hotel} with {details}.
Open a new service request at {hotel} for extra towels in room 210.
DELETE
/hotels/{hotelId}/serviceRequests/{serviceRequestId}
Delete a service request · Delete Service Requests
#
Ask an LLM
“How do I delete a service request logged in error?”
“Can I remove a single service request by its id?”
Tell an agent destructive · confirm first
Delete service request {request} at hotel {hotel}.
Remove service request {request}.
PUT
/hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/shiftRooms
Shift a room from one reservation to another · Operation for Shift Rooms between two reservations
#
Ask an LLM
“Can I hand one reservation's room over to another reservation in one step?”
“What does shifting rooms between two reservations do to the source booking?”
Tell an agent
Shift the room from reservation {source} to reservation {target} at hotel {hotel}.
Give {target} the room currently held by {source}.
PUT
/hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/swapRooms
Swap rooms between two reservations · Operation for Swap/Shift Rooms between two reservations
#
Ask an LLM
“How do I swap the rooms of two guests with each other?”
“Can I exchange rooms between two reservations without unassigning either?”
Tell an agent
Swap rooms between reservation {source} and reservation {target} at hotel {hotel}.
Exchange rooms so {source} and {target} trade places.
GET
/hotels/{hotelId}/textMessages/{messageType}
Preview the queue room text message · Get Queue room text message
#
Ask an LLM
“What text will a queued guest receive when their room is ready?”
“Can I look up the queue rooms message for a given mobile number?”
Tell an agent
Get the {type} queue room text message at hotel {hotel}.
Preview queue message {type} for reservation {reservation}.
Ask an LLM
“Which wake-up calls are scheduled at my hotel for tomorrow morning?”
“Can I list hotel-wide wake-up calls that got no answer?”
Tell an agent
List all wake-up calls at hotel {hotel} from {begin} to {end}.
Show hotel-wide wake-up calls at {hotel} for room {room}.
POST
/hotels/{hotelId}/wakeUpCalls/searches
Search wake-up calls with a request body · Get Wake Up Calls
#
Ask an LLM
“Can I search wake-up calls by posting the filters in a request body?”
“Is there a POST search for wake-up calls filtered by guest name?”
Tell an agent
Search wake-up calls at hotel {hotel} for guest {guest}.
Run a wake-up call search at {hotel} for block {block}.
GET
/services/frontDeskOperations/status
Check the front desk service is up · Ping Front Desk Service
#
Ask an LLM
“Is the front desk operations service responding?”
“Can I health-check the front desk API before running check-ins?”
Tell an agent
Ping the front desk operations service.
Health-check the front desk API as hotel {hotel}.
Documentation
📖
Documentation
https://docs.oracle.com/cd/F29336_01/doc.201/f27480/c_oracle_hospitality_distribution_apis.htm
📖
Documentation
https://docs.oracle.com/cd/F29336_01/doc.201/f27480/c_oracle_hospitality_nor1_integrated_upsell_apis.htm
📖
Documentation
https://docs.oracle.com/cd/F29336_01/doc.201/f27480/c_property_apis.htm