This is the API powering Omnia 2.0 and Pricemonitor, containing operations which can also be used directly by customers from their own systems.
This is the API powering Omnia 2.0 and Pricemonitor, containing operations which can also be used directly by customers from their own systems.
The Omnia 2.0 API is RESTful and provides access to the backend of Omnia 2.0 and Pricemonitor. It is used to manage products, offers, contracts and more.
The Omnia 2.0 API (also known as the Pricemonitor API) gives access to the superpowers behind the Omnia Retail platform.
The Omnia 2.0 app and the Pricemonitor app are the main consumers of this API, but we also have endpoints available to customers to integrate the API directly with their own systems.
These are the common API operations for customers to integrate Omnia with their own systems:
Use this operation to retrieve the newest offers in the market for products for a given time range. It supports returning paged results. We recommend to retrieve with a page size of at most 1,000 products.
Use this operation to retrieve the price recommendations for all products for a specified timerange. It supports returning paged results.
Use this operation to retrieve products via a query. It supports returning paged results. We recommend to retrieve with a page size of 10,000 products.
API endpoints can potentially return a lot of items. Returning all data as one response to one request can overload the server, the database or the client. Returning all items may even be unnecessary when the client is only interested in the top N entries. So API operations that could return a lot of data support pagination. The pagination approach used in the latest version of API operations is described here.
Operations that support pagination:
data object within the response.There are no subsequent matching items if the number of items in a response is smaller than the requested limit.
This parameter defines how many items are returned at most in a singe response. This is also called the page size.
The API documentation states the range that is allowed to be specified by the client.
This parameter defines from which item in the total result set this request wants data to be returned. It basically defines what page should be returned. The index of the first item is 0. If the value of start is beyond the number of matching items, an empty data array is returned in the response.
Pagination itself only works when the entries have a stable sorting. This is the responsibility of the API.
The API supports two authentication methods with distinct use cases: basic authentication and JWT bearer token authentication. For more details see below.
In short: for API integration with other systems or to explore the API, use basic authentication.
Security Scheme Type: HTTP
HTTP Authorization Scheme basicUsed for:
The API password is:
Note: For Omnia 2.0 users the API password is a different password than what is used for interactive logon to the web application. Also Single-Sign On users can generate an API password via the API access feature in Omnia 2.0.