Apaleo icon

Apaleo

Interact with Apaleo API

Overview

This node integrates with the Apaleo API to manage reservation-related data. Specifically, for the "Reservation" resource and the "GET reservation service offers" operation, it retrieves available service offers linked to a particular reservation. This is useful in scenarios where you want to fetch additional services or amenities that can be added to an existing reservation, such as spa packages, dining options, or transportation services.

Practical examples include:

  • Displaying all service offers available for a guest's current reservation.
  • Automating upselling by fetching and presenting service offers during the booking process.
  • Integrating with other systems to enrich reservation details with available service offers.

Properties

Name Meaning
Reservation ID The unique identifier of the reservation for which to retrieve service offers. Required.

Output

The node outputs JSON data containing the list of service offers associated with the specified reservation. Each item in the output typically includes details about the service offer such as its name, description, pricing, availability, and any relevant metadata provided by the Apaleo API.

If the node supports binary data (not indicated here), it would represent attachments or media related to the service offers, but this operation primarily returns structured JSON data.

Dependencies

  • Requires an active connection to the Apaleo API via an API key credential (an API authentication token).
  • The node expects the Apaleo API base URL https://api.apaleo.com.
  • Proper permissions on the API key to access reservation and service offer endpoints are necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Reservation ID will cause the API call to fail.
    • Insufficient API permissions may result in authorization errors.
    • Network connectivity problems can prevent successful API communication.
  • Error messages:

    • "Reservation not found": Verify the Reservation ID is correct and exists.
    • "Unauthorized" or "Forbidden": Check that the API key has the required scopes/permissions.
    • "Request failed" or timeout errors: Ensure network connectivity and API endpoint availability.

Resolving these usually involves verifying input parameters, checking API credentials, and ensuring the Apaleo service is operational.

Links and References

Discussion