https://wiki.test.visitgroup.com/index.php?action=history&feed=atom&title=Arrivals_APIArrivals API - Revision history2026-10-26T11:02:44ZRevision history for this page on the wikiMediaWiki 1.41.1https://wiki.test.visitgroup.com/index.php?title=Arrivals_API&diff=2226&oldid=prevAdmin at 11:16, 3 October 20252025-10-03T11:16:14Z<p></p>
<p><b>New page</b></p><div>[[Category:Marketplace]]<br />
[[Category:API]]<br />
[[Category:Automation]]<br />
<br />
<div class="heading">Arrivals API</div><br />
This page is about the menu {{#fas:cog}} (SETTINGS) MARKETPLACE > ARRIVALS<br />
<br />
This page explains how to connect to a system which has set up a connection to Beds24 via the Beds24 Arrivals API. <br />
<br />
For Beds24 the normal channel manager fees apply.<br />
<br />
= Capabilities =<br />
The Arrivals integration allows external services to access data about your upcoming arrivals. <br />
Typical services which can use this data are door lock systems, concierge systems and systems which require access to guest data before or during their stay.<br />
<br />
Beds24 will send booking data to the integration partner.<br />
<br />
The integration partner can send info codes back to Beds24 to be stored with individual bookings. <br />
<br />
= Set Up =<br />
<br />
== Beds24 ==<br />
*Copy the "Access Key"<br />
*Set how many days before check-in the bookings should be sent. 0 will only send bookings with check-in today only. 1 will send bookings with check-in today and tomorrow.<br />
*Set if you want to include personal data in in the data transfer. <br />
*Tick "Enable".<br />
<br />
== Integration partner ==<br />
*Forward the "Access key" of each property you wish to connect to the integration partner. They will be able to use the key to access the property.<br />
<br />
For further instructions contact the integration partners support.<br />
<br />
== Common Problems ==<br />
<br />
= Disconnect=<br />
Untick "Enable" to disconnect the room and stop sending it's bookings.<br />
<br />
= Developers =<br />
This API will allow you to read upcoming bookings for a property and to write or modify Booking Info Items in those bookings.<br />
<br />
For example, a door access system could read details of upcoming bookings and store a door unlock code in each booking so the code can be communicated to the guest.<br />
<br />
== API setup ==<br />
<br />
Contact Beds24 for a merchant Key for the Arrivals API<br />
<br />
Each property can generate an access Key at the menu {{#fas:cog}} (SETTINGS) MARKETPLACE > Arrivals "Access Key'<br />
<br />
With the merchant key and the access key the following functions can be called on the property.<br />
<br />
Only data from room types that have their synchronise tick box enabled will be included.<br />
<br />
== Get Bookings ==<br />
<br />
https://api.beds24.com/arrivals/getBookings<br />
<br />
This function will return all upcoming arrivals in the property as a JSON array.<br />
<br />
The number of days in advance of check-in date that bookings are available is set at the menu {{#fas:cog}} (SETTINGS) MARKETPLACE > Arrivals "Days in Advance''' <br />
<br />
Personal information like name, email etc. can be included in the data at the menu {{#fas:cog}} (SETTINGS) MARKETPLACE > Arrivals "Allow Personal Info''' <br />
<br />
This function is suitable to call once per hour per property.<br />
<br />
== Set Booking ==<br />
<br />
https://api.beds24.com/arrivals/setBooking<br />
<br />
This function can write Booking Info Items into a booking.<br />
<br />
If the booking info item already exists it will be modified.<br />
<br />
Booking Info Items can be used for reporting and for triggering auto actions to perform further operations like sending email.<br />
<br />
The room note and status can be set on the room containing the booking<br />
<br />
== Commercial ==<br />
<br />
We can list your integration and product at https://shop.beds24.com<br />
<br />
Contact us for details.</div>Admin