GetLowestRate()

Request

End Point

https://www.availabilityexchange.com/gateway/getlowestrate
Parameters
    business_id (64-bit integer)
        The property's unique id
    check_in (Date YYYY-MM-dd)
        The check in date of the requested itinerary
    check_out (Date YYYY-MM-dd)
        The check out date of the requested itinerary
    num_adults (32-bit integer - optional)
        The number of adults for the requested itinerary. If not specified, double occupancy (2) will be assumed

    num_children (32-bit integer - optional)
        The number of children for the requested itinerary. If not specified, no children (0) will be assumed

    taxes (decimal)

        The taxes to be applied to the base_rate

    fees (decimal)

        The fees of the quoted itinerary including any applicable taxes

Request Example

>curl --user username:passkey
--url "https://www.availabilityexchange.com/gateway/getlowestrate?business_id=16609&check_in=2023-04-01&check_out=2023-04-04&num_adults=2"

Response

response_errors (See Response Errors)
pricing_type (ENUM)
    The type of quote generated
check_in (Date YYYY-MM-dd)
    The check in date for the quote
check_out (Date YYYY-MM-dd)
    The check out date for the quote
available (char)
    "Y" if the quote is available, "N" otherwise
rate_adjustment (string)*
    The amount or percentage that the property increases or decreases rates by globally for your channel.
base_rate (decimal)
    The total nightly rate of the quoted itinerary not including taxes or fees
taxes (decimal)
    The taxes of the quoted itinerary
fees (decimal)
    The fees of the quoted itinerary
amountCharged (decimal)
    The estimated amount the guest will be charged at the time of booking the reservation
unit_group_id (64-bit integer)
    The unit group id of the unit quoted
booking_link (string)**
    A direct link to the property's booking engine for this quote.
currency (string)
    The three letter currency code for the currency used to generate the quote (i.e. "USD")
occupancy (32-bit integer)
    The number of guests the quote was generated for

num_adults (32-bit integer)
    The number of adults included in the quoted itinerary

num_children (32-bit integer)
    The number of children included in the quoted itinerary
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

*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.

**This is for comparison only. Partners should use the AddReservation() endpoint

Response Example

{

  "pricing_type": "LowestForItinerary",

  "rate_adjustment": "0.00%",

  "check_in": "2024-02-10",

  "check_out": "2024-02-15",

  "available": "Y",

  "base_rate": 645.0000,

  "taxes": 111.26,

  "fees": 50.80,

  "amountCharged": 322.5000000000,

  "unit_group_id": 23611,

  "booking_link": "https://resnexus.com/resnexus/reservations/book/4004829C-51BA-4527-8472-F2AB6AD1A9BD?startdate=2%2f10%2f2024&nights=5&channelid=31&aeunit=ESoLg0KOypWK2Ow5Uf3x&aeunitmaster=j9BDh8HUPWRJAwn2cRfE&adults=3&capacity2=1",

  "currency": "USD",

  "occupancy": 4,

  "num_adults": 3,

  "num_children": 1,

  "rate_for_date_list": [

    {

      "Rate": 135.0000,

      "ResDate": "2024-02-10"

    },

    {

      "Rate": 135.0000,

      "ResDate": "2024-02-11"

    },

    {

      "Rate": 125.0000,

      "ResDate": "2024-02-12"

    },

    {

      "Rate": 125.0000,

      "ResDate": "2024-02-13"

    },

    {

      "Rate": 125.0000,

      "ResDate": "2024-02-14"

    }

  ],

  "response_errors": []

}

Response Errors

200

    response_errors(list of strings)

400

•  business_id should be a long
•  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:passkey
--url "https://www.availabilityexchange.com/gateway/gateway/getlowestrate?business_id=4089&check_in=202A-10-25&check_out=2021-10-28"

{
    dates should be formatted 'YYYY-MM-dd'
}