Public API
/
Domains

Omnia 2.0 API (0.0.7097)

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

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

Get a list of all available domains (V3)

Request

This endpoint provides all domains which are supported by our system. Along with other attributes we are providing the corresponding possible offer sources. Only domains which include the offer source DEFAULT_MONITORING are supported out-of-the-box by our monitoring pipeline.

curl -i -X GET \
  -u <username>:<password> \
  https://api-docs.omniaretail.dev/_mock/api/omnia/api/v3/domains

Responses

A list of domains

Bodyapplication/json
dataobject(com.patagona.pricemonitor.share.api.GetAllDomainsV3)required

Response body containing domain data

data.​domainsArray of objectsrequired

Sequence of domain data

data.​domains[].​domainstringrequired

domain url

data.​domains[].​domainIdnumberrequired

internal domain id

data.​domains[].​offerSourcesArray of stringsuniquerequired

list of offerSources for the domain OfferSource: Describes the origin of the offers. Domain may have more than one offer sources. Here are the possible offer sources: DEFAULT_MONITORING Offers - which are gathered via the monitoring-pipeline by a standard product search. This is typically done via GTIN. CUSTOM_MONITORING Offers - which are gathered via the monitoring-pipeline by a customized search. For instance via tags. OMNIA_CUSTOM_SPIDERING Offers - which originate from omnia custom spidering sources. The domain needs to be prefixed with "omnia.custom.spidering.". PUSH_API Offers - which originate from services where we have a direct API connection and get informed about offer changes. Example: Offers from Amazon-Repricer OTHER Offers - which originate from other sources e.g. Scripts which publish offers

data.​domains[].​namestringrequired

display name for the domain

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

Plugin Registration

Operations to view registered plugins.

Operations