Apaleo icon

Apaleo

Interact with Apaleo API

Actions66

Reservation → GET reservations

AI-generated

Overview

This node interacts with the Apaleo API to retrieve reservation data based on various filtering criteria. It is useful for scenarios where users need to fetch detailed reservation information from Apaleo, such as filtering reservations by date ranges, status, property IDs, or other attributes. Practical examples include generating reports of confirmed reservations within a specific date range, or retrieving reservations associated with certain properties or channels.

Use Case Examples

  1. Fetch all confirmed reservations created between two dates.
  2. Retrieve reservations filtered by property IDs and status 'CheckedIn'.
  3. Search reservations by external code or text search.

Properties

Name Meaning
Additional Fields A collection of optional filters to refine the reservation query, including channel code, creation and modification date ranges, arrival and departure dates, group ID, property IDs, service IDs, status, date filter type, pagination options, and fields to expand for additional information.

Output

JSON

  • reservations - Array of reservation objects matching the query filters
  • totalCount - Total number of reservations matching the filters (if applicable)

Dependencies

  • Requires an API key credential for Apaleo API authentication.

Troubleshooting

  • Common issues include invalid or expired API tokens, resulting in authentication errors. Ensure the API key credential is correctly configured and valid.
  • Incorrect filter values or date formats may cause the API to return errors or empty results. Verify that date strings and IDs are correctly formatted.
  • Pagination parameters (pageNumber and pageSize) should be set appropriately to avoid missing data or excessive data load.

Discussion