Skip to content
Public API
/
/
Retrieve all feed-entries...

Omnia 2.0 API (0.0.7390)

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

Get all feeds

Request

Feeds can contain offer-related information such as price recommendations. They can be configured to match individual demands.

Security
BasicAuth or BearerAuth
Path
contractIdstringnon-emptyrequired

Unique identifier of the contract

Example: qbcxvb
curl -i -X GET \
  -u <username>:<password> \
  https://api-docs.omniaretail.dev/_mock/api/omnia/api/2/v/contracts/qbcxvb/feeds

Responses

No response was specified

Bodyapplication/jsonArray [
contractIdstring
csvDecimalSeparatorstring
csvSeparatorstring
deltaUrlstring
fieldsArray of objects
formatstring
idstring
lastAccessedstring(date-time)
lastDeletionstring(date-time)
namestring
urlstring
versioninteger(int64)
]
Response
application/json
[
  {
    "contractId": "string",
    "csvDecimalSeparator": "string",
    "csvSeparator": "string",
    "deltaUrl": "string",
    "fields": [ … ],
    "format": "string",
    "id": "string",
    "lastAccessed": "2019-08-24T14:15:22Z",
    "lastDeletion": "2019-08-24T14:15:22Z",
    "name": "string",
    "url": "string",
    "version": 0
  }
]

Find feed by ID

Request

A feed can contain offer-related information such as price recommendations. Feeds can be configured to match individual demands.

Security
BasicAuth or BearerAuth
Path
contractIdstringnon-emptyrequired

Unique identifier of the contract

Example: qbcxvb
feedIdstringrequired

ID of the feed

curl -i -X GET \
  -u <username>:<password> \
  'https://api-docs.omniaretail.dev/_mock/api/omnia/api/2/v/contracts/qbcxvb/feeds/{feedId}'

Responses

No response was specified

Bodyapplication/json
contractIdstring
csvDecimalSeparatorstring
csvSeparatorstring
deltaUrlstring
fieldsArray of objects
formatstring
idstring
lastAccessedstring(date-time)
lastDeletionstring(date-time)
namestring
urlstring
versioninteger(int64)
Response
application/json
{
  "contractId": "string",
  "csvDecimalSeparator": "string",
  "csvSeparator": "string",
  "deltaUrl": "string",
  "fields": [
    { … }
  ],
  "format": "string",
  "id": "string",
  "lastAccessed": "2019-08-24T14:15:22Z",
  "lastDeletion": "2019-08-24T14:15:22Z",
  "name": "string",
  "url": "string",
  "version": 0
}

Dismiss already fetched feed-entries

Request

Dismiss already fetched feed-entries, so they will not be part of future responses.

Security
BasicAuth or BearerAuth
Path
contractIdstringnon-emptyrequired

Unique identifier of the contract

Example: qbcxvb
feedIdstringrequired

ID of the feed

curl -i -X DELETE \
  -u <username>:<password> \
  'https://api-docs.omniaretail.dev/_mock/api/omnia/api/2/v/contracts/qbcxvb/feeds/{feedId}/export/delta'

Responses

No response was specified

Bodyapplication/json
contractIdstring
csvDecimalSeparatorstring
csvSeparatorstring
deltaUrlstring
fieldsArray of objects
formatstring
idstring
lastAccessedstring(date-time)
lastDeletionstring(date-time)
namestring
urlstring
versioninteger(int64)
Response
application/json
{
  "contractId": "string",
  "csvDecimalSeparator": "string",
  "csvSeparator": "string",
  "deltaUrl": "string",
  "fields": [
    { … }
  ],
  "format": "string",
  "id": "string",
  "lastAccessed": "2019-08-24T14:15:22Z",
  "lastDeletion": "2019-08-24T14:15:22Z",
  "name": "string",
  "url": "string",
  "version": 0
}

Retrieve all feed-entries after last request

Request

In contrast of normal feeds, feed-deltas return only results, that are new since the last (DELETE-)request.

Security
BasicAuth or BearerAuth
Path
contractIdstringnon-emptyrequired

Unique identifier of the contract

Example: qbcxvb
feedIdstringrequired

ID of the feed

fileNamestringrequired

fileName

Default "my-feed.csv"
curl -i -X GET \
  -u <username>:<password> \
  'https://api-docs.omniaretail.dev/_mock/api/omnia/api/2/v/contracts/qbcxvb/feeds/{feedId}/export/delta/{fileName}'

Responses

No response was specified

Body
contractIdstring
csvDecimalSeparatorstring
csvSeparatorstring
deltaUrlstring
fieldsArray of objects
formatstring
idstring
lastAccessedstring(date-time)
lastDeletionstring(date-time)
namestring
urlstring
versioninteger(int64)
Response
{
  "contractId": "string",
  "csvDecimalSeparator": "string",
  "csvSeparator": "string",
  "deltaUrl": "string",
  "fields": [
    { … }
  ],
  "format": "string",
  "id": "string",
  "lastAccessed": "2019-08-24T14:15:22Z",
  "lastDeletion": "2019-08-24T14:15:22Z",
  "name": "string",
  "url": "string",
  "version": 0
}

Export feed data

Request

Downloads a file containing all the data from the specified feed.

Feeds are price recommendation centric and can be enriched with offer or product information. The export format (JSON or CSV) is determined by the request's Accept header.

Security
BasicAuth or BearerAuth
Path
contractIdstringnon-emptyrequired

Unique identifier of the contract

Example: qbcxvb
feedIdstringrequired

ID of the feed

fileNamestringrequired

fileName

Default "my-feed.csv"
curl -i -X GET \
  -u <username>:<password> \
  'https://api-docs.omniaretail.dev/_mock/api/omnia/api/2/v/contracts/qbcxvb/feeds/{feedId}/export/{fileName}'

Responses

Feed data export retrieved successfully

Body
contractIdstring
csvDecimalSeparatorstring
csvSeparatorstring
deltaUrlstring
fieldsArray of objects
formatstring
idstring
lastAccessedstring(date-time)
lastDeletionstring(date-time)
namestring
urlstring
versioninteger(int64)
Response
{
  "contractId": "string",
  "csvDecimalSeparator": "string",
  "csvSeparator": "string",
  "deltaUrl": "string",
  "fields": [
    { … }
  ],
  "format": "string",
  "id": "string",
  "lastAccessed": "2019-08-24T14:15:22Z",
  "lastDeletion": "2019-08-24T14:15:22Z",
  "name": "string",
  "url": "string",
  "version": 0
}

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

Plugin Registration

Operations to view and manage registered plugins for system integration.

Operations