v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Connection

GetSubProperties

Some OTAs only tie one property to a specific login username/password where the username is also the ota_property_id. Others allow for one username/password to be associated with multiple properties. In this second case, each OTA property identifier is stored as an ota_property_sub_id in order to be handled separately from the property's OTA username. This method call should return all of the properties (ota_property_sub_ids) associated with the OTA's username/password so that the correct ota_property_sub_id can be linked with our mya_property_id for a specific property.

IMPORTANT: Please contact us to enable this feature for your OTA. It is NOT enabled by default. It is only necessary if your OTA allows for multiple properties associated with one login username/password.

Implementation suggestions: ota_property_sub_id will be the OTA identifier for a specific property managed by the hotel while the title is that property's name. This method will allow the property to map their Cloudbeds property with the OTA's ota_property_sub_id when setting up the property-OTA association on Cloudbeds.

post/GetSubProperties

Request body

mya_property_idinteger

Property ID on the Cloudbeds channel manager

ota_property_idstring

Username, login or property ID on the OTA

ota_property_passwordstring

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

ota_property_sub_id''

Always an empty string for this call

guidstring

Request reference ID, used for debugging and support requests.

shared_secretstring

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

ota_cidstring

OTA ID as given by Cloudbeds

verb'GetSubProperties' required

Response

GetSubProperties

OR