Actions30
- Accommodations API Actions
- Administrations API Actions
- Contacts API Actions
- Invoices API Actions
- Price Calculation API Actions
- Rates API Actions
- Reservations API Actions
- Timezones API Actions
Overview
This node interacts with the Starfish API for CampingCare and HotelCare, specifically to retrieve reservation data. It supports fetching detailed reservation information or just the total count, with various filtering options such as date ranges, status, accommodation, contact, and more. This node is useful for automating workflows that require reservation data retrieval, such as reporting, booking management, or integration with other systems.
Use Case Examples
- Retrieve all confirmed reservations for a specific accommodation within a date range.
- Get the total count of reservations filtered by status and arrival date.
- Fetch detailed reservation data including contact and invoice information for further processing.
Properties
| Name | Meaning |
|---|---|
| Count | Whether to return only the total count of reservations instead of full details. |
| Filter Root Meta | Whether to filter root meta information in the response. |
| Get Contact | Whether to include contact information in the reservation data. |
| Get Invoice Meta | Whether to include invoice meta information. |
| Get Invoice Payment | Whether to include invoice payment details of the reservation(s). |
| Get Invoices | Whether to include invoice data. |
| Get Meta | Whether to include meta information. |
| Get Payment Terms | Whether to include payment terms. |
| Get Rows | Whether to include detailed row information. |
| Accommodation Name or ID | Filter reservations by accommodation ID or name from a selectable list. |
| Admin ID | Filter reservations by administration ID (OTA only). |
| Arrival Date | Filter reservations by arrival date or date range. |
| Arrival Operator | Operator to use with arrival date filter (e.g., =, >, <). |
| Channel | Filter reservations by channel ID from a selectable list. |
| Contact ID | Filter reservations by contact ID. |
| Create Date | Filter reservations by creation date or date range. |
| Create Date Operator | Operator to use with create date filter. |
| Departure Date | Filter reservations by departure date or date range. |
| Departure Operator | Operator to use with departure date filter. |
| Group ID | Filter reservations by group ID. |
| Last Modified | Filter reservations by last modified date. |
| Last Modified Operator | Operator to use with last modified date filter. |
| Limit | Limit the number of reservations returned for pagination (default 10, max 30). |
| Meta Key | Filter reservations by a specific meta key. |
| Meta Operator | Operator to use with meta key filter (e.g., =, >, <). |
| Meta Value | Value to match for the specified meta key. |
| Offset | Offset for pagination to skip a number of reservations. |
| Order | Sort order of the results: ascending or descending. |
| Order By | Field to sort the results by (id, last_modified, arrival, departure). |
| Place ID | Filter reservations by place ID. |
| Status | Filter reservations by status (pending, option, confirmed, checkedin, checkedout, deleted). |
| Type | Type of reservation (e.g., group). |
Output
JSON
id- Unique identifier of the reservation.status- Current status of the reservation.arrival- Arrival date of the reservation.departure- Departure date of the reservation.contact- Contact information associated with the reservation, if requested.invoice_meta- Invoice meta information, if requested.invoice_payment- Invoice payment details, if requested.invoices- Invoice data related to the reservation, if requested.meta- Meta information associated with the reservation, if requested.payment_terms- Payment terms related to the reservation, if requested.rows- Detailed row information of the reservation, if requested.
Dependencies
- Starfish API for CampingCare and HotelCare
- API key credential for authentication
Troubleshooting
- Ensure the API key credential is correctly configured and has necessary permissions.
- Check that the API base URL and endpoints are accessible and correct.
- Verify that date filters use the correct format (YYYY-MM-DD) and operators.
- Pagination limits should not exceed the maximum allowed (30).
- If SSL issues occur, consider enabling the option to ignore SSL certificate validation.
Links
- n8n Expressions - Documentation on how to use expressions in n8n for dynamic input values.
- Starfish API Documentation - Official API documentation for the Starfish CampingCare and HotelCare system (example link).