GetReservation()

Request

End Point 

https://www.availabilityexchange.com/gateway/getreservation
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://www.availabilityexchange.com/gateway/getreservation?business_id=16609

Response

response_errors (See Response Errors)

business_id (64-bit integer)

    the unique identifier for this business

reservations (list of objects)

    Reservation Object:

        unit_group_id (32-bit integer)

            the unique identifier for the unit group.

        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 (date YYYY-MM-dd)

            the date the reservation was booked.

        total_nights (32-bit integer)

            the total number of nights on the reservation.

        grand_total (decimal)

            the total amount charged for the reservation.

        group_cost (decimal)

            the total amount charged for the units in the unit group*.

        total_fees (decimal)

            the total amount of fees charged for the reservation**.

        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.

*For reservations that book across multiple unit groups, there will be multiple reservation objects with the same reservation_id and grand_total, with the individual group cost split out (this is uncommon).

**For reservations that book across multiple unit groups, the costs associated with other unit groups will appear as fees. For example, if a reservation has both unit group 1123 and unit group 3321 and charged $75 to 1123 and $25 to 3321 with no other fees or taxes, there will be 2 reservation entries. The grand_total will be $100 on both, with unit group 1123 showing a unit_cost of $75 with $25 in total_fees and group 3321 showing a unit_cost of $25 with $75 in total_fees (this is uncommon).

Response Example

{

  "business_id": 16609,

  "reservations": [

    {

      "unit_group_id": 18128,

      "reservation_id": 238495,

      "start_date": "2022-08-07",

      "end_date": "2022-08-12",

      "reserved_on": "2021-07-20",

      "total_nights": 6,

      "grand_total": 956.0000,

      "group_cost": 780.0000,

      "total_fees": 160.0000,

      "total_taxes": 16.0000,

      "status": "Reserved"

    },

    {

      "unit_group_id": 18128, 

      "reservation_id": 250994,

      "start_date": "2022-07-15",

      "end_date": "2022-07-15",

      "reserved_on": "2022-07-08",

      "total_nights": 1,

      "grand_total": 137.5000,

      "group_cost": 137.5000,

      "total_fees": 0.0000,

      "total_taxes": 0.0000,

      "status": "Reserved"

    },

         . . .

  ],

  "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://www.availabilityexchange.com/gateway/getreservation?business_id=16609&reserved_after=2024-10-15&reserved_before=2024-10-05

{

  "business_id": 0,

  "reservations": null,

  "response_errors": [

    "The reserved after date is after the reserved before date"

  ]

}