Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions57

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, and other attributes.

Common scenarios where this node is beneficial include:

  • Generating reports of current or past reservations filtered by arrival or departure dates.
  • Synchronizing reservation data with other systems by fetching updated or newly created reservations.
  • Monitoring reservation statuses such as confirmed, canceled, checked-in, or no-show.
  • Filtering reservations by specific channels, groups, or market segments for targeted analysis.

Practical example:

  • A hotel manager wants to extract all confirmed reservations arriving within the next week to prepare room assignments and staffing.
  • A property management company needs to pull reservations modified in the last 24 hours to update their CRM system.

Properties

Name Meaning
Additional Fields Collection of optional filters and parameters to refine the reservation search. Includes:
- Channel Code Filter reservations by the channel code through which they were booked.
- Created From Filter reservations created from this date/time (ISO string).
- Created To Filter reservations created up to this date/time (ISO string).
- From Filter reservations by arrival date starting from this date (ISO string).
- Group ID Filter reservations belonging to a specific group ID.
- Modified From Filter reservations modified from this date/time (ISO string).
- Modified To Filter reservations modified up to this date/time (ISO string).
- Property IDs Filter reservations by one or more property IDs (comma-separated string).
- Service IDs Filter reservations by service IDs associated with them (comma-separated string).
- Status Filter reservations by status. Options: Confirmed, Canceled, CheckedIn, CheckedOut, NoShow. Default is Confirmed.
- Date Filter Select which date type to apply the from/to filters on. Options: Arrival, Departure, Stay. Default is Stay.
- To Filter reservations by departure date up to this date (ISO string).
- 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.
- Block IDs Filter reservations by requested 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 Specify the page number for paginated results. Default is 1.
- Page Size Number of items per page in the response. Default is 100.
- Expand Expand additional related information in the response. Options: Property, Unit Group, Rate Plan, Services, Company, Block.

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, including fields such as reservation ID, status, dates, guest details, assigned units, and optionally expanded related entities like property or rate plan if requested.

If the "Expand" option is used, the output includes nested objects with additional information about related resources (e.g., property details, unit groups).

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Apaleo API.
  • The node uses the base URL https://api.apaleo.com for all requests.
  • Proper configuration of the API authentication token is necessary in n8n credentials.
  • Pagination support requires handling page number and size parameters.

Troubleshooting

  • Common issues:

    • Invalid or expired API token leading to authentication errors.
    • Incorrect date formats in filter fields causing request failures.
    • Requesting too large page sizes may result in timeouts or API limits.
    • Using unsupported or misspelled filter values can cause empty results or errors.

  • Error messages:

    • Authentication errors typically indicate invalid credentials; recheck and update the API key.
    • Validation errors on date/time fields suggest incorrect formatting; ensure ISO 8601 format.
    • Rate limit exceeded errors require waiting or reducing request frequency.
    • If no reservations are returned, verify that filter criteria match existing data.

Links and References

Discussion