Skip to content
API Reference
/
reservation
/
Check In

Check In Service API (1.0.0)

Pass Check In and Check Out Information to CLC

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://docs.roomex.com/_mock/api/openapi/

Mock Server

https://c3a1ba49-c2e4-4e2f-829e-1195823e9d09.mock.pstmn.io/

reservation

Operations

Check In

Request

Pass all relevant check in infomation to check in a guest

Security
ApiKey
Bodyapplication/jsonrequired

Check In

employeeIdentifierstring
supplierReservationIdstringrequired
sourcestringrequired

The source from which the booking came from

checkInDateTimestring(date-time)(DateTimeOffset)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\+|\-)...required

Date and time with timezone offset, e.g., 2024-10-17T14:30:00-05:00

Example: "2024-10-17T14:30:00-05:00"
roomNumberstringrequired
folioNumberstringrequired
guestFirstNamestringrequired
guestLastNamestringrequired
roomTypestring
expectedCheckOutDateTimestring
reservationInformationobject
loyaltystring

The loyalty number assigned or credited with the reservation

occupancyinteger
numberOfNightsintegerrequired
curl -i -X POST \
  https://docs.roomex.com/_mock/api/openapi/api/v1/reservation/checkin \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "employeeIdentifier": "1234345",
    "supplierReservationId": "1234",
    "source": "HOS",
    "checkInDateTime": "2024-10-17T14:30:00-05:00",
    "roomNumber": "204",
    "folioNumber": "204",
    "guestFirstName": "Ada",
    "guestLastName": "Lovelace",
    "loyalty": "hhonors",
    "numberOfNights": 2
  }'

Responses

Request Processed Successfully

Bodyapplication/json
statusstring
Response
application/json
{
  "status": "checked_in"
}

Check Out

Request

Pass all relevant check out infomation to check out a guest

Security
ApiKey
Bodyapplication/jsonrequired

Check Out Request

employeeIdentifierstring
supplierReservationIdstringrequired
checkInDateTimestring(date-time)(DateTimeOffset)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\+|\-)...required

Date and time with timezone offset, e.g., 2024-10-17T14:30:00-05:00

Example: "2024-10-17T14:30:00-05:00"
roomNumberstringrequired
folioNumberstringrequired
guestFirststring
guestLastNamestringrequired
totalNumberOfNightsinteger
occupancyintegerrequired
curl -i -X POST \
  https://docs.roomex.com/_mock/api/openapi/api/v1/reservation/checkout \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "employeeIdentifier": "1234345",
    "supplierReservationId": "1234",
    "checkOutDateTime": "2025-10-17T14:30:00-05:00",
    "roomNumber": "204",
    "folioNumber": "204",
    "guestFullName": "Ada Lovelace",
    "checkInDateTime": "2024-10-17T14:30:00-05:00"
  }'

Responses

Request Processed Successfully

Bodyapplication/json
statusstring
Response
application/json
{
  "status": "checked_out"
}

Get Status of Reservation

Request

Endpoint to Get the Status of a Reservation

Security
ApiKey
Path
requestIdstringrequired
Example: bb8350fc-dce1-41a1-91b1-91b0d64b5eeb
curl -i -X GET \
  https://docs.roomex.com/_mock/api/openapi/api/v1/reservation/status/bb8350fc-dce1-41a1-91b1-91b0d64b5eeb \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Responses

Request Processed Successfully

Bodyapplication/json
statusstring
Response
application/json
{
  "employeeIdentifier": "123456789"
}