slug.
Available Endpoints
Get Many Store Items
Retrieve a list of items for a specific store.
Get One Store Item
Retrieve details for a specific item within a store.
Data Structure
Every item returned by the API follows theStore Item structure, which includes the following key sections:
Information (infos)
Contains the localized name and description of the item. Use the lang query parameter to control the output language.
Media (media)
Provides access to visual and technical resources:
- Images: URLs for the item’s photo gallery.
- Videos: YouTube URLs for product demonstrations.
- Documents: Technical manuals or terms of service.
Pricing (pricing)
Pricing is dynamically calculated based on the provided date range (from/to):
price: The final price the customer will pay (including discounts).basePrice: The original price before any discounts.appliedDiscounts: Details of any discounts currently affecting the price.basis: Indicates if the price is theLOWEST_PRICEavailable orRANGE_COMPUTEDfor your specific dates.
Availability & Stock (stock)
The stock.quantity field tells you how many units of the item are available for the selected period.
Time Constraints (time)
Defines the min and max duration allowed for renting the item, and the predefined time ranges with associated prices.
Modules (modules)
Contains settings for optional features, such as insurance (e.g., Tulip provider details) if enabled for the item.
Verticales & Categories
To help users find specific types of items, you can filter results using the following parameters:- verticale: Filter by the top-level sector (e.g.,
BIKE,CAR). - verticaleCategoryIds: Filter by one or more specific category IDs (e.g., Mountain Bike, Electric Bike).
Categories Documentation
Learn how to explore the hierarchy of verticales and categories.
Date Range Filtering
When querying items, providing thefrom and to date parameters is highly recommended.
If these dates are missing:
- Pricing: You will receive the “starting from” price (lowest available).
- Stock: The response will show the maximum theoretical stock, but not the actual availability for a specific booking.
Common Values
Language (lang)
Supported languages:fr, en, nl, de, it, pt, es, pl. Defaults to fr.
Item Type
product: Physical items with limited stock.service: Services or items with unlimited stock.
Rental Type
LCD: Short-term rental (hourly, daily).LLD: Long-term rental (monthly subscriptions).