Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions57

Overview

This node integrates with the Apaleo API to create a new "block" in the booking system. A block typically represents a reserved allocation of units (e.g., rooms or apartments) for a specific time period under a particular rate plan and unit group within a property. This operation is useful for property managers or booking systems that need to programmatically reserve inventory blocks to control availability, manage group bookings, or allocate units for special purposes.

Practical examples:

  • Reserving a block of rooms for a corporate client for a conference.
  • Allocating units for maintenance or renovation by blocking them out for certain dates.
  • Creating seasonal blocks with specific rates for marketing campaigns.

Properties

Name Meaning
Group ID ID of the group this block belongs to
Property ID ID of the property where the block should be created
Rate Plan ID ID of the rate plan associated with the block
Unit Group ID ID of the unit group for which the block applies
From Date Start date of the block (date and time)
To Date End date of the block (date and time)
Gross Daily Rate Gross daily rate charged for the block
Currency Currency code (e.g., EUR) for the gross daily rate

Output

The node outputs an array of JSON objects representing the result of the block creation operation. Each object corresponds to one input item processed and contains the response data from the Apaleo API about the newly created block.

  • The json output field includes details such as the block's unique identifier, associated group, property, rate plan, unit group, date range, and pricing information.
  • No binary data output is produced by this node.

Dependencies

  • Requires an API authentication token credential for the Apaleo API.
  • The node uses the base URL https://api.apaleo.com and expects JSON content-type headers.
  • Proper permissions on the Apaleo account are necessary to create blocks.

Troubleshooting

  • Common issues:

    • Invalid or missing required IDs (Group ID, Property ID, Rate Plan ID, Unit Group ID) will cause the API call to fail.
    • Date range errors, such as fromDate being after toDate, may result in validation errors.
    • Insufficient permissions or expired API tokens will lead to authentication errors.

  • Error messages:

    • "Unauthorized": Check that the API token credential is valid and has not expired.
    • "Validation error": Verify all required fields are provided and correctly formatted.
    • "Resource not found": Confirm that the provided IDs correspond to existing entities in Apaleo.

  • Resolution tips:

    • Double-check all input parameters for correctness.
    • Refresh or reconfigure the API credentials if authentication fails.
    • Review the Apaleo API documentation for correct usage of block creation parameters.

Links and References

Discussion