| Capability | Purpose |
|---|---|
| Inventory (Property Content) Population | Initial load of property content (titles, descriptions, facilities, amenities, etc.) into the partner's database |
| Inventory (Property Content) Sync | Keep locally stored property content up to date with Holidu |
| Future Availabilities & Pricing Storage | Maintain future availability and pricing data locally via the Push API — enables partner-owned ranking |
| Partner-Owned Search with Availability Confirmation | Partner-owned search logic with real-time availability confirmation via /availabilities |
| Real-Time Search Using Holidu Ranking | Live search without storing availability & pricing locally, using Holidu's ranking |
Partners manage different types of data, property content, availability, and pricing, within their own systems, and can combine the endpoints below in different ways depending on how much data they store locally versus fetch in real-time. Each section describes a distinct capability.
Inventory (Property Content) Population
Obtaining property content data from the provided inventory.
Used to populate the partner's local database with property content (titles, descriptions, facilities, amenities, images, reviews, etc.) from Holidu.
Steps:
- Call the /changed endpoint to acquire the apartmentIds (according to inventory restrictions: region, property type, etc.)
- Call the /search endpoint (without dates) to acquire all properties' list-page data
- Call the /details endpoint to acquire all properties' enriched data (reviews, etc.)
📌 Note: Partners should decide whether to call /search, /details, or both, based on their content needs. If only list-page data is required, /search alone may be sufficient. If enriched data (reviews etc.) is needed, /details should also be called.
Inventory (Property Content) Sync
Updating existing property content data.
Used to keep the partner's local property content current with Holidu's system over time.
Steps:
- Call the /changed endpoint with request paramter DOCUMENT_UPDATE to identify updated apartmentIds
- Call the /search endpoint to update all properties' list-page data
- Call the /details endpoint to update all properties' enriched data
📌 Note: As with Property Content Population, partners should choose between /search, /details, or both depending on which content they maintain locally and need to keep in sync.
Future Availabilities & Pricing Storage
When the partner wants to store upcoming future availabilities and pricing information on their end.
Steps:
- Partner implements the Push API — Holidu pushes all incoming LOS (Length of Stay) data for an apartment whenever it changes on the Holidu system
- Partner's database stays current through these regular push updates
⚠️ Important: The /availabilities endpoint should never be used to cache upcoming prices and availabilities for an apartment. The calendar should be built from the pushed LOS data.
Outcome: From Push API partner has up-to-date future availability and pricing data locally, enabling them to build their own calendar and have full picture for upcoming prices and availability.
Partner-Owned Search with Availability Confirmation
When the partner stores static apartment data and future availabilities/pricing on their end — what to do at real-time search.
This phase combines the outputs of previous phases into a complete real-time search flow.
Steps:
- Partner fetches all apartment-related information from their own database (matching search criteria, filters, applying their own ranking and sorting, etc.)
- At search time, the partner calls the /availabilities endpoint with the set of apartments that appear available on their end (acquired from the Push API)
- Definite availabilities are confirmed before showing final results to the user
Outcome: Partner delivers fast, custom-ranked search results with confirmed availabilities — combining the best of local data and real-time accuracy.
Real-Time Search Using Holidu Ranking
A search flow designed for partners who do not want to store any availability and pricing data, and prefer to use Holidu's ranking and search logic — e.g. injecting Holidu offers at the end of their page.
Steps:
- The partner calls the /search endpoint in real-time, with or without search dates.
- For undated searches, the endpoint returns matching properties with reference prices, ordered by Holidu's ranking.
- For dated searches, the endpoint returns only the available offers that match the search criteria, along with their exact prices, ordered by Holidu's ranking.
📌 Note: The /search endpoint accepts filters, so amenity-filtered searches are supported. To enable this, the list of existing amenities will be provided to the customer.
