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 offer-index
AI-generatedOverview
This node interacts with the Apaleo API to retrieve an index of offers based on specified criteria. It is useful for scenarios where users need to fetch available offers within a date range for a particular rate plan and channel, such as in hotel or accommodation booking systems. For example, a user can query offers available from a start date to an end date, filtered by channel code and rate plan ID, to display available booking options.
Use Case Examples
- Fetch all offers for a specific rate plan between two dates to display on a booking website.
- Retrieve offers from a particular channel like Booking.com or Expedia to synchronize availability.
Properties
| Name | Meaning |
|---|---|
| Channel Code | The channel code to filter offers by the distribution channel, e.g., Direct, Booking.com, Expedia. |
| Rate Plan ID | The identifier of the rate plan for which offers are being retrieved. |
| From | The start date in ISO8601 format to filter offers from. |
| To | The end date in ISO8601 format to filter offers to. |
| Additional Fields | Optional additional parameters to refine the offer query, including children ages, inclusion of unavailable offers, pagination, time slice template, promo code, and corporate code. |
Output
JSON
offerId- Unique identifier of the offer.ratePlanId- Identifier of the associated rate plan.channelCode- Code of the channel through which the offer is available.startDate- Start date of the offer availability.endDate- End date of the offer availability.price- Price details of the offer.availability- Availability status of the offer.
Dependencies
- Apaleo API access token credential
Troubleshooting
- Common issues include invalid or expired API access tokens, which result in authentication errors. Ensure the API credentials are correctly configured and valid.
- Incorrect date formats for 'From' and 'To' fields can cause request failures. Use ISO8601 date format.
- Pagination parameters (Page Number and Page Size) must be within valid ranges to avoid errors.
- If the channel code or rate plan ID is incorrect or does not exist, the API may return empty results or errors.
Links
- Apaleo API Offer Index Documentation - Official documentation for the Apaleo API offer index endpoint.