Skip to main content

SynXis Property Hub - Reservation

Hotel
Search
REST API
Hospitality
Try Now

What is it?

This API allows the user to manage the reservations present in a hotel and retrieve applicable details, like room requests or available rooms.

Why use it?

This API can be used to retrieve reservations in a hotel and room details as well as to perform pre-check in and checkout.

How it works

This set of APIs allows to perform the following operations related to hotel reservations:

  • Retrieve a list of reservations.
  • Retrieve all room requests for a given room.
  • Pre-check in the reservation.
  • Check out the reservation.
  • Update the room number of the reservation.
  • Retrieve a list of available rooms for the reservation.

How to use

Retrieve List of Reservations

Returns a list of reservations with applicable details for a given hotel.

Sample Request

[POST] /reservations/outbound/data/reservations-details

{
  "client": "CLIENT",
  "hotelId": 12345,
  "chainId": 12345678,
  "startDateTime": "2019-08-28T17:50:00Z",
  "endDateTime": "2019-08-28T18:00:00Z",
  "delta": false,
  "updateDelta": false
}

Sample Response

{
  "currencyCode": "USD",
  "nextDeltaStartTime": "2019-08-31 15:05:46",
  "status": "SUCCESS",
  "reservations": [
    {
      "chainId": 12345,
      "hotelId": 12345,
      "propertyName": "My Hotel",
      "confirmationNumber": "12345SB1234",
      "itineraryNumber": 12345678910,
      "rezSource": "PMS",
      "status": "Confirmed",
      "statusCode": "R",
      "onPropertyStatus": "None",
      "roomTypeCode": "N2Q",
      "roomType": "2 Queen Beds",
      "rateTypeCode": "FEDERAL RATE - GOV",
      "rateType": "FEDERAL RATE - GOVERNMENT",
      "nightCount": 1,
      "roomCount": 1,
      "adultCount": 1,
      "childCount": 0,
      "cancelReason": null,
      "cancelReasonCode": null,
      "cancelComment": null,
      "bookingDate": "2019-08-31 15:05:46",
      "updatedDate": "2019-08-31 15:06:12",
      "lastUpdatedDate": "2019-09-04 07:52:21",
      "cancelDate": null,
      "marketSource": "GDS",
      "marketSegment": "GOV",
      "arrivalDate": "2019-09-04 00:00:00",
      "departureDate": "2019-09-05 00:00:00",
      "packageCode": null,
      "groupId": null,
      "groupName": null,
      "companyName": null,
      "travelAgencyName": null,
      "loyaltyNumber": null,
      "guests": [
        {
          "profileId": "11111ba-f7f4-4060-b10c-c0f83b124bee",
          "profileSource": "UNIQUEID",
          "firstName": "First",
          "lastName": "Last",
          "primary": true,
          "addresses": [
            {
              "type": 1,
              "line1": "Sample address",
              "line2": null,
              "line3": null,
              "city": "New York",
              "state": "NY",
              "country": "US",
              "zip": "10001",
              "primary": true
            }
          ],
          "emails": [
            {
              "type": 1,
              "email": "sample@gmail.com",
              "primary": true
            }
          ],
          "phones": [
            {
              "type": 1,
              "countryCode": null,
              "phone": "12345678",
              "extension": null,
              "primary": true
            }
          ]
        }
      ],
      "stayDates": [
        {
          "date": null,
          "rateCode": null,
          "rate": null,
          "roomUnit": null,
          "amount": null,
          "tax": null,
          "fee": null,
          "amountWithTaxAndFees": null
        }
      ],
      "totalAmount": "94.0",
      "totalFees": "0.0",
      "totalAmountWithTaxesAndFees": 104.46
    }
  ],
  "total": 3
}

Retrieve All Room Requests

Returns all room requests for a given room number for arrivals and stayovers.

Note: Available room requests are selected by the guest at the time of booking.

Sample Request

[POST] /reservations/room-request

Room Numbers

[
  "1001"
]

Sample Response

{
  "data": {
    "additionalProp1": [
      {
        "confirmationNumber": "9187XT0000122",
        "status": "Confirmed",
        "onPropertyStatus": "InHouse",
        "roomRequest": [
          {
            "code": 50002,
            "description": "Air conditioning (RMA 2)"
          }
        ]
      }
    ],
    "additionalProp2": [
      {
        "confirmationNumber": "9187XT0000122",
        "status": "Confirmed",
        "onPropertyStatus": "InHouse",
        "roomRequest": [
          {
            "code": 50002,
            "description": "Air conditioning (RMA 2)"
          }
        ]
      }
    ],
    "additionalProp3": [
      {
        "confirmationNumber": "9187XT0000122",
        "status": "Confirmed",
        "onPropertyStatus": "InHouse",
        "roomRequest": [
          {
            "code": 50002,
            "description": "Air conditioning (RMA 2)"
          }
        ]
      }
    ]
  }
}

Pre-Check In Reservation

Allows to make the reservation ready for check-in.

[PUT] /reservations/{confirmationNumber}/check-in

where {confirmationNumber} is the Reservation Confirmation Number to pre-check in.

Note: Pre-check in is only allowed on check-in date and if the reservation is guaranteed by credit card or direct bill. Otherwise, an error message is returned.

Sample Response

{
  "data": {
    "success": true
  }
}

Check Out Reservation

Allows the reservation check out.

[PUT] /reservations/{confirmationNumber}/check-out

where {confirmationNumber} is the Reservation Confirmation Number to check out.

Note: Check out is only allowed on check-out date and if the reservation is guaranteed by credit card or direct bill. Otherwise, an error message is returned.

Sample Response

{
  "data": {
    "checkOutSuccess": true,
    "interfaceCheckOutMessageStatus": true
  }
}

Update Reservation Room Number

Updates the room number of the reservation.

[PUT] /reservations/{confirmationNumber}/room

where {confirmationNumber} is the Reservation Confirmation Number for which the room number needs to be updated.

Sample Response

{
  "data": {
    "success": true
  }
}

Retrieve Available Rooms For Reservation

Returns a list of all available rooms for the reservation.

[GET] /reservations/{confirmationNumber}/rooms/available

where {confirmationNumber} is the Reservation Confirmation Number for which to retrieve available rooms.

Sample Response

{
  "data": {
    "availableRooms": [
      {
        "roomNumber": 1001,
        "smoking": true,
        "handicap": true
      }
    ]
  }
}