---
title: "GetARI"
method: POST
path: "/GetARI"
tags: ["Callbacks"]
---

# GetARI

`POST /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.

## Request body

- object
  - `shared_secret` string, required — Authentication between the OTA and the channel. Identical for all requests. Not to be shared with customers.
  - `ota_property_id` string, required — Username, login or property ID on the OTA
  - `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 `200`

GetARI

- union
  - object
    - `Success` true, required — Always `true` on success.
    - `currency` string — 3-letter ISO 4217 currency code. This is the currency the property has set for the channel connection, and may differ from the property's native currency.
    - `room_ari` object, required — ARI data grouped by `ota_room_id`. Each value is an array of inventory rows. Each row has the same shape as rows sent via `ARIUpdate`.
    - `warnings` object[] — Non-fatal warnings for requested rooms or resolved properties that could not be served. Present only when at least one warning was produced.
      - `ota_room_id` string — Present on room-level warnings (`WARNING.ROOMS.UNMAPPED.SKIPPED`).
      - `property_id` integer — Cloudbeds property ID. Present on property-level warnings (`WARNING.PROPERTY.SKIPPED`).
      - `id` string, required — Warning identifier (`WARNING.ROOMS.UNMAPPED.SKIPPED`, `WARNING.PROPERTY.SKIPPED`).
      - `message` string — Human-readable warning text.
  - ResponseCallbackError
    - `Success` false, required — Always `false` when the response contains an error.
    - `ErrorCode` integer, required — Error code. Check the "Error Codes" section of the specification for valid codes.
    - `Error` string, required — Human-readable error message.

---

[API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/revisions/2faa857793e8/schema)