Actions5
Overview
This node interacts with the Apaleo API to retrieve a list of all available services for a specified property within a given time period. It is useful in scenarios where you need to query which services are offered at a property, filtered by date range and optionally by other criteria such as channel codes or time slice templates.
Practical examples include:
- Fetching all services available at a hotel property for a specific week to display on a booking platform.
- Integrating service availability data into a property management system to synchronize offerings.
- Filtering services by sales channels or time slices to analyze availability patterns.
Properties
| Name | Meaning |
|---|---|
| Group | Selects the API group; here it defaults to "AvailabilityV1" for availability-related endpoints. |
| PropertyId | The unique identifier of the property for which to fetch available services. |
| From | The start date (inclusive) of the requested time period in ISO 8601 format. |
| To | The end date (inclusive) of the requested time period in ISO 8601 format. |
| Additional Fields | Optional filters and pagination parameters: |
| - ChannelCodes | Filter services by specific channel codes. |
| - PageNumber | The page number for paginated results (1-based). Defaults to 1. |
| - PageSize | Number of items per page. If not set or invalid, all items are returned ignoring pagination. |
| - TimeSliceDefinitionIds | Filter by specific time slice definition IDs. |
| - TimeSliceTemplate | Selects the time slice template, either "DayUse" or "OverNight". Defaults to "DayUse". |
Output
The node outputs JSON data representing the list of available services for the specified property and time period. The structure typically includes details about each service such as identifiers, descriptions, availability windows, and possibly associated metadata like channel codes or time slices.
If binary data were involved, it would be summarized accordingly, but this node deals exclusively with JSON responses from the Apaleo API.
Dependencies
- Requires an API authentication token credential configured in n8n to access the Apaleo API.
- The base URL for requests is
https://api.apaleo.com. - The node uses HTTP GET requests to the
/availability/v1/servicesendpoint with query parameters based on input properties.
Troubleshooting
- Empty Results / HTTP 204: If you request a page number that has no items, the API returns a 204 No Content response. Adjust the page number or page size accordingly.
- Invalid Date Format: Ensure the "From" and "To" dates are valid ISO 8601 date-time strings. The node converts input dates to ISO strings without milliseconds.
- Missing Required Fields: The "PropertyId", "From", and "To" fields are mandatory. Omitting them will cause errors.
- API Authentication Errors: Verify that the API key or OAuth2 credentials are correctly configured and have sufficient permissions.
- Filtering Issues: Incorrect or unsupported values in optional filters like "ChannelCodes" or "TimeSliceTemplate" may result in empty or unexpected results.