Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions57

Overview

This node interacts with the Apaleo API to retrieve rate plan offers based on specified criteria such as arrival and departure dates, number of adults, and a specific rate plan ID. It is useful for scenarios where you want to fetch available offers or pricing details for a given rate plan within a date range, for example, when building booking systems, price comparison tools, or availability checkers.

Practical examples:

  • Fetching all available rate plan offers for a hotel between certain dates.
  • Retrieving special promotional offers tied to a corporate or promo code.
  • Filtering offers by channel (e.g., Booking.com, Expedia) to display channel-specific rates.

Properties

Name Meaning
Arrival Date and optional time of arrival in ISO8601 format.
Departure Date and optional time of departure in ISO8601 format.
Adults Number of adults for the offer search.
Channel Code The sales channel to filter offers by. Options: Direct, Booking.com, IBE, Channel Manager, Expedia, Homelike, HRS, AltoVita, DesVu.
Rate Plan ID Identifier of the rate plan to get offers for.
Additional Fields Collection of optional parameters:
- Children Ages Comma-separated list of children ages to consider.
- Include Unavailable Whether to include offers that are currently unavailable (boolean).
- Page Number For paginated results, the page number to retrieve.
- Page Size Number of items per page in paginated results.
- Time Slice Template Filter rate plans by time slice template. Options: Day Use, Over Night.
- Promo Code Promotional code to filter special offers.
- Corporate Code Corporate rate code to filter offers.

Output

The node outputs an array of JSON objects representing the rate plan offers retrieved from the Apaleo API. Each object contains detailed information about an offer, such as pricing, availability, applicable dates, and any associated codes (promo or corporate).

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

Dependencies

  • Requires an API key credential for authenticating with the Apaleo API.
  • The node uses the base URL https://api.apaleo.com for requests.
  • Proper configuration of the API authentication token is necessary in n8n credentials.

Troubleshooting

  • Common issues:

    • Invalid or expired API token leading to authentication errors.
    • Incorrect date formats for arrival or departure causing request failures.
    • Missing required parameters like ratePlanId, arrival, or departure.
    • Pagination parameters set incorrectly may result in incomplete data retrieval.

  • Error messages:

    • Authentication errors: Check that the API key credential is valid and has not expired.
    • Validation errors: Ensure all required fields are provided and formatted correctly (ISO8601 for dates).
    • API limit or quota exceeded: May require adjusting usage or contacting Apaleo support.

Links and References

Discussion