v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Callbacks

GetARI

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

Not enabled by default. Support for this method is disabled by default and is only enabled upon request. When requesting access, please provide details on why the method is needed and how it will be used.

Not intended for frequent usage. This method must not be called at a high frequency, and in particular must not be wired to customer-exposed UI (e.g. called on page load or user interaction). Use ARIUpdate push notifications to stay in sync; treat GetARI as an occasional reconciliation tool.

Retrieve the current ARI (availability, rates, restrictions) for one or more rooms over a given date range. Each Inventory row in the response has the same shape as the rows Cloudbeds sends via ARIUpdate, so an OTA can reuse the same inventory-row processor.

A requested room with no enabled channel mapping is omitted from room_ari and reported under warnings. Likewise, a resolved property that is not available for the channel is skipped and reported under warnings; if no resolved property is available, the request fails with an error.

post/GetARI

Request body

shared_secretstring required

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

ota_property_idstring required

Username, login or property ID on the OTA

roomsobject required

Object keyed by ota_room_id. Each value is the date range for which ARI should be returned for that room. end_date is inclusive.

Response

GetARI