Apaleo icon

Apaleo

Interact with Apaleo API

Overview

This node interacts with the Apaleo API to perform various actions related to reservations, specifically here focusing on the "PUT checkin reservation" operation within the "Reservation Action" resource. The primary function of this operation is to check in a guest's reservation, marking their arrival and optionally adding city tax charges.

Common scenarios where this node is beneficial include:

  • Automating the check-in process for hotel guests.
  • Integrating front desk systems with Apaleo to update reservation statuses in real-time.
  • Managing billing aspects by deciding whether city tax should be applied during check-in.

Practical example:

  • A hotel management workflow that automatically checks in guests when they arrive, updating the reservation status and applying city tax if applicable.

Properties

Name Meaning
Reservation ID Filter bookings by the specific reservation ID to identify which reservation to check in.
Add City Tax Boolean option to define if city tax should be added for this reservation during check-in. Defaults to true.

Output

The node outputs an array of JSON objects representing the results of the check-in operation(s). Each object corresponds to one input item processed and contains the updated reservation data after check-in.

If the operation supports binary data output (not indicated here), it would typically represent files or documents related to the reservation, but this node primarily deals with JSON data reflecting reservation state changes.

Dependencies

  • Requires an API key credential for authenticating with the Apaleo API.
  • The node depends on the Apaleo API being accessible at https://api.apaleo.com.
  • Proper permissions on the API key are necessary to perform reservation check-in operations.

Troubleshooting

  • Common issues:

    • Invalid or missing Reservation ID may cause the API to return errors indicating the reservation was not found.
    • Insufficient API permissions can lead to authorization errors.
    • Network connectivity problems can prevent successful API calls.
  • Error messages and resolutions:

    • "Reservation not found": Verify the Reservation ID is correct and exists in Apaleo.
    • "Unauthorized" or "Forbidden": Check that the API key has the required scopes/permissions.
    • "Failed to add city tax": If city tax addition fails, ensure the property is set correctly and the account supports city tax charges.

Links and References

Discussion