Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions57

Overview

This node integrates with the Apaleo API to retrieve booking information. Specifically, the "GET Bookings" operation 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 details such as last name or email.
  • Retrieving detailed booking information including related property, unit group, rate plan, or services by expanding those fields.
  • Paginating through large sets of bookings to process them in batches.

Properties

Name Meaning
Reservation ID Filter bookings by a specific reservation identifier.
Group ID Filter bookings by a specific group identifier.
Channel Code Filter bookings by one or more channel codes. Options: Direct, Booking.com, IBE, Channel Manager, Expedia, Homelike, HRS, AltoVita, DesVu.
External Code Filter bookings by an external code associated with the booking.
Text Search Search bookings by matching text in lastname, firstname, email, or company name.
Page Number Specify which page of results to retrieve (1-based index).
Page Size Number of bookings to return per page.
Expand Expand additional booking information. Options: Property, Unit Group, Rate Plan, Services, Reservations, Property Values.

Output

The output is an array of JSON objects representing bookings retrieved from the Apaleo API. Each object contains booking details such as reservation identifiers, guest information, booking dates, and optionally expanded related entities depending on the "Expand" property selected.

If binary data were involved (not indicated here), it would typically represent attachments or documents related to bookings, but this operation focuses on JSON data only.

Dependencies

  • Requires an API authentication token credential for the Apaleo API.
  • The node uses the base URL https://api.apaleo.com for API requests.
  • No additional external dependencies are indicated beyond the Apaleo API access.

Troubleshooting

  • Common issues:
    • Invalid or expired API token: Ensure the API key/credential is valid and refreshed if necessary.
    • Incorrect filter values: Using invalid reservation IDs, group IDs, or channel codes may result in empty responses.
    • Pagination errors: Requesting a page number beyond available pages will return no results.
  • Error messages:
    • Authentication errors typically indicate problems with the API token; re-authenticate or check permissions.
    • Validation errors may occur if filter parameters are malformed; verify input formats.
    • Network or timeout errors suggest connectivity issues; retry or check network settings.

Links and References

Discussion