GET ALL AVAILABILITY

GetAllAvailability()

GetAllAvailability() returns the availability and rates for all units/groups for a date range and number of adults.  This is useful for finding the prices for available stays.


If the business has groups configured, then the results will be per group ('groups').  Otherwise the results will be per unit ('units').


Availability is defined as a unit having not being rented, occupied or under repair and that is ready to be rented to guests. 


The start_date, end_date and the dates in between are dates of stay, not the check_in and check_out dates of a possible itinerary.  Use GetQuote() to get availability for an itinerary.


Request

End Point 

https://availabilityexchange.com/gateway/GetAllAvailability
Parameters
    business_id (64-bit integer)
        unique id of the business. 
    start_date (date YYYY-MM-dd)
        the first date requested
    end_date (date YYYY-MM-dd)
        the last date requested
    num_adults (32-bit integer)
        the number of adults for the requested stay

    num_children (32-bit integer)
        the number of children for the requested stay

Request Example

>curl
--user username:passkey
--url  https://www.availabilityexchange.com/gateway/getallavailability?business_id=16609&start_date=2023-09-20&end_date=2023-09-22&num_adults=2

Response (Groups)

response_errors (See Response Errors)
unit_group_id (32-bit integer)
    the unique identifier for the group. 
unit_group_name (string)
    name of the group
number_of_units_available (32-bit integer)
    number of units within the group that are available for the given date range. 
business_id (64-bit integer)
    the business
start_date (date YYYY-MM-dd)
    the first date returned
end_date (date YYYY-MM-dd)
    the last date returned
num_adults (32-bit integer)
    the number of adults for the requested stay

num_children (32-bit integer)
    the number of children for the requested stay
rate (decimal)
    sum of each day's rate.  Zero if there is no availability.  This does not include taxes and fees.

taxes (decimal)

    the taxes to be applied to the rate for the given stay

fees (decimal)

    the fees which will be applied to the stay including any applicable taxes.

amountCharged (decimal)

    the estimated deposit amount that will be charged at the time of booking

rate_for_date_list (list of objects)

    One or more date-rate objects, detailing the rate calculated for each date in the itinerary

date-rate object:

    Rate (decimal)

        The rate for the specified date

    ResDate (Date YYYY-MM-dd)

        The date that this rate applies

Response (Groups) Example

{

  "groups": [

  {

  "unit_group_id": 23611,

  "unit_group_name": "AE Double King Suites",

  "number_of_units_available": 4,

  "business_id": 16609,

  "start_date": "2024-02-10",

  "end_date": "2024-02-14",

  "num_adults": 3,

  "num_children": 1,

  "rate": 645.0000,

  "taxes": 111.26,

  "fees": 50.80,

  "amountCharged": 322.5000000000,

  "rate_for_date_list": [

  {

  "ResDate": "2024-02-10",

  "Rate": 135.0000

  },

  {

  "ResDate": "2024-02-11",

  "Rate": 135.0000

  },

  {

  "ResDate": "2024-02-12",

  "Rate": 125.0000

  },

  {

  "ResDate": "2024-02-13",

  "Rate": 125.0000

  },

  {

  "ResDate": "2024-02-14",

  "Rate": 125.0000

  }

  ]

  }

  ],

  "response_errors": []

}


Response (Units)

response_errors (See Response Errors)
unit_id (32-bit integer)
    the unique identifier for the unit.
unit_name (string)
    name of the unit.
unit_is_available (boolean)
    if the unit is available for the date range.
business_id (64-bit integer)
    the business
start_date (date YYYY-MM-dd)
    the first date returned
end_date (date YYYY-MM-dd)
    the last date returned
num_adults (32 -bit integer)
    the number of adults for the requested stay

num_children (32-bit integer)
    the number of children for the requested stay
rate (32-bit float)
    sum of each day's rate.  Zero if there is no availability.  This does not include taxes and fees.

Response (Units) Example

{
    "units": [{
        "unit_id": 27795,
        "unit_name": "FD10 Double Full Room ",
        "unit_is_available": false,
        "business_id": 16609,
        "start_date": "2022-08-14",
        "end_date": "2022-08-17",
        "num_adults": 2,
        "rate": 0.0
    }, {
        "unit_id": 27798,
        "unit_name": "DQ03 Double Queens",
        "unit_is_available": true,
       "business_id": 16609,
       "start_date": "2022-08-14",
       "end_date": "2022-08-17",
       "num_adults": 2,
       "rate": 560.0000
    }]
}

Response Errors

200

  response_errors (list of strings)

  • The start date is after the end date
  • <x> is a test property only. Do not use this data for any  purpose besides testing
  • The query cannot contain dates before today
  • Unit#<y> for Business <x> is unavailable or does not exist

400

  • business_id should be a long
  • unit_id should be an int or a comma-delimited list of ints
  • unit_group_id should be an int or a comma-delimited list of ints
  • dates should be formatted 'YYYY-MM-DD'

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)

503

  Server in maintenance mode

Response Error Example

>curl
--user username:passkey
--url https://www.availabilityexchange.com/gateway/getallavailability?business_id=16609&unit_id=27796&start_date=2021-09-15&end_date=2021-09-01

{
    "unit_id": 27796,
    "capacity": 0,
    "query_start": "2021-09-15",
    "query_end": "2021-09-01",
    "availability": null,
    "response_errors":
    [
        "The start date is after the end date"
    ]
}

Return to API Endpoints