GET RESERVATION DETAILS
Important: This endpoint is only accessible to Revenue Manager Connections. OTA connection types cannot access this endpoint
GetReservationDetails()
For Revenue Management partners, GetReservationDetails() returns detailed information about reservations for a given business. The request can be filtered by unit group, reservation start and end dates, reservation booking dates, reservation last updates, and reservation status. This endpoint will ultimately replace the GetReservation endpoint as it contains more useful reservation information in a simpler to digest manner.
This endpoint returns reservations with a $0 value as well as reservations that have package discounts applied. These package discount reservations were not included in the deprecated GetReservation endpoint.
Request
End Point
https://www.availabilityexchange.com/gateway/getreservationdetails
Parameters
business_id
(64-bit integer) *Required
unique id of the business.
unit_group_id
(32-bit integer)
optional. Filter based on unit group. More than one id can be specified as a comma separated list.
reservation_start_date
(date YYYY-MM-dd)
optional. Filter based on the start date of the reservation.
reservation_end_date
(date YYYY-MM-dd)
optional. Filter based on the end date of the reservation. (This is the final night of the stay, not the check out day)
reserved_after
(date YYYY-MM-dd)
optional. Filter for reservations made after the specified date.
reserved_before
(date YYYY-MM-dd)
optional. Filter for reservations made before the specified date.
modified_after
(date YYYY-MM-dd)
optional. Filter for reservations modified after the specified date.
status
(string)
optional. Filter for reservations based on current status. Valid options are: Reserved, Cancelled, or Blocked. (NOTE: currently case sensitive)
Request Example
>curl
--user username:passkey
--url https://availabilityexchange.com/gateway/GetReservationDetails?business_id=16609&reserved_after=2025-01-01&reserved_before=2025-03-01
Response
response_errors (See Response Errors)
business_id (64-bit integer)
the unique identifier for this business
reservations (list of objects)
Reservation Object:
reservation_id (32-bit integer)
the unique identifier for the reservation in the property's reservation system.
start_date (date YYYY-MM-dd)
the first night of the reservation
end_date (date YYYY-MM-dd)
the last night of the reservation (this is not the check-out date)
reserved_on (datetime YYYY-MM-ddTHH:mm:ss.fffZ)
the date and time the reservation was booked.
total_room_nights (32-bit integer)
the total number of room nights on the reservation.
grand_total (decimal)
the total amount charged for the reservation.
other_charges (decimal)
the total non-unit related charges on the reservation (fees, add-ons, misc charges).
total_taxes (decimal)
the total amount of taxes charged for the reservation.
status (string)
the status of the reservation. Will be one of three possible values: Reserved, Cancelled, or Blocked.
stays (list of objects)
Stay Object:
unit_group_id (32-bit integer)
the unique identifier for the unit group.
room_nights (list of objects)
Room Night Object:
unit_id (32-bit integer)
the unique identifier for the unit.
night (date YYYY-MM-dd)
the date of the stay.
rate (decimal)
the rate charged for the unit for the night.
Response Example
{
"business_id": 16609,
"reservations": [
{
"reservation_id": 273911,
"start_date": "2025-01-14",
"end_date": "2025-01-14",
"reserved_on": "2025-01-13T13:17:52.337-07:00",
"total_room_nights": 1,
"grand_total": 222.8700,
"other_charges": 101.6700,
"total_taxes": 20.2000,
"status": "Reserved",
"stays": [
{
"unit_group_id": 33522,
"room_nights": [
{
"unit_id": 27795,
"night": "2025-01-14",
"rate": 101.0000
}
]
}
]
},
{
"reservation_id": 273918,
"start_date": "2025-01-20",
"end_date": "2025-01-22",
"reserved_on": "2025-01-15T13:09:59.147-07:00",
"total_room_nights": 3,
"grand_total": 3483.3900,
"other_charges": 491.7000,
"total_taxes": 0.0000,
"status": "Reserved",
"stays": [
{
"unit_group_id": 33532,
"room_nights": [
{
"unit_id": 27806,
"night": "2025-01-20",
"rate": 995.1300
},
{
"unit_id": 27806,
"night": "2025-01-21",
"rate": 999.6300
},
{
"unit_id": 27806,
"night": "2025-01-22",
"rate": 996.9300
}
]
}
]
},
...
],
"response_errors": []
}
Response Errors
200
response_errors (list of strings)
- The reservation start date is after the end date
- The reserved after date is after the reserved before date
- Status should be one of the following values: Reserved, Blocked, Cancelled
- Group does not exist or is not enabled: <x>
401
- This site requires a secure connection over HTTPS
- The credentials supplied are incorrect or you do not have access to this resource
500
Something went wrong (Internal Server Error)
B
Server in maintenance mode
Response Error Example
>curl
--user username:passkey
--url https://availabilityexchange.com/gateway/GetReservationDetails?business_id=16609&reserved_after=2026-07-01&reserved_before=2025-03-01
{
"business_id": 0,
"reservations": null,
"response_errors": [
"The reserved after date is after the reserved before date"
]
}