Apaleo icon

Apaleo

Interact with Apaleo API

Overview

This node interacts with the Apaleo API to retrieve offer index data for a specified rate plan within a given date range. It is useful in scenarios where you need to fetch availability and pricing offers from Apaleo's channel management system, filtered by channel code, date range, and other optional parameters.

Practical examples include:

  • Fetching all available offers for a specific rate plan between two dates to display on a booking platform.
  • Retrieving promotional or corporate offers for integration into a custom booking engine.
  • Analyzing offer availability across different distribution channels like Booking.com or Expedia.

Properties

Name Meaning
Channel Code The distribution channel to filter offers by. Options: Direct, Booking.com, IBE, Channel Manager, Expedia, Homelike, HRS, AltoVita, DesVu
Rate Plan ID The unique identifier of the rate plan for which to retrieve offers (required)
From Start date of the offer index period in ISO8601 format (required)
To End date of the offer index period in ISO8601 format (required)
Additional Fields A collection of optional fields to further filter or paginate results:
- Children Ages Comma-separated list of children ages to consider
- Include Unavailable Whether to include offers that are currently unavailable (boolean)
- Page Number Page number for paginated results (default 1)
- Page Size Number of items per page in paginated results (default 100)
- Time Slice Template Filter offers by time slice template; options: Day Use, Over Night (default Over Night)
- Promo Code Promotional code to filter special offers
- Corporate Code Corporate code to filter corporate rates

Output

The node outputs an array of JSON objects representing the offer index data retrieved from Apaleo. Each object typically contains details about offers available for the specified rate plan and date range, including availability, pricing, and applicable filters such as channel code and promo codes.

If binary data were involved (e.g., documents or images), it would be summarized here, but this node focuses on JSON data output only.

Dependencies

  • Requires an API authentication token credential for Apaleo API access.
  • The node uses the base URL https://api.apaleo.com and expects JSON content-type headers.
  • No additional external dependencies beyond the Apaleo API and its credentials.

Troubleshooting

  • Invalid or missing Rate Plan ID: The node requires a valid rate plan ID; ensure this is provided and correct.
  • Date format errors: The "From" and "To" properties must be in ISO8601 format; invalid formats will cause request failures.
  • API authentication errors: Ensure the API key or token credential is correctly configured and has not expired.
  • Pagination issues: If retrieving large datasets, adjust "Page Number" and "Page Size" appropriately to avoid incomplete data.
  • Unavailable offers not showing: Set "Include Unavailable" to true if you want to see offers that are currently not bookable.

Common error messages will relate to HTTP status codes from the Apaleo API, such as 401 Unauthorized (authentication issues), 400 Bad Request (invalid parameters), or 404 Not Found (invalid rate plan or resource).

Links and References

Discussion