Actions5
Overview
This node interacts with the Apaleo API to retrieve a list of all available units for a specific reservation. It is useful in scenarios where you need to check unit availability linked to a reservation, such as in property management systems or booking platforms. For example, a hotel management system can use this node to fetch which rooms (units) are available for a given reservation ID within a specified date range and filter by unit condition or attributes.
Properties
| Name | Meaning |
|---|---|
| Group | The API group to use. Options include: AvailabilityV1, BookingV1, FinanceV1, InventoryV1, LogsV1, OperationsV1, RateplanV1, ReportsV1, SettingsV1, WebhookV1. Default is AvailabilityV1. |
| ID | The unique identifier of the reservation for which to get available units. This is required. |
| Additional Fields | A collection of optional parameters to refine the query: |
| - From | Start date and time (ISO8601 format) to filter availability from. |
| - To | End date and time (ISO8601 format) to filter availability until. |
| - IncludeOutOfService | Boolean flag indicating whether to include units marked as OutOfService during the specified period. |
| - PageNumber | The page number for paginated results (1-based). Defaults to 1. If no items exist on the page, a 204 response is returned. |
| - PageSize | Number of items per page. If not set or invalid, pagination is ignored and all items are returned. |
| - UnitAttributeIds | Filter units by specific attribute IDs (comma-separated string). |
| - UnitCondition | Filter units by their condition. Options: Clean, CleanToBeInspected, Dirty. Default is Clean. |
| - UnitGroupId | Filter units by a specific unit group ID. |
Output
The node outputs JSON data representing the list of available units for the specified reservation. Each item in the output corresponds to a unit matching the criteria provided. The structure typically includes unit details such as ID, attributes, condition, availability status, and other metadata as returned by the Apaleo API endpoint /availability/v1/reservations/{id}/units.
If binary data were involved (e.g., images or files), it would be summarized here, but this node deals only with JSON responses.
Dependencies
- Requires an API key credential for authenticating with the Apaleo API.
- The node uses the base URL
https://api.apaleo.com. - Proper OAuth2 credentials must be configured in n8n to authorize requests.
- The node depends on the Apaleo API being accessible and the reservation ID being valid.
Troubleshooting
- Invalid Reservation ID: If the reservation ID does not exist or is malformed, the API may return a 404 or error response. Verify the ID before running the node.
- Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the OAuth2 credentials are correctly set up.
- Empty Results / 204 Response: If the specified page number has no items, the API returns HTTP 204 No Content. Adjust pagination parameters accordingly.
- Date Format Issues: The
FromandTofields require ISO8601 date-time strings without fractional seconds. Incorrect formats may cause request failures. - API Rate Limits: Excessive requests might trigger rate limiting; handle retries or backoff as needed.