CLcloudbeds
Bookings

AckBooking

Allows Cloudbeds to acknowledge a booking on your OTA from the Cloudbeds side.

IMPORTANT: Please contact us to enable this capability for your channel. It is NOT enabled by default.

One AckBooking is sent per booking, after the booking has been imported and handed to the property's PMS. Bookings are not acknowledged in the order they were delivered — cancellations are processed ahead of new and modified bookings — so do not infer any ordering from the sequence of calls. Use acknowledgement_id or version to identify which delivery is being acknowledged:

  • For bookings you pushed to us with the BookingCreate callback, we return acknowledgement_id, one of the acknowledgement_ids we returned in that callback's response.
  • For bookings we pulled with GetBookingList, we return version, the value you supplied for that booking in the GetBookingList response.

A booking that is delivered again — a modification, or a redelivery after a failed import — is acknowledged again, with the identifier belonging to that delivery.

If the booking cannot be acknowledged the error code should be provided. Here are possible error codes:

  • 4004 - booking cannot be acknowledged. The reason is provided in the msg field.
post/AckBooking

Request

  • Base URL
    https://api.your-ota.com/cloudbeds
  • URL
    https://api.your-ota.com/cloudbeds/AckBooking
  • Auth
    API key in query parameter shared_secret

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'AckBooking' required
booking_idstring required

OTA booking ID of the booking to be acknowledged.

acknowledgement_idinteger

Identifies which BookingCreate delivery is being acknowledged. One of the acknowledgement_ids returned in the response to that callback. Only present for bookings delivered through BookingCreate; omitted for bookings we retrieved with GetBookingList.

versionstring nullable

The version you returned for this booking in the GetBookingList response, passed back unchanged. null if you did not supply one, or if the booking reached us through the BookingCreate callback rather than being pulled.

myallocator_idstring nullable

Cloudbeds' own booking ID for the imported booking. null when the booking was acknowledged without being imported — for example a booking whose departure date has already passed, which is acknowledged so that it is not delivered again.

Response

AckBooking

successtrue | false required

Changes

No recorded changes to this operation across all 1 revision of this API.