Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions45

Overview

This node integrates with the Apaleo API to manage bookings and related entities. Specifically, for the Booking resource with the POST Force Add Reservations operation, it allows users to forcibly add one or more reservations to an existing booking. This can be useful in scenarios where reservations need to be added programmatically, bypassing some standard validation or availability checks that might otherwise prevent adding reservations.

Practical examples include:

  • Automatically adding guest reservations to a booking after receiving external confirmation.
  • Forcibly updating bookings with additional reservations during bulk import or synchronization processes.
  • Handling edge cases where manual intervention is required to add reservations despite conflicts.

Properties

Name Meaning
Booking ID The unique identifier of the booking to which reservations will be added.
Reservations JSON-formatted data representing the reservations to add. This should conform to the expected reservation structure defined by the API.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output JSON object contains the response from the Apaleo API after attempting to add the reservations forcibly to the specified booking.

  • The json field includes details about the updated booking or the newly added reservations as returned by the API.
  • If the operation fails for any item and "Continue On Fail" is enabled, the output for that item will contain an error field with the error message and an empty json object.
  • No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the Apaleo API via an API authentication token (access token).
  • The node expects the user to configure credentials providing access to the Apaleo API.
  • Network connectivity to https://api.apaleo.com is necessary.

Troubleshooting

  • Common issues:

    • Invalid or expired API token leading to authentication errors.
    • Malformed JSON in the Reservations property causing request failures.
    • Attempting to add reservations to a non-existent or invalid Booking ID.
    • API rate limits or service unavailability.

  • Error messages:

    • Authentication errors typically indicate problems with the provided API token; refreshing or reconfiguring credentials resolves these.
    • Validation errors from the API may indicate incorrect reservation data format; ensure the JSON matches the expected schema.
    • If the node throws errors related to missing booking or reservation data, verify that the Booking ID exists and the Reservations JSON is correctly structured.
    • Enabling "Continue On Fail" allows processing to continue for other items even if some fail, with error details included in the output.

Links and References

Discussion