Apaleo icon

Apaleo

Interact with Apaleo API

Actions66

Reservation → GET reservation count

AI-generated

Overview

This node operation retrieves the count of reservations from the Apaleo API based on various filter criteria. It is useful for scenarios where you need to know the number of reservations matching specific conditions without fetching full reservation details. For example, it can be used to monitor booking trends, generate reports on reservation statuses, or filter counts by date ranges, property IDs, or other reservation attributes.

Use Case Examples

  1. Count the number of confirmed reservations created within a specific date range.
  2. Get the count of reservations filtered by property IDs and status.
  3. Retrieve the number of reservations with a specific channel code or external code.

Properties

Name Meaning
Channel Code Filter reservations by channel code.
Created From Filter reservations by creation date and time from.
Created To Filter reservations by creation date and time to.
From Filter reservations by arrival date from.
Group ID Filter reservations by group ID.
Modified From Filter reservations by modification date and time from.
Modified To Filter reservations by modification date and time to.
Property IDs Filter reservations by property IDs.
Service IDs Filter reservations by service IDs.
Status Filter reservations by status.
Date Filter Date filter to use for from/to date filtering.
To Filter reservations by departure date to.
Unit IDs Filter reservations by assigned units.
Unit Group IDs Filter reservations by requested unit groups.
Unit Group Types Filter reservations by unit group types.
Block IDs Filter reservations by requested blocks.
Market Segment IDs Filter reservations by market segments.
External Code Filter reservations by external code.
Text Search Search text in reservations.
Page Number Page number for results.
Page Size Number of items per page.
Expand Expand additional information.

Output

JSON

  • count - The total count of reservations matching the filter criteria.

Dependencies

  • Apaleo API with an access token credential

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access reservation data.
  • Verify that date and filter formats match the expected API requirements to avoid errors.
  • If the node returns an error, check the error message for details such as invalid filter values or network issues.
  • Pagination parameters (Page Number and Page Size) should be set appropriately to avoid unexpected results or API limits.

Links

  • Apaleo Reservations API - Official Apaleo API documentation for reservations, including filtering and count endpoints.

Discussion