Actions45
- Block Actions
- Block Action Actions
- Booking Actions
- Group Actions
- Offer Actions
- Reservation Actions
- Folio Actions
- Types Actions
Overview
This node integrates with the Apaleo API to retrieve booking information. Specifically, the "GET Bookings" operation under the "Booking" resource allows users to fetch a list of bookings filtered and paginated according to various criteria. This is useful for scenarios such as synchronizing booking data with other systems, generating reports, or monitoring reservations in real-time.
Practical examples include:
- Fetching all bookings made through specific channels like Booking.com or Expedia.
- Searching bookings by customer name or company.
- Retrieving bookings page-by-page to handle large datasets efficiently.
- Expanding related booking details such as property info or rate plans for enriched data processing.
Properties
| Name | Meaning |
|---|---|
| Reservation ID | Filter bookings by a specific reservation identifier. |
| Group ID | Filter bookings belonging to a particular group. |
| Channel Code | Filter bookings by one or more sales channels. Options: Direct, Booking.com, IBE, Channel Manager, Expedia, Homelike, HRS, AltoVita, DesVu. |
| External Code | Filter bookings by an external code reference. |
| Text Search | Search bookings by matching text in last name, first name, email, or company name. |
| Page Number | Specify which page of results to retrieve (1-based index). |
| Page Size | Define how many bookings to return per page (max items per request). |
| Expand | Choose additional related booking information to include in the response. Options: Property, Unit Group, Rate Plan, Services, Reservations, Property Values. |
Output
The node outputs JSON data representing the retrieved bookings. The structure includes an array of booking objects, each containing standard booking details such as reservation IDs, guest information, dates, and status. If the "Expand" option is used, the output will also include nested objects with additional related information like property details, unit groups, rate plans, services, reservations, or property values.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to the Apaleo API using a valid API authentication token.
- The node expects the user to configure credentials that provide access to the Apaleo API.
- Network connectivity to
https://api.apaleo.comis necessary.
Troubleshooting
- Common Issues:
- Invalid or expired API token: The node will fail to authenticate with the Apaleo API.
- Incorrect filter parameters may result in empty responses.
- Pagination parameters out of range could cause errors or no data returned.
- Error Messages:
- Authentication errors typically indicate issues with the provided API key or token; re-authenticate or update credentials.
- Validation errors on input fields suggest incorrect parameter types or unsupported filter values; verify inputs against allowed options.
- Network timeouts or unreachable API endpoint errors require checking internet connectivity or Apaleo service status.