Products
Explore our content
Was this helpful?
Explore our content
Was this helpful?
Manage and retrieve all your products.
View your inventory.
Get tax information.
Extensive search and filter.
Retrieve availability and capacity.
Get product ratings and reviews.
In most cases, this content is periodically cached on the partner end, but these API endpoints are also optimized for direct front-end use.
Retrieve a list of all available product locations linked to your account.
Locations represent physical or virtual places where products (such as tickets or experiences) are offered. These can include cities, landmarks, or specific venues, and help in organizing and filtering products geographically.
[FILTER] on distributor_id
.
501
[FILTER] on product_id
.
PRODUCT_ID_123
[PAGING] Items Per Page - Allows user's to configure the items_per_page
value. For example, to load 100 items per page, the developer may point the user to a url with the query string ?items_per_page=100.
This parameter is mainly usefull to manage response times, higher values result in longer response times and therefore it is recommended to keep this value as low as possible. We do allow to adjust this value so it can be used to batch/cache/update inventory at once.
Clients should anticipate that the value of this parameter may not be honored by the API, and should rely exclusively on the contents of the items_per_page
response element in calculating actual page size.
10
Example: 5
[PAGING] Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?start_index=200.
1
Example: 1
[PAGING] Page-based paging - Allows user's to jump directly to a specific page within the items.
This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The page_index
and total_pages
properties are used for this style of paging.
1
Example: 1
[CACHE] The If-Modified-Since
request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date.
If the resource has not been modified since, the response will be a 304 without any body; the Last-Modified
response header of a previous request will contain the date of last modification.
Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.
Wed, 21 Jan 2022 07:28:00 GMT
Retrieve a list of all available product destinations linked to your account.
Destinations are high-level geographic or thematic groupings, such as cities, regions, or popular areas, used to categorize and organize products. They help users discover experiences based on broader travel intents or well-known travel hubs.
[FILTER] on distributor_id
.
501
Destination IDs.
["4"]
[PAGING] Items Per Page - Allows user's to configure the items_per_page
value. For example, to load 100 items per page, the developer may point the user to a url with the query string ?items_per_page=100.
This parameter is mainly usefull to manage response times, higher values result in longer response times and therefore it is recommended to keep this value as low as possible. We do allow to adjust this value so it can be used to batch/cache/update inventory at once.
Clients should anticipate that the value of this parameter may not be honored by the API, and should rely exclusively on the contents of the items_per_page
response element in calculating actual page size.
10
Example: 5
[PAGING] Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?start_index=200.
1
Example: 1
[PAGING] Page-based paging - Allows user's to jump directly to a specific page within the items.
This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The page_index
and total_pages
properties are used for this style of paging.
1
Example: 1
[CACHE] The If-Modified-Since
request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date.
If the resource has not been modified since, the response will be a 304 without any body; the Last-Modified
response header of a previous request will contain the date of last modification.
Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.
Wed, 21 Jan 2022 07:28:00 GMT
Retrieve a list of all available product categories associated with your account.
Categories represent thematic groupings, such as "Museums", "Tours", or "Outdoor Activities", used to classify products based on the type of experience they offer. They support intuitive browsing, filtering, and product discovery.
[FILTER] on distributor_id
.
501
Category IDs.
["4"]
[CACHE] The If-Modified-Since
request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date.
If the resource has not been modified since, the response will be a 304 without any body; the Last-Modified
response header of a previous request will contain the date of last modification.
Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.
Wed, 21 Jan 2022 07:28:00 GMT
Retrieve product recommendations tailored to enhance user experience.
Recommendations help suggest related or popular products, often based on business rules, location, or user behavior.
[FILTER] on distributor_id
.
501
[CACHE] The If-Modified-Since
request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date.
If the resource has not been modified since, the response will be a 304 without any body; the Last-Modified
response header of a previous request will contain the date of last modification.
Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.
Wed, 21 Jan 2022 07:28:00 GMT
Retrieve all available routes associated with your account.
Routes define the transportation or itinerary structure of a product, typically used in activities like hop-on hop-off buses, boat tours, or guided trips with fixed paths.
[FILTER] on distributor_id
.
501
[FILTER] on product_id
.
PRODUCT_ID_123
[PAGING] Items Per Page - Allows user's to configure the items_per_page
value. For example, to load 100 items per page, the developer may point the user to a url with the query string ?items_per_page=100.
This parameter is mainly usefull to manage response times, higher values result in longer response times and therefore it is recommended to keep this value as low as possible. We do allow to adjust this value so it can be used to batch/cache/update inventory at once.
Clients should anticipate that the value of this parameter may not be honored by the API, and should rely exclusively on the contents of the items_per_page
response element in calculating actual page size.
10
Example: 5
[PAGING] Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?start_index=200.
1
Example: 1
[PAGING] Page-based paging - Allows user's to jump directly to a specific page within the items.
This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The page_index
and total_pages
properties are used for this style of paging.
1
Example: 1
[CACHE] The If-Modified-Since
request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date.
If the resource has not been modified since, the response will be a 304 without any body; the Last-Modified
response header of a previous request will contain the date of last modification.
Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.
Wed, 21 Jan 2022 07:28:00 GMT
This API returns all the currency rates on a daily basis.
[FILTER] on currency_date
.
[CACHE] The If-Modified-Since
request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date.
If the resource has not been modified since, the response will be a 304 without any body; the Last-Modified
response header of a previous request will contain the date of last modification.
Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.
Wed, 21 Jan 2022 07:28:00 GMT
Retrieve tax configurations applicable to your products.
Taxes can be region-specific and vary by product type, helping ensure accurate pricing and compliance.
[FILTER] on distributor_id
.
501
[FILTER] on product_id
.
PRODUCT_ID_123
Country or State of the related tax authority.
India
[PAGING] Items Per Page - Allows user's to configure the items_per_page
value. For example, to load 100 items per page, the developer may point the user to a url with the query string ?items_per_page=100.
This parameter is mainly usefull to manage response times, higher values result in longer response times and therefore it is recommended to keep this value as low as possible. We do allow to adjust this value so it can be used to batch/cache/update inventory at once.
Clients should anticipate that the value of this parameter may not be honored by the API, and should rely exclusively on the contents of the items_per_page
response element in calculating actual page size.
10
Example: 5
[PAGING] Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?start_index=200.
1
Example: 1
[PAGING] Page-based paging - Allows user's to jump directly to a specific page within the items.
This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The page_index
and total_pages
properties are used for this style of paging.
1
Example: 1
[CACHE] The If-Modified-Since
request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date.
If the resource has not been modified since, the response will be a 304 without any body; the Last-Modified
response header of a previous request will contain the date of last modification.
Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.
Wed, 21 Jan 2022 07:28:00 GMT
Retrieve a comprehensive list of all products available via your distributor account. Each product includes core metadata like title, description, availability, and configuration details. Extensive filtering is available but do note that certain filters might affect performance.
By default only the latest revision will be returned.
[FILTER] on distributor_id
.
501
[CONFIG] content language to return in the response.
Languages are defined in ISO-639-1 format. If the defined language is not available, the product will be returned in the product_default_language
.
en
[FILTER] on product content.
Searches the fields:
product_id
(Upcoming)product_title
product_short_description
product_long_description
product_supplier_name
product_highlights
product_includes
Regex used: '(?is)^(?=.\b(query1.)\b)(?=.\b(query2.)\b).*'
tour museum amsterdam
[FILTER] on product_start_date
.
[FILTER] on product_end_date
.
[FILTER] on product_duration
. (Minutes)
90
[FILTER] on product_booking_quantity_min
.
1
[FILTER] on product_booking_quantity_max
.
3
[FILTER] on product_id
.
["PRODUCT_ID_123"]
[FILTER] on product_supplier_id
.
["PRODUCT_SUPPLIER_ID"]
[FILTER] on product_reseller_id
.
["PRODUCT_RESELLER_ID"]
[FILTER] on categories (category_id
).
["PRODUCT_CATEGORY_ID_123"]
[FILTER] on destinations (destination_id
).
["PRODUCT_DESTINATION_ID_123"]
[FILTER] on Tag.
Combination of product_tag_id
, product_tag_description
and product_tag_group
.
["PRODUCT_TAG"]
[FILTER] on available product languages.
Languages are defined in ISO-639-1 format.
Products without a language value will not be returned.
["en"]
[FILTER] on location_id
.
["PRODUCT_LOCATION_ID"]
[FILTER] on country ( ISO-3166-1 alpha-2).
["NL"]
[FILTER] on Product Currency Code, according to ISO-4217.
["EUR"]
[FILTER] Include products with capacity (product_availability:true
).
true
Example: true
[FILTER] Return product_favorite:true
only.
true
[FILTER] on an astronomical body. (Reserved for future use)
EARTH
Possible values: [FILTER] on products modified after the given date.
For caching purposes we recommend using the If-Modified-Since
header instead.
[SEARCH] on keywords.
This API provides full-text (wildcard) search capabilities.
Only results linked to your account will be returned and searching is only available in case cache is enabled (cache:true
)
[CONFIG] (ADVANCED) account view type.
This value defaults and is limited to the scope of your credentials.
DISTRIBUTOR
Possible values: Method of sorting.
PRODUCT_MODIFIED
Example: PRODUCT_CREATED
Possible values: Order of sorting.
DESC
Example: ASC
Possible values: [PAGING] Items Per Page - Allows user's to configure the items_per_page
value. For example, to load 100 items per page, the developer may point the user to a url with the query string ?items_per_page=100.
This parameter is mainly usefull to manage response times, higher values result in longer response times and therefore it is recommended to keep this value as low as possible. We do allow to adjust this value so it can be used to batch/cache/update inventory at once.
Clients should anticipate that the value of this parameter may not be honored by the API, and should rely exclusively on the contents of the items_per_page
response element in calculating actual page size.
10
Example: 5
[PAGING] Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?start_index=200.
1
Example: 1
[PAGING] Page-based paging - Allows user's to jump directly to a specific page within the items.
This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The page_index
and total_pages
properties are used for this style of paging.
1
Example: 1
[CACHE] Whether the results should be loaded from the caching server. This will significantly improve performance and disabling this functionality is not recommended.
true
Example: true
[CACHE] The If-Modified-Since
request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date.
If the resource has not been modified since, the response will be a 304 without any body; the Last-Modified
response header of a previous request will contain the date of last modification.
Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.
Wed, 21 Jan 2022 07:28:00 GMT
This API provides all the product information that is available in the Prio system for the requested product (product_id
).
Unique identifier for the product assigned by Prio.
PRODUCT_ID_123
[FILTER] on distributor_id
.
501
Language code to request language specific product data. If left empty or language is not available (not included in product_content_languages
), the response will be in the default language i.e. English. The actual language returned can also be found inside the Content-Language
header.
en
[CACHE] Whether the results should be loaded from the caching server. This will significantly improve performance and disabling this functionality is not recommended.
true
Example: true
[CACHE] The If-Modified-Since
request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date.
If the resource has not been modified since, the response will be a 304 without any body; the Last-Modified
response header of a previous request will contain the date of last modification.
Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.
Wed, 21 Jan 2022 07:28:00 GMT
The availability API is used to make sure that the product or service is available on the desired date and time slot.
Depending on the product_availability
parameter given in the product feed, the availability needs to be requested using this endpoint prior to making a booking.
This endpoint should be called in order to get up-to-date availability information for a product with managed capacity. The response will contain the availability for each time slot of the requested product that lies within the specified date range.Availability Logic* Please consult our dedicated "Availability" section for more information on how to use this endpoint.
Caching Recommendations
Please consult our dedicated "Caching" section for more information on how to use this endpoint.
Notes
Dates and times are always relative to the supplier timezone and all offsets are automatically adjusted based on daylight saving time (DST).
A maximum of 90 days is allowed. If you would like to batch availability for a longer period, please make multiple calls.
Unique identifier for the product assigned by Prio.
[FILTER] on distributor_id
.
501
[FILTER] From which date availability is requested.
If supplied with to_date
, then availability request is for a date range.
If supplied without to_date
, then for a single date availability is requested.
[FILTER] Till which date availability is requested.
If this is empty, availability will be searched for the given from_date
only.
[FILTER] Include disabled / closed (availability_active:false
) entries.
false
Example: true
[FILTER] on availability_capacity_id
.
[FILTER] The minimum remaining availability_spots_open
.
[FILTER] The iteration depth of the included entries of the sub-products in the response. This will not apply to sub-products which have shared capacity linked to the main product.
Example Setup:
Product 101 (Main)
Product 201 (Sub)
Product 301 (Nested)
Product 302 (Nested)
Product 202 (Sub)
Product 401 (Nested)
Product 402 (Nested)
sub_products_depth:0
will return Product 101.sub_products_depth:1
will return Product 101, 201 and 202.sub_products_depth:2
will return Product 101, 201, 202, 301, 302, 401 and 402.0
Example: 1
[FILTER] Only show entries modified after the given date.
Fetch incremental updates through this endpoint.
[CACHE] The If-Modified-Since
request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date.
If the resource has not been modified since, the response will be a 304 without any body; the Last-Modified
response header of a previous request will contain the date of last modification.
Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.
Wed, 21 Jan 2022 07:28:00 GMT