v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

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.

post/CheckAvailability

Request body

ota_property_idstring required

Username, login or property ID on the OTA

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