SynXis Property Hub - Reservation

How to use

This section covers the endpoints for this API and examples of how to use them.

GET all available rooms for a reservation

This endpoint enables you to retrieve a list of all available rooms for the reservation (confirmationNumber) that you specify.

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

Header Parameters

The following table describes the parameters to include in the header of your put request:

Path Parameters

The following table describes the elements that you must include for this operation:

Response in JSON

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

Response Elements

The following table explains the elements you receive in the response:

⇧ Back to top

POST hotel details to retrieve a list of reservations

This endpoint enables you to post details about a hotel and its reservations so that you receive a list of reservations that match those details.

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

Header Parameters

The following table describes the parameters to include in the header of your put request:

Post Body Parameters

The following table describes the parameters to include in your post request:

Post Body Example

The following is an example of the body for this post request:

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

Response in JSON

{
  "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
}

Response Elements

The following table explains the elements you receive in the response:

⇧ Back to top

POST a list of rooms to retrieve their room requests

This endpoint enables you to post details about a hotel and to specify a room number so that you receive a list of room requests for that room.

[POST] v1/sph/reservations/room-request

Header Parameters

The following table describes the parameters to include in the header of your put request:

Post Body Parameters

The following table describes the parameters to include in your post request:

Post Body Example

The following is an example of the body for this post request:

[
  "1001"
]

Response in JSON

{
  "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)"
          }
        ]
      }
    ]
  }
}

Response Elements

The following table explains the elements you receive in the response:

⇧ Back to top

PUT an update to a reservation for pre-check-in

This endpoint enables you to perform pre-check-in, which makes a reservation ready for check-in.

Note: Pre-check-in is allowed only on the check-in date and only if the reservation is guaranteed by credit card or direct bill. If you try to perform pre-check-in on reservations that do not meet these criteria, an error message is returned.

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

Header Parameters

The following table describes the parameters to include in the header of your put request:

Path Parameters

The following table describes the elements that you must include for this operation:

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Response in JSON

{
  "data": {
    "success": true,
    "confirmationNumber": "12345SB1234",
    "estimatedArrival": "2025-11-02T12:30:00.000Z",
    "estimatedDeparture": "2025-11-05T12:30:00.000Z"
  }
}

Response Elements

The following table explains the elements you receive in the response:

⇧ Back to top

PUT an update to a reservation for check-out

This endpoint enables you to perform check-out, which makes a reservation ready for check-out.

Note: Check-out is allowed only on the check-out date and only if the reservation is guaranteed by credit card or direct bill. If you try to perform check-out on reservations that do not meet these criteria, an error message is returned.

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

Header Parameters

The following table describes the parameters to include in the header of your put request:

Path Parameters

The following table describes the elements that you must include for this operation:

Response in JSON

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

Response Elements

The following table explains the elements you receive in the response:

⇧ Back to top

PUT an update to a room number for a reservation

This endpoint enables you to update the room number for a reservation.

[PUT] v1/sph/reservations/{confirmationNumber}/room

Header Parameters

The following table describes the parameters to include in the header of your put request:

Path Parameters

The following table describes the elements that you must include for this operation:

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Response in JSON

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

Response Elements

The following table explains the elements you receive in the response:

⇧ Back to top

PUT an update to arrival or departure time for a reservation

This endpoint enables you to update the estimated arrival time and estimated departure time for a reservation.

Note: You can update estimated arrival time only for valid reservations that have not yet been checked-in. You can update estimated departure time only for valid reservations that have not yet been checked-out.

[PUT] v1/sph/reservations/{confirmationNumber}/estimated-arrival-departure

Header Parameters

The following table describes the parameters to include in the header of your put request:

Path Parameters

The following table describes the elements that you must include for this operation:

Put Body Parameters

The following table describes the parameters to include in your put request:

Put Body Example

The following is an example of the body for this post request:

{
  "estimatedArrivalDateTime": "2025-11-02T12:30:00Z",
  "estimatedDepartureDateTime": "2025-11-03T14:30:00Z"
}

Response in JSON

{
  "data": {
    "success": true,
    "estimatedArrival": "2025-11-02T12:30:00.000Z",
    "estimatedDeparture": "2025-11-03T12:30:00.000Z"
  }
}

Response Elements

The following table explains the elements you receive in the response:

Note: This endpoint provides multiple specific error responses to help you understand the reasons for an error. See the Reference Documentation tab for full details about the error responses.

⇧ Back to top