Apaleo icon

Apaleo

Interact with Apaleo API

Overview

This node interacts with the Apaleo API to retrieve offers related to a specific property. The "GET offers" operation fetches available offers for a given property within a specified date range and guest configuration. It is useful in scenarios such as travel booking platforms, property management systems, or any application needing to display or process accommodation offers dynamically based on user input like arrival/departure dates and number of guests.

Practical examples:

  • A hotel booking website fetching current offers for a selected hotel property.
  • A channel manager system retrieving offers from Apaleo to synchronize availability and pricing.
  • A corporate travel tool querying special corporate or promotional offers for business travelers.

Properties

Name Meaning
Property ID The unique identifier of the property for which offers are requested.
Arrival Date and optional time of arrival in ISO8601 format (e.g., 2024-06-01T15:00:00Z).
Departure Date and optional time of departure in ISO8601 format.
Adults Number of adult guests included in the offer request.
Channel Code The sales channel through which the offer is requested. Options: Direct, Booking.com, IBE, Channel Manager, Expedia, Homelike, HRS, AltoVita, DesVu.
Additional Fields A collection of optional parameters to refine the offer query:
- Children Ages Comma-separated list of children ages to include in the offer calculation.
- Include Unavailable Boolean flag indicating whether to include offers that are currently unavailable.
- Page Number For paginated results, specifies which page of data to retrieve.
- Page Size Number of items per page in paginated results.
- Time Slice Template Filters rate plans by time slice type. Options: Day Use, Over Night.
- Promo Code Promotional code to apply special discounts or offers.
- Corporate Code Code used to access corporate rates or offers.

Output

The node outputs an array of JSON objects representing the offers retrieved from the Apaleo API. Each object typically contains details about the offer such as pricing, availability, applicable dates, guest configuration, and any promotional or corporate codes applied.

If binary data were involved (not indicated here), it would represent associated files or documents related to offers, but this node focuses on JSON data output.

Dependencies

  • Requires an active connection to the Apaleo API via an API authentication token (API key credential).
  • The node expects the Apaleo API base URL https://api.apaleo.com.
  • Proper credentials must be configured in n8n to authenticate requests.
  • Network connectivity to Apaleo's service endpoints is necessary.

Troubleshooting

  • Invalid or missing Property ID: Ensure the Property ID is correctly provided and corresponds to a valid property in Apaleo.
  • Authentication errors: Verify that the API authentication token is valid and has not expired.
  • Date format issues: Arrival and Departure must be in ISO8601 format; incorrect formatting may cause errors.
  • Pagination limits: If requesting large page sizes, the API might reject the request or truncate results; adjust Page Size accordingly.
  • Unavailable offers not showing: If expecting unavailable offers, ensure the Include Unavailable flag is set to true.
  • Channel Code mismatches: Using an unsupported or misspelled channel code can lead to no results or errors.
  • API rate limits: Frequent calls may hit Apaleo's rate limits; implement retry logic or reduce call frequency if needed.

Common error messages will generally relate to invalid parameters, authentication failures, or network issues. Reviewing the exact error message returned by the API will guide resolution steps.

Links and References

Discussion