Actions57
- Booking Actions
- Group Actions
- Offer Actions
- Block Actions
- Block Action Actions
- Reservation Actions
- Reservation Action Actions
- Types Actions
- Folio Actions
- Folio Action Actions
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:
- Displaying available accommodation offers for a property on a booking website.
- Integrating Apaleo offers into a custom booking or property management system.
- Filtering offers by channel, promo codes, or corporate codes to tailor availability.
For example, a hotel booking platform can use this node to show all current offers for a hotel property between certain arrival and departure dates, specifying the number of adults and optionally children ages, and filtering by sales channel or promotional codes.
Properties
| Name | Meaning |
|---|---|
| Property ID | The unique identifier of the property for which to retrieve offers. |
| Arrival | The arrival date and optional time in ISO8601 format (e.g., 2024-07-01T15:00:00Z). |
| Departure | The departure date and optional time in ISO8601 format (e.g., 2024-07-05T11:00:00Z). |
| Adults | Number of adult guests for the offer search. |
| Channel Code | The sales channel code to filter offers by. Options include: Direct, Booking.com, IBE, Channel Manager, Expedia, Homelike, HRS, AltoVita, DesVu. |
| Additional Fields | A collection of optional fields to further refine the offer search: |
| - Children Ages | Comma-separated list of children ages (e.g., "5,8"). |
| - Include Unavailable | Boolean flag to include offers that are currently unavailable. |
| - Page Number | For paginated results, the page number to retrieve (default 1). |
| - Page Size | Number of items per page in paginated results (default 100). |
| - Time Slice Template | Filter rate plans by time slice template; options are "Day Use" or "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 offers retrieved from the Apaleo API. Each object typically contains details about an individual offer, such as pricing, availability, applicable rate plans, and restrictions.
If binary data were involved (e.g., documents or images), it would be included in the binary output field, but this operation focuses on JSON data only.
Dependencies
- Requires an API authentication token credential for the Apaleo API.
- The node uses the base URL
https://api.apaleo.comfor requests. - No additional external dependencies beyond the Apaleo API and its credentials.
Troubleshooting
Common Issues:
- Invalid or missing Property ID will cause the API to reject the request.
- Incorrect date formats for Arrival or Departure may result in errors or empty responses.
- Using unsupported or misspelled Channel Codes will lead to no matching offers.
- Pagination parameters out of range might return empty pages.
Error Messages:
- Authentication errors indicate invalid or expired API tokens; refresh or reconfigure credentials.
- Validation errors usually specify which input parameter is incorrect; verify required fields and formats.
- Network or timeout errors suggest connectivity issues; check network access to the Apaleo API endpoint.