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 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 rate plans and their offers for a given stay period and occupancy, for example, when building booking or pricing systems that need to display current offers from Apaleo.
Practical examples include:
- Fetching all available rate plan offers for a hotel room between certain dates.
- Filtering offers by channel (e.g., Direct, Booking.com) or applying promo codes.
- Paginating through large sets of offers to display in a user interface.
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 booking. |
| Channel Code | The sales channel code; options include: Direct, Booking.com, IBE, Channel Manager, Expedia, Homelike, HRS, AltoVita, DesVu. |
| Rate Plan ID | Identifier of the rate plan to query offers for. |
| Additional Fields | Collection of optional parameters: |
| - Children Ages | Comma-separated list of children ages. |
| - Include Unavailable | Boolean flag to include unavailable offers in results. |
| - Page Number | Page number for paginated results (default 1). |
| - Page Size | Number of items per page (default 100). |
| - Time Slice Template | Filter for rate plans by time slice template; options are Day Use or Over Night. |
| - Promo Code | Promotional code to filter special offers. |
| - Corporate Code | Code to filter corporate rates. |
Output
The node outputs JSON data representing the retrieved rate plan offers matching the input criteria. The structure typically includes details about each offer such as availability, pricing, applicable dates, and any promotional or corporate codes applied.
If binary data were involved (not indicated here), it would represent associated files or media related to offers, but this node focuses on JSON responses from the API.
Dependencies
- Requires an active connection to the Apaleo API via an API authentication token.
- The node expects the user to configure credentials containing an access token for Apaleo.
- Network connectivity to
https://api.apaleo.comis necessary.
Troubleshooting
- Invalid or expired API token: The node will fail if the provided API token is invalid or expired. Refresh or reconfigure the API credentials.
- Incorrect date formats: Ensure that Arrival and Departure dates are in valid ISO8601 format; otherwise, the API may reject the request.
- Missing required fields: Rate Plan ID, Arrival, Departure, and Adults are mandatory. Omitting these will cause errors.
- Pagination issues: If too many results are returned, use Page Number and Page Size to paginate properly.
- Unavailable offers not showing: Set "Include Unavailable" to true if you want to see offers that are currently unavailable.
- Channel Code mismatches: Use one of the predefined channel codes to avoid errors.