Apaleo icon

Apaleo

Interact with Apaleo API

Overview

This node interacts with the Apaleo API to perform various actions related to reservations, including cancelling a reservation. Specifically, for the "Reservation Action" resource and the "PUT cancel reservation" operation, it allows users to cancel an existing reservation by specifying its reservation ID.

This functionality is useful in scenarios such as:

  • Automating cancellation workflows when a guest requests to cancel their booking.
  • Integrating with external systems that manage bookings and need to update Apaleo accordingly.
  • Managing reservation lifecycle events programmatically within an n8n workflow.

Example use case: A hotel management system triggers this node to cancel a reservation automatically if a payment fails or if the guest cancels via a third-party platform.

Properties

Name Meaning
Reservation ID The unique identifier of the reservation to be cancelled. This filters bookings by ID.

Output

The node outputs JSON data representing the result of the cancellation request. Typically, this includes confirmation details about the cancelled reservation or error information if the cancellation failed.

If the node supports binary data output (not indicated here), it would represent any associated files or documents returned by the API, but in this case, the output is purely JSON.

Dependencies

  • Requires an API authentication token credential to access the Apaleo API.
  • The node makes HTTP requests to https://api.apaleo.com.
  • Proper permissions on the Apaleo account are necessary to perform reservation cancellations.

Troubleshooting

  • Common issues:

    • Invalid or missing Reservation ID will cause the cancellation to fail.
    • Expired or invalid API token will result in authentication errors.
    • Attempting to cancel a reservation that is already cancelled or does not exist may return an error from the API.
  • Error messages:

    • "Reservation not found": Check that the Reservation ID is correct.
    • "Unauthorized" or "Authentication failed": Verify the API credentials and token validity.
    • "Cannot cancel reservation": The reservation might be in a state that disallows cancellation; check reservation status before attempting cancellation.

Resolving these typically involves verifying input parameters, ensuring valid credentials, and confirming the reservation's current status.

Links and References

Discussion