Actions66
- Block Actions
- Block Action Actions
- Booking Actions
- Group Actions
- Offer Actions
- Payment Account Actions
- Payment Account Action Actions
- Reservation Actions
- Reservation Action Actions
- Types Actions
- Folio Actions
- Folio Action Actions
Offer → GET rate-plan-offers
AI-generatedOverview
This node operation fetches rate plan offers from the Apaleo API based on specified parameters such as arrival and departure dates, number of adults, and rate plan ID. It is useful for retrieving available rate plans for accommodation bookings within a given date range and occupancy, optionally filtered by channel code and other additional fields like children ages, promo codes, or pagination settings. Practical examples include integrating hotel booking systems to display available rate plans to customers or automating offer retrieval for travel platforms.
Use Case Examples
- Retrieve rate plan offers for a hotel between specific arrival and departure dates for 2 adults.
- Fetch rate plan offers including unavailable ones by setting the includeUnavailable flag.
- Get paginated rate plan offers with a specific promo code applied.
Properties
| Name | Meaning |
|---|---|
| Arrival | Date and optional time of arrival in ISO8601 format, used to specify the start date for the rate plan offer search. |
| Departure | Date and optional time of departure in ISO8601 format, used to specify the end date for the rate plan offer search. |
| Adults | The number of adults for whom the rate plan offers are being requested. |
| Channel Code | The channel code representing the booking channel, such as Direct, Booking.com, Expedia, etc., used to filter offers by channel. |
| Rate Plan ID | The unique identifier of the rate plan for which offers are being requested. |
| Additional Fields | Optional additional parameters to refine the offer search, including children ages, inclusion of unavailable offers, pagination, time slice template, promo code, and corporate code. |
Output
JSON
offers- Array of rate plan offers matching the search criteria, including details such as pricing, availability, and conditions.
Dependencies
- Apaleo API access token credential
Troubleshooting
- Ensure the arrival and departure dates are in valid ISO8601 format to avoid request errors.
- Verify that the ratePlanId is correct and exists in the Apaleo system to get valid offers.
- If no offers are returned, check the channelCode and additional fields filters to ensure they match available data.
- Handle API rate limits or authentication errors by verifying the API access token and credentials configuration.
Links
- Apaleo API Documentation - Get Rate Plan Offers - Official documentation for the Apaleo API endpoint to retrieve rate plan offers.