Public API
/
Price Recommendations
/
Get price recommendations for one product

Omnia 2.0 API (0.0.7113)

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.

Download OpenAPI description
omnia.json
omnia.yaml
Overview
URL https://www.omniaretail.com/
License Omnia Retail API license
Languages
Servers
Mock server
https://api-docs.omniaretail.dev/_mock/api/omnia/
Production API
https://api.patagona.de/

Overview

Overview, explanation and pointers to the API documentation.

Products Management

Operations to manage your products.

Operations

Price Recommendations

Operations to get price recommendations calculated by our system.

Operations

Price recommendations and multiple domains

Note:

  1. Internally the system calculates a price recommendation for every domain
  2. 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.

Retrieve price recommendations

Getting all price recommendations

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.

Get all price recommendations

Request

Gets all price recommendations for a contract for the specified timerange. Only the newest price recommendations are returned in case of multiple price recommendations per product

Path
contractIdstringrequired

ID of the contract

Example: qbcxvb
Query
startTimestring(date-time)required

Timestamp of start of time range, formatted as ISO Date (i.e. 2018-04-06T13:46:13Z) in UTC

endTimestring(date-time)required

Timestamp of end of time range, formatted as ISO Date (i.e. 2018-04-06T13:46:13Z) in UTC

startinteger(int32)required

Start price-recommendation index for pagination

limitinteger(int32)

Number of price-recommendations for pagination

Default 100
includeTagsboolean

Whether to return tags of products or not.

Default true
curl -i -X GET \
  -u <username>:<password> \
  'https://api-docs.omniaretail.dev/_mock/api/omnia/api/2/v/contracts/qbcxvb/result/pricerecommendations?endTime=2019-08-24T14%3A15%3A22Z&includeTags=true&limit=100&start=0&startTime=2019-08-24T14%3A15%3A22Z'

Responses

A paginated list of price recommendations is returned for the specified timerange. Only the newest price recommendations are returned in case of multiple price recommendations per product.

Bodyapplication/json
dataArray of objects(com.patagona.pricemonitor.share.api.ApiPriceRecommendation)required
data[].​oldPricenumber

The price of the cheapest offer of the own shop(s) on the relevant domain

data[].​deliveryCostsnumber

The delivery costs which were considered for the recommended price

data[].​timestampstring(date-time)required

The timestamp when the price recommendation has been calculated

data[].​oldDeliveryCostsnumber

The delivery costs corresponding to oldPrice

data[].​tagsArray of objects(com.patagona.pricemonitor.share.api.ExtendedTag)required

Additional information on this product

data[].​tags[].​doubleValuenumber

The double value depends on the decimal separator which has been provided during product import.

data[].​tags[].​integerValueinteger

The integer value of the tag. It's only defined when the stringValue consists solely of digits.

data[].​tags[].​labelstringrequired

The name of the tag. It can't be empty.

data[].​tags[].​stringValuestringrequired

The text value of the tag.

data[].​tags[].​booleanValueboolean

The boolean value of the tag. It's only set to true when the stringValue is "1" or "true".

data[].​pricenumberrequired

The recommended price of the relevant domain

data[].​oldPositioninteger

The old position on the relevant domain

data[].​gtinnumber

GTIN of the product

data[].​relativePriceChangePercentagenumber

Absolute percentage how the recommended price changed compared to the oldPrice e.g. 200 stands for 200% which means the recommended price has doubled

data[].​newPositioninteger

The new position on the relevant domain

data[].​decisiveStrategyBranchNamestring

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)

data[].​customerProductIdstring

The customer's id of the product

data[].​originalMaxPriceBoundarynumberrequired

Max price boundary during the time when the price was calculated

data[].​relevantDomainstring

The decisive domain of the price recommendation. It's been determined by the cheapest price recommendation.

data[].​originalMinPriceBoundarynumberrequired

Min price boundary during the time when the price was calculated

data[].​currencystringrequired

The currency of the price recommendation.

data[].​productIdstringrequired

The internal product id of the pricemonitor

data[].​originalTagsArray of objects(com.patagona.pricemonitor.share.api.ExtendedTag)required

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.

data[].​originalTags[].​doubleValuenumber

The double value depends on the decimal separator which has been provided during product import.

data[].​originalTags[].​integerValueinteger

The integer value of the tag. It's only defined when the stringValue consists solely of digits.

data[].​originalTags[].​labelstringrequired

The name of the tag. It can't be empty.

data[].​originalTags[].​stringValuestringrequired

The text value of the tag.

data[].​originalTags[].​booleanValueboolean

The boolean value of the tag. It's only set to true when the stringValue is "1" or "true".

data[].​decisiveStrategyTreeLeafNodeIdintegerrequired

The leaf node of the strategy branch that calculated the price. This id references the node in the strategy branch that was active at the time the price was calculated (see timestamp)

metaobject(com.patagona.pricemonitor.share.api.PaginationResponse)

This model describes the information passed to the user for a paginated request.

Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "nextUrl": "string",
    "totalSize": 0,
    "start": 0,
    "limit": 0
  }
}

Get price recommendations for one product

Request

This endpoint returns all price recommendations for one product within a given time range.

Path
contractIdstringrequired

ID of the contract

Example: qbcxvb
productIdstringrequired

ID of the product in pricemonitor

Example: 862342
Query
startDatestring(date-time)

Timestamp of start of time range, formatted as ISO Date (i.e. 2018-04-06T13:46:13Z) in UTC. If this value is omitted and {endDate} is given, {startDate} is set to {endDate} - 48 hours. If both values are omitted, the range is 'NOW - 48 hours to NOW'.

endDatestring(date-time)

Timestamp of end of time range, formatted as ISO Date (i.e. 2018-04-06T13:46:13Z) in UTC. If this value is omitted and {startDate} is given, {endDate} is set to {startDate} + 48 hours. If both values are omitted, the range is 'NOW - 48 hours to NOW'.

curl -i -X GET \
  -u <username>:<password> \
  'https://api-docs.omniaretail.dev/_mock/api/omnia/api/v3/vendor/contracts/qbcxvb/products/862342/pricerecommendationhistory?endDate=2019-08-24T14%3A15%3A22Z&startDate=2019-08-24T14%3A15%3A22Z'

Responses

A list of price recommendations

Bodyapplication/json
dataArray of objects(com.patagona.pricemonitor.share.api.ApiPriceRecommendation)required
data[].​oldPricenumber

The price of the cheapest offer of the own shop(s) on the relevant domain

data[].​deliveryCostsnumber

The delivery costs which were considered for the recommended price

data[].​timestampstring(date-time)required

The timestamp when the price recommendation has been calculated

data[].​oldDeliveryCostsnumber

The delivery costs corresponding to oldPrice

data[].​tagsArray of objects(com.patagona.pricemonitor.share.api.ExtendedTag)required

Additional information on this product

data[].​tags[].​doubleValuenumber

The double value depends on the decimal separator which has been provided during product import.

data[].​tags[].​integerValueinteger

The integer value of the tag. It's only defined when the stringValue consists solely of digits.

data[].​tags[].​labelstringrequired

The name of the tag. It can't be empty.

data[].​tags[].​stringValuestringrequired

The text value of the tag.

data[].​tags[].​booleanValueboolean

The boolean value of the tag. It's only set to true when the stringValue is "1" or "true".

data[].​pricenumberrequired

The recommended price of the relevant domain

data[].​oldPositioninteger

The old position on the relevant domain

data[].​gtinnumber

GTIN of the product

data[].​relativePriceChangePercentagenumber

Absolute percentage how the recommended price changed compared to the oldPrice e.g. 200 stands for 200% which means the recommended price has doubled

data[].​newPositioninteger

The new position on the relevant domain

data[].​decisiveStrategyBranchNamestring

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)

data[].​customerProductIdstring

The customer's id of the product

data[].​originalMaxPriceBoundarynumberrequired

Max price boundary during the time when the price was calculated

data[].​relevantDomainstring

The decisive domain of the price recommendation. It's been determined by the cheapest price recommendation.

data[].​originalMinPriceBoundarynumberrequired

Min price boundary during the time when the price was calculated

data[].​currencystringrequired

The currency of the price recommendation.

data[].​productIdstringrequired

The internal product id of the pricemonitor

data[].​originalTagsArray of objects(com.patagona.pricemonitor.share.api.ExtendedTag)required

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.

data[].​originalTags[].​doubleValuenumber

The double value depends on the decimal separator which has been provided during product import.

data[].​originalTags[].​integerValueinteger

The integer value of the tag. It's only defined when the stringValue consists solely of digits.

data[].​originalTags[].​labelstringrequired

The name of the tag. It can't be empty.

data[].​originalTags[].​stringValuestringrequired

The text value of the tag.

data[].​originalTags[].​booleanValueboolean

The boolean value of the tag. It's only set to true when the stringValue is "1" or "true".

data[].​decisiveStrategyTreeLeafNodeIdintegerrequired

The leaf node of the strategy branch that calculated the price. This id references the node in the strategy branch that was active at the time the price was calculated (see timestamp)

Response
application/json
{
  "data": [
    { … }
  ]
}

Offers

Operations to get and manage offers.

Operations

Feeds Management

Manage your data-feeds.

Operations

Logs Management

Operations to store log messages in our system.

You could integrate this API in your own system and publish the integration logs to our system so that Omnia Retail could analyze them.

Operations

Company Management

Company management related endpoints.

Operations

Orders Management

Manage your orders.

Operations

Settings Management

Operations to manage the settings of contracts. Only a limited number of these operations are available to customers directly.

Operations

Tasks Management

Operations to view and manage the tasks running in the platform. Customers can only view tasks.

Operations

Strategies Management

Operations to view and manage the pricing strategies.

Operations

Domains

Operations to view all supported domains.

A domain is an external datasource or website that contains information about offers for products for sale. Information like product characteristics and sales characterics like price, stock level and delivery times and costs.

Operations

Plugin Registration

Operations to view registered plugins.

Operations