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.

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.

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

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

string

Username, login or property ID on the OTA

string

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

rooms
object
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

Language
Credentials
Query
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json