Callbacks

CheckAvailability

Endpoint: https://api.myallocator.com/callback/ota/{ota}/v202203 (replace {ota} with your channel ID)

Use this callback to check if a room (rateplan) is available for booking.

Although information about specific room (rateplan) availability is supposed to be present locally on a channel side, we would like to provide an opportunity to double check if a room (rateplan) is available prior to creating a reservation. Using this callback ensures that due to a possible technical issue leading to a room (rateplan) availability numbers not having been (or having been incorrectly / not in time) delivered to a channel, the room is not overbooked and therefore helps avoid both host and guest frustration when such an over-booking has to be canceled by a host due to physical inability to accomodate.

Identify the property with ota_property_sub_id if your OTA supports multiple properties under one login (see GetSubProperties), otherwise with ota_property_id. Exactly one of the two applies to your channel, and sending only the other one is rejected with error 1187.

post/CheckAvailability

Request

  • Base URL
    https://api.myallocator.com/callback/ota/replace_with_ota_id/v202203
  • URL
    https://api.myallocator.com/callback/ota/replace_with_ota_id/v202203/CheckAvailability
  • Auth
    API key in query parameter shared_secret

Request body

ota_property_idstring

Username, login or property ID on the OTA

ota_property_sub_idstring

Property ID on the OTA, if OTA supports multiple properties under one ota_property_id/ota_property_password combination. See GetSubProperties for more details.

ota_room_idstring required

Room ID on the OTA

ota_rateplan_idstring required

Room rateplan ID on the OTA (In case OTA supports rateplans)

start_datestring date required

Desired check in date

end_datestring date required

Desired check out date

unit_type'room' | 'guest' required

Room availability can be checked by number of rooms or by number of guests (beds) to stay. We recommend using guest in case a room is a dormitory/shared room and is sold by beds.

number_of_unitsinteger required

Number of rooms or guests to check availability for

shared_secretstring required

Authentication between the OTA and the channel. Identical for all requests. Not to be shared with customers.

Response

CheckAvailability

OR

Changes

No recorded changes to this operation across all 1 revision of this API.