GetQuote()

Request

Endpoint     

https://www.availabilityexchange.com/gateway/getquote
Parameters
    business_id (64-bit integer) 
       the property's unique id
    unit_id (32-bit integer)
        the unit's unique id
    unit_group_id (32-bit integer)
        the unit group's unique id.  Exactly one of unit_id and unit_group_id must be specified
    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

Request Example

>curl --user username:accesskey

"https://local.availabilityexchange.com/apiaccess/gateway/getquote?business_id=16609&unit_group_id=23611&check_in=2024-02-10&check_out=2024-02-15&num_adults=3&num_children=1"

Response

response_errors (See Response Errors)
pricing type (string)
    the type of quote generated
rate_adjustment (string)*

    the amount or percentage that the property increases or decreases rates by globally for your channel
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

taxes (decimal)
    the taxes to be applied to the base_rate
fees (decimal)

    the fees of the quoted itinerary including any applicable taxes
unit_id (64-bit integer)

    the unit id of the unit quoted. Exactly one of unit_id and unit_group_id should be included, depending on how the quote was requested

unit_group_id (64-bit integer)

    the unit group id of the unit quoted.  Exactly one of unit_id and unit_group_id should be included, depending on how the quote was requested

booking_link (string)

    a direct link to the property's PMS for this quote.  This is for comparison only.  Partners should use the AddReservation() endpoint

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)

    number of adults included in the quoted itinerary

num_children (32-bit integer)

    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

Response Example

{

  "pricing_type": "FromAEGateway",

  "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

401
    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 aBadUserName:SomePasskey "https://www.availabilityexchange/gateway/getquote"

Authorization Failed