GetBusinesses()

Request

Endpoint   

https://www.availabilityexchange.com/gateway/getbusinesses
Parameters
    business_id (Comma separated 64-bit integer list - optional) - if specified, only the information for the provided business_ids will be provided in the response

Request Example

>curl --user username:accesskey "https://www.availabilityexchange.com/gateway/getbusinesses"

Response

response_errors (See Response Errors)
businesses (list of objects)
    business_id (64-bit integer)
        the unique identifier for the business
    name (string)
        the business name
    address (string)
        the business physical address
    address_street1 (string)
        line one of the business street address
    address_street2 (string)
        line two of the business street address
    address_city (string)
        the city of the business address
    address_state (string)
        the state of the business address
    address_country_id (int)
        the internal country id of the business address.  This is provided for informational purposes.  '236' is the United States

    latitude (decimal)

        the latitude of the business

    longitude (decimal)

        the longitude of the business
    phone (string)*
        the business main phone number
    email (string)*
        the business main email address

    website (string)

        the business website
    currency (string)
        the 3-letter currency code (i.e. "USD")
    accepting_reservations (boolean)
        this field indicates whether or not the property is accepting reservations directly through AE gateway.  If it is false, use GetBookingLink() to get a link to the property's reservation software to make a reservation

    children_allowed (boolean)

        true if children are allowed as guests at the property
   rate_adjustment (string)**
        the amount or percentage that the property increases or decreases rates by globally for your channel
   industry_flags (CSV list of ENUM values)
        this field is a list of different types that apply to the property.  Consider these values when making reservations.  You would not want to try to reserve a campsite at a bed and breakfast. Possible values are as follows:

    NONE,

    BED_AND_BREAKFAST,

    HOTEL,

    RESORT,

    VACATION_HOME,

    APARTMENT,

    RV_AND_CAMPGROUND,

    RESTAURANT,

    WINERY,

    SHOPPING,

    ASSOCIATION

*This field is only populated if the property has specifically accepted your business. Properties that have selected 'share all' will return an empty string here.
**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

{

  "businesses": [

  {

  "business_id": 16609,

  "name": "Developer Hotel Sample",

  "address": "500 Main Street Orem, UT 84057",

  "address_street1": "500 Main Street",

  "address_street2": "",

  "address_city": "Orem",

  "address_state": "UT",

  "address_post_code": "84057",

  "address_country_id": "236",

  "latitude": 40.0441589355469,

  "longitude": -111.73225402832,

  "phone": "234-555-8868",

  "email": "info@availabilityexchange.com",

  "currency": "USD",

  "accepting_reservations": true,

  "children_allowed": true,

  "months_in_advance": 120,

  "rate_adjustment": "0.00%",

  "industry_flags": "HOTEL"

  }

  ],

  "response_errors": []

}

Response Errors

400

    business_id should be a long or a comma-separated list of longs

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/getbusinesses"

Authorization Failed