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 the count of reservations based on various filtering criteria. It is useful for 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 within a certain date range or for a particular property.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | A collection of optional filters and parameters to refine the reservation count query: |
| - Channel Code | Filter reservations by the channel code through which they were made |
| - Created From | Filter reservations created from this date and time (ISO 8601 string) |
| - Created To | Filter reservations created up to this date and time |
| - 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 |
| - Modified To | Filter reservations modified up to this date and time |
| - Property IDs | Filter reservations by one or more property IDs (comma-separated string) |
| - Service IDs | Filter reservations by service IDs |
| - Status | Filter reservations by status; options are Confirmed, Canceled, CheckedIn, CheckedOut, NoShow |
| - Date Filter | Select which date type to apply the from/to filters on: Arrival, Departure, or Stay |
| - To | Filter reservations by departure date up to this date |
| - Unit IDs | Filter reservations assigned to specific units |
| - Unit Group IDs | Filter reservations requesting specific unit groups |
| - Unit Group Types | Filter reservations by types of unit groups; options include BedRoom, MeetingRoom, EventSpace, ParkingLot, Other |
| - Block IDs | Filter reservations by requested blocks |
| - Market Segment IDs | Filter reservations by market segment IDs |
| - External Code | Filter reservations by an external code |
| - Text Search | Search text within reservations |
| - Page Number | Specify the page number for paginated results (default 1) |
| - Page Size | Specify the number of items per page in results (default 100) |
| - Expand | Expand additional related information; options include 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 exact structure typically includes a numeric field representing the total count. If expansions are requested, additional related data may be included accordingly.
No binary data output is expected from this operation.
Dependencies
- Requires an API authentication token credential for the Apaleo API.
- The node uses the base URL
https://api.apaleo.comand expects JSON content-type headers. - Proper configuration of the API key/credential in n8n is necessary for successful requests.
Troubleshooting
Common Issues:
- Invalid or expired API token: Ensure the API credentials are valid and refreshed if needed.
- Incorrect filter formats: Date fields should be ISO 8601 strings; invalid formats may cause errors.
- Pagination parameters out of range: Page number and size should be positive integers.
- Network connectivity issues: Verify network access to the Apaleo API endpoint.
Error Messages:
- Authentication errors usually indicate problems with the API token; re-authenticate or update credentials.
- Validation errors may occur if filter values are invalid or unsupported; check input formats carefully.
- Rate limiting errors from the API suggest too many requests in a short period; implement retry logic or reduce request frequency.