v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

ARI

ARIUpdate

This call is used to send availability, rates and restrictions to your OTA. We will combine the updates into as few date ranges as possible, and we split bigger updates into several API requests. We also cache data and will not send ARI updates if the ARI data has not changed within a certain timeframe. You can ask us to alter the number of Inventory objects we send per request. It's also possible to ask us to restrict maximum number of days per date range.

Note that Cloudbeds only supports availability on the room level, so for the same ota_room_id and the same date range the availability will always be the same. Only restrictions and rates are sent on the rate plan level.

post/ARIUpdate

Request body

mya_property_idinteger required

Property ID on the Cloudbeds channel manager

ota_property_idstring required

Username, login or property ID on the OTA

ota_property_passwordstring required

Password for property on your OTA. In case the OTA does not use passwords this will be an empty string.

ota_property_sub_idstring required

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

guidstring required

Request reference ID, used for debugging and support requests.

shared_secretstring required

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

ota_cidstring required

OTA ID as given by Cloudbeds

verb'ARIUpdate' required

currencystring required

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. The OTA can use this field to assert that rates are sent in the correct currency.

Response

ARIUpdate

successtrue | false required