Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Bookings

GetBookingList

Returns a list of bookings/reservations which have not been previously downloaded or have been modified.

The pull interval can be freely set. For channels that do not support the CreateBooking callback the interval is usually set to pull bookings every 5 minutes. If CreateBooking is supported then the GetBookingList will be used as a fallback every 30 minutes.

The OTA can also send Cloudbeds a NotifyBooking callback to inform about new bookings available to be polled.

post/GetBookingList

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'GetBookingList' required
{"stackTrail":"paths:/GetBookingList:post:requestBody:content:application/json:schema:allOf:properties:ota_booking_version","oasType":"schema","type":"unknown","description":"With each request we send along `ota_booking_version`, which\nhas the format `YYYY-MM-DD HH:MM:SS` and indicates the time\nin UTC we last successfully requested bookings. It can be\n`null` if no successful response has been received so\nfar. Please use `ota_booking_version` to only return to us\nnew or modified bookings made since then. To ensure that no\nbooking are skipped due to a time-offset between your and\nour servers make sure to always reduce 5 or more minutes\nfrom the time given. Example: we provide 2017-06-22\n12:09:19, then please return all new/modified/cancelled\nbookings since 2017-06-22 12:04:19 (5 minutes before the\ntime sent).\n\nIf `ota_booking_version` is `null` please return all bookings."}

Response

GetBookingList

OR