GetRates()

Request

End Point

https://www.availabilityexchange.com/gateway/getrates
Parameters
business_id (64-bit integer)
    the unique identifier for this business
unit_id (32-bit integer)
    the unique unit id. More than one id can be specified. More than one id can be specified as a comma separated list. At most one of unit_id and unit_group_id can be specified.
unit_group_id (32-bit integer)
    unique id of the unit_group or unit_groups requested. More than one id can be specified as a comma separated list. At most one of unit_id and unit_group_id can be specified.
start_date (date YYYY-MM-dd)
    first date of date range
end_date (date YYYY-MM-dd)
    last date of the date range
num_adults (32-bit integer - optional)
    number of adults the rate includes

num_children (32-bit integer - optional)
    number of children the rate includes

Request Example

>curl --user username:accesskey
--url "https://www.availabilityexchange.com/gateway/getrates?business_id=16609&unit_id=27795&start_date=2023-09-20&end_date=2023-09-22"

Response

response_errors (See Response Errors)

business_id (64-bit integer)

    the unique identifier for this business

rate_adjustment (string)*

    the amount or percentage that the property increases or decreases rates globally for your channel.

children_allowed (boolean)

    true if children are allowed as guests at the property

age_considered_child (32-bit integer)

    a guest is considered a child at this year of age or below

children_included_in_occupancy (boolean)

    if true, children are counted toward the maximum occupancy of the unit

default_rate (decimal) (Deprecated)
    the default nightly rate
query_start (date YYYY-MM-dd)
    the first date these rates apply to
query_end (date YYYY-MM-dd)
    the last date these rates apply to
rates (list of objects)
    list of rate objects

    unit_group_id (32-bit integer)

        unique id of the unit_group
    unit_id (32-bit integer)
        the unique id of the unit
    rate (decimal)
        the nightly rate
    start (date YYYY-MM-dd)
        the first date this rate applies to
    end (date YYYY-MM-dd)
        the last date this rate applies to
    number_of_adults (32-bit integer)
        the base number of adults for this rate
    extra_adult_rate (decimal)
        amount added for each extra adult after number_of_adults

    children_included_in_rate (32-bit integer)

        the number of children for which no additional charge will be added

    extra_child_rate (decimal)

        amount added for each extra child beyond the children_included_in_rate amount

*This field is only available to partners who act as resellers and do not display booking rates directly to guests, and is hidden by default.  Please contact us if you believe you qualify to receive this information

Response Example

{

  "business_id": 16609,

  "rate_adjustment": "0.00%",

  "children_allowed": true,

  "age_considered_child": 12,

  "children_included_in_occupancy": true,

  "rates": [

  {

  "unit_group_id": 23611,

  "default_rate": 0.0,

  "query_start": "2024-02-10",

  "query_end": "2024-02-14",

  "Rates": [

  {

  "unit_group_id": 23611,

  "rate": 135.0000,

  "start": "2024-02-10",

  "end": "2024-02-11",

  "number_of_adults": 3,

  "extra_adult_rate": 10.0000,

  "children_included_in_rate": 1,

  "extra_child_rate": 10.0000

  },

  {

  "unit_group_id": 23611,

  "rate": 125.0000,

  "start": "2024-02-12",

  "end": "2024-02-14",

  "number_of_adults": 3,

  "extra_adult_rate": 10.0000,

  "children_included_in_rate": 1,

  "extra_child_rate": 10.0000

  }

  ]

  }

  ]

}

Response Errors

200

  response_errors (list of strings)

• The start date is after the end date
• 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
• dates should be formatted 'YYYY-MM-DD'
• num_adults should be an int or omitted

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:accesskey
--url "https://www.availabilityexchange.com/gateway/getrates?business_id=16609&unit_id=27795&start_date=2021-09-02&end_date=2021-09-15"

{
    "unit_id": 27795,
    "default_rate": 0.0,
    "query_start": "2021-05-06",
    "query_end": "2021-05-09",
    "Rates": [],
    "response_errors":
    [
        "Unable to pull rates for Property 16609"
    ]
}