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 specifically for the Reservations API to retrieve detailed information about a single reservation by its unique ID. It is useful for scenarios where you need to fetch comprehensive reservation data including optional related details such as booker information, co-travelers, contact info, invoice details, payment terms, and meta information. For example, it can be used in travel management systems to display or process reservation details for customer service or billing purposes.
Use Case Examples
- Retrieve a reservation by its ID to display booking details on a customer portal.
- Fetch reservation data including booker and co-travelers information for generating personalized travel itineraries.
- Get invoice and payment details related to a reservation for accounting and reconciliation.
Properties
| Name | Meaning |
|---|---|
| Reservation ID | The unique ID of the reservation you want to retrieve, required to specify which reservation to fetch. |
| Filter Root Meta | Whether to filter root meta information from the reservation data. |
| Get Booker | Whether to include booker details of the reservation. |
| Get Co Travelers | Whether to include co-traveler details of the reservation. |
| Get Contact | Whether to include contact information related to the reservation. |
| Get Invoice Meta | Whether to include invoice meta information. |
| Get Invoice Payments | Whether to include invoice payments related to the reservation. |
| Get Invoice Rowsfilter | Whether to include invoice rows filter of the reservation. |
| Get Invoices | Whether to include invoice data. |
| Get Meta | Whether to include meta information related to the reservation. |
| Get Payment Terms | Whether to include payment terms associated with the reservation. |
| Get Rows | Whether to include detailed row information of the reservation. |
| Request Options | Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration to control the API request behavior. |
Output
JSON
reservation- The detailed reservation data retrieved from the API, including optional related information based on input flags such as booker, co-travelers, invoices, payments, and meta data.
Dependencies
- Requires an API key credential for the Starfish API (CampingCare/HotelCare) to authenticate requests.
Troubleshooting
- Common issues include invalid or missing Reservation ID, resulting in errors or empty responses.
- API authentication errors due to invalid or missing API key credential.
- Timeouts or network errors if the server is unreachable or slow to respond; can be mitigated by adjusting the timeout setting.
- SSL certificate validation errors if the server's SSL certificate is invalid; can be bypassed by enabling the 'Ignore SSL Issues' option, though this is insecure.
- Proxy configuration errors if the proxy settings are incorrect or the proxy requires authentication not provided.
Links
- Starfish API Reservations - Get Reservation - Official documentation for the Reservations API endpoint to retrieve a reservation by ID.