This is the API powering Omnia 2.0 and Pricemonitor, containing operations which can also be used directly by customers from their own systems.
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.
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.
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.
If you want to find the most recent completed price calculation task you need the following query parameters:
limit=1
includeFailures=true
taskTypeFilter=backend.tasks.pricemonitor.offers.preprocessing
taskState=succeeded,failed // this only returns completed tasks. Currently running tasks are ignoredOptional: You might want to adjust the queried timerange and specify minCreationDate and maxCreationDate. By default all tasks ever are queried.
It can happen that there no price calculation has been run yet, then an empty list of tasks is returned.
Apart from that these are the possible task states:
| Task state | Description |
|---|---|
| succeeded | At least for one product a price calculation has been calculated |
| failed | Either all price calculations for every product failed OR the whole price calculation process failed due to an unexpected error |
If there are price calculation failures on a product level, you find the dedicated failures in the failures array of the task. Be aware: at most 1000 failures are returned.
If you want to have statistics for how many products a price has been calculated and how many price calculations failed on product level, then please take a look at the result.operations.<successful/failed/total> fields in the response.
When a task completely fails then the response also provides a failureCode that is of interest.
{
"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"
}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'[ { "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" } ]
curl -i -X GET \
-u <username>:<password> \
'https://api-docs.omniaretail.dev/_mock/api/omnia/api/2/v/contracts/qbcxvb/tasks/{taskId}'{ "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" }