Public API
/
Tasks Management
/
Price calculation tasks
/
Successful task

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

What tasks are

Tasks are asynchronously handled jobs in our system, like price calculation or monitoring jobs.

You can use this operation to find tasks for a contract.

Price calculation tasks

A use case for the find tasks operation is to get the most recent completed price calculation task to see if it was successful or failed. And if it failed, what the failures were.

Example Responses

Successful task

Click to expand
{
  "state":"succeeded",
  "data":{
    "startTimestamp":"2023-05-08T14:40:00.213Z"
  },
  "result":{
    "operations":{
      "successful":28444,
      "failed":0,
      "total":28444
    }
  },
  "contractId":"gj8qu6",
  "failures":[

  ],
  "creationDate":"2023-05-08T15:41:46.545Z",
  "taskType":"backend.tasks.pricemonitor.offers.preprocessing",
  "finishDate":"2023-05-08T15:44:58.853Z",
  "userId":2156,
  "startDate":"2023-05-08T15:41:46.555Z",
  "taskId":"gj8qu6:1e318eee-3217-4ee7-a380-c6312935dcd1"
}

Successful task with failures for some products

Click to expand
{
  "state":"succeeded",
  "data":{
    "startTimestamp":"2023-05-07T10:05:00.230Z"
  },
  "result":{
    "operations":{
      "successful":2737,
      "failed":24,
      "total":2761
    }
  },
  "contractId":"f8kfq5",
  "failures":[
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282163",
        "exceptionMessage":"Can't modify min price to 21.6 since it violates the current boundary PriceBoundary(24.00,24.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57316814",
        "exceptionMessage":"Can't modify min price to 35.1 since it violates the current boundary PriceBoundary(35.15,39.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282223",
        "exceptionMessage":"Can't modify min price to 35.1 since it violates the current boundary PriceBoundary(35.15,39.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282324",
        "exceptionMessage":"Can't modify min price to 31.5 since it violates the current boundary PriceBoundary(32.18,35.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282861",
        "exceptionMessage":"Can't modify min price to 35.1 since it violates the current boundary PriceBoundary(35.15,39.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282118",
        "exceptionMessage":"Can't modify min price to 26.1 since it violates the current boundary PriceBoundary(27.73,29.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282152",
        "exceptionMessage":"Can't modify min price to 35.1 since it violates the current boundary PriceBoundary(35.15,39.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57316468",
        "exceptionMessage":"Can't modify min price to 521.1 since it violates the current boundary PriceBoundary(529.00,579.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282300",
        "exceptionMessage":"Can't modify min price to 4769.1 since it violates the current boundary PriceBoundary(4916.84,5299.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57317261",
        "exceptionMessage":"Can't modify min price to 125.10000000000001 since it violates the current boundary PriceBoundary(129.00,139.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282345",
        "exceptionMessage":"Can't modify min price to 1205.1000000000001 since it violates the current boundary PriceBoundary(1299.00,1339.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282464",
        "exceptionMessage":"Can't modify min price to 152.1 since it violates the current boundary PriceBoundary(162.84,169.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282168",
        "exceptionMessage":"Can't modify min price to 836.1 since it violates the current boundary PriceBoundary(899.00,929.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282165",
        "exceptionMessage":"Can't modify min price to 1205.1000000000001 since it violates the current boundary PriceBoundary(1299.00,1339.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282895",
        "exceptionMessage":"Can't modify min price to 1205.1000000000001 since it violates the current boundary PriceBoundary(1299.00,1339.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282307",
        "exceptionMessage":"Can't modify min price to 1205.1000000000001 since it violates the current boundary PriceBoundary(1299.00,1339.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282002",
        "exceptionMessage":"Can't modify min price to 332.1 since it violates the current boundary PriceBoundary(349.00,369.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282399",
        "exceptionMessage":"Can't modify min price to 1025.1000000000001 since it violates the current boundary PriceBoundary(1099.00,1139.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282374",
        "exceptionMessage":"Can't modify min price to 1025.1000000000001 since it violates the current boundary PriceBoundary(1099.00,1139.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282694",
        "exceptionMessage":"Can't modify min price to 836.1 since it violates the current boundary PriceBoundary(899.00,929.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282155",
        "exceptionMessage":"Can't modify min price to 836.1 since it violates the current boundary PriceBoundary(899.00,929.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282271",
        "exceptionMessage":"Can't modify min price to 836.1 since it violates the current boundary PriceBoundary(899.00,929.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282087",
        "exceptionMessage":"Can't modify min price to 1025.1000000000001 since it violates the current boundary PriceBoundary(1099.00,1139.00)"
      }
    },
    {
      "messageId":"ProcessingFailure",
      "attributes":{
        "productId":"57282489",
        "exceptionMessage":"Can't modify min price to 1025.1000000000001 since it violates the current boundary PriceBoundary(1099.00,1139.00)"
      }
    }
  ],
  "creationDate":"2023-05-09T10:05:00.230Z",
  "taskType":"backend.tasks.pricemonitor.offers.preprocessing",
  "finishDate":"2023-05-09T10:05:20.095Z",
  "userId":2156,
  "startDate":"2023-05-09T10:05:00.238Z",
  "taskId":"f8kfq5:44680e2e-2458-4a64-b8a4-edfd5fb2517f"
}

Find tasks for contract [vendor]

Request

The search can be narrowed down by providing the IDs of the tasks, separated by comma

Security
BasicAuth or BearerAuth
Path
contractIdstringnon-emptyrequired

Unique identifier of the contract

Example: qbcxvb
Query
taskIdsFilterstring

Ids of the tasks

taskTypeFilterstring

Desired task type

limitinteger(int32)

Maximal number of results

Default 100
Example: limit=10
includeFailuresboolean

Flag whether to include failures in the response

Default true
taskStatestring

Comma separated task state filter

minCreationDatestring(date-time)

Oldest returned creation date in UTC

maxCreationDatestring(date-time)

Newest returned creation date in UTC

curl -i -X GET \
  -u <username>:<password> \
  'https://api-docs.omniaretail.dev/_mock/api/omnia/api/2/v/contracts/qbcxvb/tasks?includeFailures=true&limit=10&maxCreationDate=2019-08-24T14%3A15%3A22Z&minCreationDate=2019-08-24T14%3A15%3A22Z&taskIdsFilter=string&taskState=string&taskTypeFilter=string'

Responses

No response was specified

Bodyapplication/jsonArray [
contractIdstring
creationDatestring(date-time)
dataArray of strings
failuresArray of objects
finishDatestring(date-time)
parentIdstring
startDatestring(date-time)
statestring
taskIdstring
taskTypestring
]
Response
application/json
[
  {
    "contractId": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "data": [ … ],
    "failures": [ … ],
    "finishDate": "2019-08-24T14:15:22Z",
    "parentId": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "state": "string",
    "taskId": "string",
    "taskType": "string"
  }
]

Get task

Request

Finds a task with the specified id for the given contract.

Security
BasicAuth or BearerAuth
Path
contractIdstringnon-emptyrequired

Unique identifier of the contract

Example: qbcxvb
taskIdstringrequired

Id of the task

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

Responses

No response was specified

Bodyapplication/json
contractIdstring
creationDatestring(date-time)
dataArray of strings
failuresArray of objects
finishDatestring(date-time)
parentIdstring
startDatestring(date-time)
statestring
taskIdstring
taskTypestring
Response
application/json
{
  "contractId": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "data": [
    "string"
  ],
  "failures": [
    { … }
  ],
  "finishDate": "2019-08-24T14:15:22Z",
  "parentId": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "state": "string",
  "taskId": "string",
  "taskType": "string"
}

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