The Beds24 Arrivals API gives external services, such as door lock systems, concierge systems and other systems that need guest data before or during a stay, access to your upcoming arrivals. Beds24 sends booking data to the integration partner, and the partner can store info codes in individual bookings.
What the integration does
- External services can access data about your upcoming arrivals.
- Beds24 sends booking data to the integration partner.
- The integration partner can send info codes back to Beds24, which are stored with individual bookings.
Connect an Arrivals API partner
For Beds24, the normal channel manager fees apply.
In Beds24
- Go to Settings > Marketplace > Arrivals.
- Copy the Access Key.
- Set how many days before check-in the bookings are sent.
0sends only bookings with check-in today.1sends bookings with check-in today and tomorrow. - Set whether to include personal data in the data transfer.
- Tick Enable.
With the integration partner
Send the Access Key of each property you want to connect to the integration partner, who uses it to access the property. For further instructions, contact the integration partner's support.
Disconnect
Untick Enable to disconnect the room and stop sending its bookings.
Developers
The Arrivals API lets you read upcoming bookings for a property, and write or modify booking info items in those bookings. For example, a door access system can read details of upcoming bookings and store a door unlock code in each booking, so the code can be sent to the guest.
API setup
- Contact Beds24 for a merchant key for the Arrivals API.
- Each property generates an access key in Settings > Marketplace > Arrivals (Access Key).
- With the merchant key and the access key, you can call the functions below on the property.
- Only data from room types with the Synchronise tick box enabled is included.
| Function | What it does |
|---|---|
| getBookings | Returns all upcoming arrivals in the property as a JSON array. How many days before check-in bookings are available is set in Settings > Marketplace > Arrivals (Days in Advance). Personal information such as name and email is included if Allow Personal Info is set there. Suitable to call once per hour per property. |
| setBooking | Writes booking info items into a booking; an existing booking info item is modified. Booking info items can be used for reporting and to trigger Auto Actions for further operations, such as sending an email. You can also set the room note and status on the room that contains the booking. |
Commercial
Beds24 can list your integration and product at the Beds24 shop. Contact Beds24 for details.