Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions45

Overview

This node integrates with the Apaleo API to retrieve reservation data based on various filtering criteria. It is designed to fetch reservations from a property management system, allowing users to query reservations by status, date ranges, property IDs, unit groups, and other parameters.

Common scenarios include:

  • Extracting confirmed or canceled reservations within a specific date range.
  • Filtering reservations by arrival or departure dates.
  • Retrieving reservations linked to particular properties, units, or market segments.
  • Expanding related information such as property details, rate plans, or services associated with each reservation.

Practical examples:

  • A hotel manager wants to get all confirmed reservations arriving in the next week to prepare for guest check-ins.
  • A reporting system needs to pull canceled reservations for analysis of booking trends.
  • An integration that syncs reservation data with another system, requiring detailed reservation info including company and block data.

Properties

Name Meaning
Additional Fields Collection of optional filters and parameters to refine the reservation query:
- Channel Code Filter reservations by the channel code through which they were booked.
- Created From Filter reservations created on or after this date/time.
- Created To Filter reservations created on or before this date/time.
- From Filter reservations with arrival date on or after this date.
- Group ID Filter reservations belonging to a specific group ID.
- Modified From Filter reservations modified on or after this date/time.
- Modified To Filter reservations modified on or before this date/time.
- Property IDs Filter reservations by one or more property IDs (comma-separated string).
- Service IDs Filter reservations by service IDs associated with them.
- Status Filter reservations by their status. Options: Confirmed, Canceled, CheckedIn, CheckedOut, NoShow. Default is Confirmed.
- Time Slice Defines which date field to use for filtering with 'From' and 'To' fields. Options: Arrival, Departure, Stay. Default is Stay.
- To Filter reservations with departure date on or before this date.
- Unit IDs Filter reservations assigned to specific units (comma-separated string).
- Unit Group IDs Filter reservations requesting specific unit groups (comma-separated string).
- Unit Group Types Filter reservations by types of unit groups. Options: BedRoom, MeetingRoom, EventSpace, ParkingLot, Other. Can select multiple.
- Block IDs Filter reservations requesting specific blocks (comma-separated string).
- Market Segment IDs Filter reservations by market segment IDs (comma-separated string).
- External Code Filter reservations by an external code identifier.
- Text Search Free text search across reservations.
- Page Number The page number of results to return. Default is 1.
- Page Size Number of reservations per page. Default is 100.
- Expand Expand additional related information in the response. Options: Property, Unit Group, Rate Plan, Services, Company, Block. Multiple selections allowed.

Output

The node outputs an array of JSON objects representing reservations matching the specified filters. Each reservation object contains detailed reservation data as returned by the Apaleo API, potentially including expanded related entities if requested (e.g., property details, rate plans).

If binary data is present (not indicated here), it would represent associated files or attachments related to reservations, but this node primarily outputs JSON data.

Dependencies

  • Requires an API authentication token credential for the Apaleo API.
  • The node uses the base URL https://api.apaleo.com for API requests.
  • Proper configuration of the API key/credential in n8n is necessary for successful operation.

Troubleshooting

  • Authentication errors: Ensure the API token credential is valid and has not expired.
  • Invalid filter values: Date strings must be in correct ISO format; invalid dates may cause request failures.
  • Pagination issues: If too many results are expected, adjust Page Size and Page Number accordingly to avoid missing data.
  • API rate limits: Excessive requests might be throttled by the Apaleo API; implement retry logic or reduce request frequency.
  • Empty results: Verify filter criteria; overly restrictive filters may return no reservations.

Common error messages:

  • "Unauthorized" or "Invalid token": Check API credentials.
  • "Bad Request": Review filter parameters for correctness.
  • "Not Found": Resource or operation name mismatch.

Links and References

Discussion