Actions45
- Block Actions
- Block Action Actions
- Booking Actions
- Group Actions
- Offer Actions
- Reservation Actions
- Folio Actions
- Types Actions
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 available offers or pricing details filtered by channel, date range, and other optional parameters such as promo codes or corporate codes.
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 applicable during a certain period.
- Filtering offers by distribution channels like Booking.com or Expedia to analyze channel-specific availability.
Properties
| Name | Meaning |
|---|---|
| Channel Code | The distribution channel code to filter offers by (e.g., Direct, Booking.com, Expedia, etc.) |
| Rate Plan ID | The unique identifier of the rate plan for which to retrieve offers (required) |
| From | Start date of the offer index query in ISO8601 format (required) |
| To | End date of the offer index query in ISO8601 format (required) |
| Additional Fields | Optional additional filters and settings: |
| - 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: "Day Use" or "Over Night" |
| - Promo Code | Promotional code to filter special offers |
| - Corporate Code | Corporate code to filter corporate rate offers |
Output
The node outputs an array of JSON objects representing the offer index data retrieved from the Apaleo API. Each object typically contains details about offers available for the specified rate plan and date range, including pricing, availability, and any applied filters such as channel or promo codes.
If binary data were involved, it would represent associated files or documents related to offers, but this node focuses on JSON data output only.
Dependencies
- Requires an active connection to the Apaleo API using a valid API authentication token.
- The node expects the user to configure credentials containing an access token for the Apaleo API.
- Network connectivity to
https://api.apaleo.comis necessary.
Troubleshooting
- Invalid or missing Rate Plan ID: The node requires a valid rate plan ID; ensure this is provided and correctly formatted.
- Date format errors: The "From" and "To" fields must be in ISO8601 format; incorrect formats will cause API errors.
- Authentication failures: Ensure the API token credential is valid and has not expired.
- Pagination issues: If retrieving large datasets, adjust "Page Number" and "Page Size" appropriately to avoid incomplete data.
- Include Unavailable flag: Setting this incorrectly may result in unexpected empty results if no unavailable offers exist.
Common error messages usually relate to invalid parameters or authentication issues. Verifying input values and credentials typically resolves these.