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 the count of reservations based on various filtering criteria. It is useful in scenarios where you need to quickly obtain the number of reservations matching specific conditions without fetching full reservation details. For example, a hotel management system might use this node to monitor how many confirmed reservations exist for a particular property or date range, enabling operational planning and reporting.
Properties
| Name | Meaning |
|---|---|
| Channel Code | Filter reservations by the channel code through which they were made. |
| Created From | Filter reservations created from this date and time (inclusive). |
| Created To | Filter reservations created up to this date and time (inclusive). |
| From | Filter reservations by arrival date starting from this date. |
| Group ID | Filter reservations belonging to a specific group ID. |
| Modified From | Filter reservations modified from this date and time (inclusive). |
| Modified To | Filter reservations modified up to this date and time (inclusive). |
| Property IDs | Filter reservations by one or more property IDs (comma-separated string expected). |
| Service IDs | Filter reservations by one or more service IDs (comma-separated string expected). |
| Status | Filter reservations by their status. Options: Confirmed, Canceled, CheckedIn, CheckedOut, NoShow. Default is Confirmed. |
| Time Slice | Defines which date field to apply the "from" and "to" filters on. Options: Arrival, Departure, Stay. Default is Stay. |
| To | Filter reservations by departure date up to this date. |
| Unit IDs | Filter reservations assigned to specific unit IDs (comma-separated string expected). |
| Unit Group IDs | Filter reservations requesting specific unit groups (comma-separated string expected). |
| Unit Group Types | Filter reservations by types of unit groups. Multiple selections allowed. Options: BedRoom, MeetingRoom, EventSpace, ParkingLot, Other. |
| Block IDs | Filter reservations requesting specific blocks (comma-separated string expected). |
| Market Segment IDs | Filter reservations by market segment IDs (comma-separated string expected). |
| External Code | Filter reservations by an external code identifier. |
| Text Search | Search text within reservations for matching content. |
| Page Number | The page number of results to return (for pagination). Default is 1. |
| Page Size | Number of items per page to return. Default is 100. |
| Expand | Expand additional related information in the response. Multiple selections allowed. Options: Property, Unit Group, Rate Plan, Services, Company, Block. |
Output
The node outputs a JSON object containing the count of reservations that match the specified filters. The structure typically includes a numeric field representing the total count. If expansions are requested, additional related data may be included accordingly.
If the node supports binary output (not indicated here), it would represent binary data related to reservations, but this operation focuses on count retrieval and thus outputs JSON only.
Dependencies
- Requires an active connection to the Apaleo API.
- Requires an API authentication token credential configured in n8n to authorize requests.
- Network access to
https://api.apaleo.comis necessary.
Troubleshooting
Common Issues:
- Invalid or expired API token: Ensure the API key credential is valid and refreshed if needed.
- Incorrect filter formats: Date/time strings should be in ISO 8601 format; comma-separated lists must be properly formatted.
- Pagination parameters out of range: Page number and size should be positive integers.
- Network connectivity issues: Verify internet access and firewall settings allow communication with Apaleo API.
Error Messages:
- Authentication errors usually indicate invalid credentials; reconfigure the API key.
- Validation errors on filters suggest incorrect parameter values; review and correct input formats.
- Rate limiting errors mean too many requests in a short period; implement retry logic or reduce request frequency.