Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions45

Overview

This node interacts with the Apaleo API to create a new "block" within a property management context. A block typically represents a reserved allocation of units (e.g., rooms or apartments) for a specific time period, rate plan, and unit group. This operation is useful in scenarios such as managing inventory for group bookings, corporate allocations, or special rate plans where a set of units are blocked off from general availability.

Practical examples:

  • A hotel wants to reserve 10 rooms under a corporate rate plan for a conference happening next month.
  • A property manager blocks a group of apartments for a travel agency for a defined date range.
  • Temporarily blocking units for maintenance or exclusive use during certain dates.

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 for the gross daily rate (e.g., EUR)

Output

The node outputs JSON data representing the newly created block resource as returned by the Apaleo API. This typically includes details such as the block's unique identifier, associated group, property, rate plan, unit group, date range, rates, and status.

If the node supports binary data output, it would represent any file or media content related to the block, but based on the provided code and properties, this node primarily outputs structured JSON data about the block.

Dependencies

  • Requires an active connection to the Apaleo API.
  • Needs an API authentication token (API key or OAuth token) configured in n8n credentials to authorize requests.
  • The base URL for API requests is https://api.apaleo.com.
  • Proper permissions on the API token to create blocks within the specified property and group.

Troubleshooting

  • Common issues:

    • Invalid or missing required IDs (Group ID, Property ID, Rate Plan ID, Unit Group ID) will cause the API to reject the request.
    • Date range errors, such as fromDate being after toDate, may result in validation errors.
    • Insufficient permissions or expired API tokens will lead to authorization errors.
    • Incorrect currency codes or unsupported currencies might cause the API to fail.

  • Error messages:

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

Resolving these usually involves verifying input parameters, refreshing credentials, and ensuring the API user has appropriate access rights.

Links and References

Discussion