This is the API powering Omnia 2.0 and Pricemonitor, containing operations that can also be used directly by customers from their own systems.
This is the API powering Omnia 2.0 and Pricemonitor, containing operations that 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.
This API supports both public endpoints for customer integration and internal endpoints for platform management. All endpoints are authenticated using either Basic Authentication or JWT Bearer tokens.
https://api-docs.omniaretail.dev/_mock/api/omnia/
https://api.patagona.de/
Note:
- Internally the system calculates a price recommendation for every domain
- As aggregation the system then provides the cheapest price recommendation
Within the price recommendations we are providing a field called
relevantDomain
. This field contains from which domain the price recommendation originates.
You can get all price recommendations via this operation.
It's a paginated endpoint, so you have to request multiple pages. See pagination. Recommended page size is 1000.
It's important that you define a timerange (by providing startTime
and endTime
parameters) in order to guarantee a stable pagination. This endpoint returns the most recent price recommendations per product and domain: This means that price recommendations from older price calculation runs within the provided timerange are ignored.
Retrieves all price recommendations for a contract within the specified time range.
This endpoint returns algorithmic pricing recommendations based on market analysis, competitor pricing, and configured pricing strategies. Only the most recent recommendations are returned when multiple recommendations exist for the same product.
Key Features:
Start of time range for price recommendation retrieval.
Format: ISO 8601 date-time in UTC (e.g., 2024-01-15T10:30:00Z
)
End of time range for price recommendation retrieval.
Format: ISO 8601 date-time in UTC (e.g., 2024-01-16T10:30:00Z
)
Maximum number of price recommendations to return per page
https://api-docs.omniaretail.dev/_mock/api/omnia/api/2/v/contracts/{contractId}/result/pricerecommendations
https://api.patagona.de/api/2/v/contracts/{contractId}/result/pricerecommendations
curl -i -X GET \
-u <username>:<password> \
'https://api-docs.omniaretail.dev/_mock/api/omnia/api/2/v/contracts/qbcxvb/result/pricerecommendations?endTime=2024-01-16T23%3A59%3A59Z&includeTags=true&limit=100&start=0&startTime=2024-01-15T00%3A00%3A00Z'
Paginated list of price recommendations for the specified time range.
Each recommendation includes the product information, recommended price, delivery costs, position data, and strategy information that determined the recommendation. Only the newest recommendations are returned when multiple exist for the same product.
The timestamp when the price recommendation has been calculated
Additional information on this product
The double value depends on the decimal separator which has been provided during product import.
The integer value of the tag. It's only defined when the stringValue
consists solely of digits.
Absolute percentage how the recommended price changed compared to the oldPrice
e.g. 200 stands for 200% which means the recommended price has doubled
The strategy branch name that calculated the price. This is only filled if the Strategy branch that calculated the price was given a name in the strategy tree. It will have the name that was active at the time the price was calculated (see timestamp)
Max price boundary during the time when the price was calculated
The decisive domain of the price recommendation. It's been determined by the cheapest price recommendation.
Min price boundary during the time when the price was calculated
List of tags which were set during the time when the price has been calculated. ATTENTION: These are historic tags which are maybe outdated or incomplete.
The double value depends on the decimal separator which has been provided during product import.
The integer value of the tag. It's only defined when the stringValue
consists solely of digits.
{ "data": { "recommendations": [ … ], "pagination": { … } } }
https://api-docs.omniaretail.dev/_mock/api/omnia/api/v3/vendor/contracts/{contractId}/products/{productId}/pricerecommendationhistory
https://api.patagona.de/api/v3/vendor/contracts/{contractId}/products/{productId}/pricerecommendationhistory
curl -i -X GET \
-u <username>:<password> \
'https://api-docs.omniaretail.dev/_mock/api/omnia/api/v3/vendor/contracts/qbcxvb/products/862342/pricerecommendationhistory?endDate=2024-01-16T23%3A59%3A59Z&startDate=2024-01-15T00%3A00%3A00Z'
A list of price recommendations
The timestamp when the price recommendation has been calculated
Additional information on this product
The double value depends on the decimal separator which has been provided during product import.
The integer value of the tag. It's only defined when the stringValue
consists solely of digits.
Absolute percentage how the recommended price changed compared to the oldPrice
e.g. 200 stands for 200% which means the recommended price has doubled
The strategy branch name that calculated the price. This is only filled if the Strategy branch that calculated the price was given a name in the strategy tree. It will have the name that was active at the time the price was calculated (see timestamp)
Max price boundary during the time when the price was calculated
The decisive domain of the price recommendation. It's been determined by the cheapest price recommendation.
Min price boundary during the time when the price was calculated
List of tags which were set during the time when the price has been calculated. ATTENTION: These are historic tags which are maybe outdated or incomplete.
The double value depends on the decimal separator which has been provided during product import.
The integer value of the tag. It's only defined when the stringValue
consists solely of digits.
{ "data": [ { … } ] }