Public API
/
Domains
/
Get all available domains

Omnia 2.0 API (0.0.7168)

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.

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 the system.

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

Operations

Company Management

Operations for managing company entities, including creation, retrieval, and contract management.

Operations

Orders Management

Operations for managing orders, including bulk order imports and order tracking.

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 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 all available domains

Request

Retrieves all domains supported by the system for market data collection.

Each domain includes:

  • Available offer sources for market data collection
  • Configuration parameters

Note: Only domains with the DEFAULT_MONITORING offer source are supported out-of-the-box by the monitoring pipeline.

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

Responses

List of all supported domains with their configurations

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": [
    { … },
    { … }
  ]
}

Plugin Registration

Operations to view and manage registered plugins for system integration.

Operations