Skip to main content

SynXis Property Hub - Rooms

Hotel
Search
REST API
Hospitality
Try Now

What is it?

This API allows a hotelier to manage housekeeping, occupancy, out of inventory, and out of order statuses for specific rooms in a hotel.

Why use it?

This API can be used to retrieve or update the status on a room.

How it works

This set of APIs allows to perform the following room operations:

  • Retrieve housekeeping status, occupancy status, OOO, OOI status of rooms(s) in SPH.
  • Retrieve list of rooms, room types and description.
  • Retrieve OOO reason codes.
  • Retrieve OOI reason codes.
  • Update Housekeeping Status of the Room.
  • Update Occupancy Status of the Room.
  • Update Out of Inventory Status of the Room.
  • Release Out of Inventory Status of the Room.
  • Update Out of Order Status of the Room.
  • Release Out of Order Status of the Room.

How to use

Retrieve Room Status

Retrieves housekeeping, occupancy, and out of order room status for a list of room numbers.

Room statuses:

  • clean/dirty (housekeepingStatus)
  • occupied/vacant (occupancyStatus)
  • OOO/OOI (outOfOrderStatus)

Sample Request

[POST] /sph/rooms/status

{
  "roomNumbers": [
    "111"
  ]
}

Sample Response

{
  "data": {
    "rooms": [
      {
        "roomNumber": "111",
        "roomType": "NK1",
        "housekeepingStatus": "clean",
        "occupancyStatus": "occupied",
        "outOfOrderStatus": "OOO"
      }
    ],
    "totalRoomsCount": 1
  }
}


Retrieve Guest Rooms

Retrieves a list of rooms, room types, and room descriptions for a hotel.

[GET] /sph/rooms/guest-rooms

Sample Response

{
  "data": {
    "rooms": [
      {
        "roomTypeCode": "NK1",
        "roomUnitNo": "111",
        "description": "Queen Room",
        "floor": "1",
        "connLeftRoomUnitNo": "112",
        "connRightRoomUnitNo": "110",
        "phoneExtension": "7363724095"
      }
    ],
    "totalRoomsCount": 10
  }
}


Retrieve Out Of Order (OOO) Reason Codes

Retrieves Out of Order reason codes for a given property.

[GET] /sph/rooms/ooo/reason-codes

Note: Rooms are set to OOO if there are any minor issues like a thorough cleaning required, carpet shampooing, or block a floor of rooms due to low season, etc. The OOO rooms remain in availability and they can be released as required.

Sample Response

{
  "data": {
    "reasonCodes": [
      {
        "reasonCode": "CLEAN",
        "description": "Cleaning in progress"
      }
    ]
  }


Retrieve Out Of Inventory Reason Codes

Retrieves Out of Inventory (OOI) reason codes for a given property.

[GET] /sph/rooms/ooi/reason-codes

Note: Rooms may be unavailable for assignment to guests for various reasons, for example, maintenance work or repairs in the room, etc. The OOI rooms are not counted as available inventory.

Sample Response

{
  "data": {
    "reasonCodes": [
      {
        "reasonCode": "CLEAN",
        "description": "Cleaning in progress"
      }
    ]
  }
}


Update Housekeeping Status

Updates housekeeping status of the room based on the room number.

  • Housekeeping status ("1"-dirty or "2"-clean)

Sample Request

[POST] /sph/rooms/housekeeping-status

{
  "housekeepingStatusId": 1,
  "roomNumbers": [
    "111"
  ]
}


Update Occupancy Status

Updates occupancy status of the room based on the room number.

  • Occupancy status ("Vacant" or "Occupied")

Sample Request

[POST] /sph/rooms/occupancy-status

{
  "occupancyStatus": "Vacant",
  "roomNumbers": [
    "111"
  ]
}


Update Out of Inventory Status

Updates Out of Inventory (OOI) status of the room based on the room number.

  • Configured reason code for OOI provided in reasonCode.

Sample Request

[PUT] /sph/rooms/ooi/status

{
  "startDate": "2020-04-14",
  "endDate": "2020-04-15",
  "reasonCode": "REASON_CODE",
  "note": "Reason Message",
  "roomNumbers": [
    "111"
  ]
}


Release Out of Inventory Status

Releases Out of Inventory (OOI) status of the room for the specified dates.

Sample Request

[POST] /sph/rooms/ooi/status/release

{
  "startDate": "2020-04-14",
  "endDate": "2020-04-15",
  "roomNumbers": [
    "111"
  ]
}


Update Out of Order Status

Updates Out of Order (OOO) status of the room based on the room number.

Sample Request

[POST] /sph/rooms/ooo/status

{
  "startDate": "2020-04-14",
  "endDate": "2020-04-15",
  "reasonCode": "REASON_CODE",
  "note": "Reason Message",
  "roomNumbers": [
    "111"
  ]
}


Release Out of Order Status

Releases Out of Order (OOO) status of the room for the specified dates.

Sample Request

[POST] /sph/rooms/ooo/status/release

{
  "startDate": "2020-04-14",
  "endDate": "2020-04-15",
  "roomNumbers": [
    "111"
  ]
}