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.
You can register HTTP(S) callbacks in Omnia 2.0, which function as webhooks. Callbacks are triggered at the contract level when specific events occur within the system.
Please note that multiple parties can register callbacks, so when modifying callbacks, you must ensure that you do not overwrite or delete callbacks registered by other parties. We strongly recommend including a unique name for each callback to help you identify them later.
Callbacks are executed asynchronously as tasks within our system. To monitor the execution of these callbacks, you can track the corresponding tasks with the task type backend.tasks.pricemonitor.callback.
For added security, you can register a token with your callback and/or whitelist our IP range to ensure secure communication.
curl -i -X PUT \
-u <username>:<password> \
https://api-docs.omniaretail.dev/_mock/api/omnia/api/2/v/contracts/qbcxvb/settings/domains \
-H 'Content-Type: application/json' \
-d '[
"string"
]'curl -i -X GET \
-u <username>:<password> \
https://api-docs.omniaretail.dev/_mock/api/omnia/api/2/v/contracts/qbcxvb/settings/callbacksReturns a list of all configured callbacks for certain events. These callbacks are executed once the respective event has been successfully completed.
A list of callbacks that are triggered when the "Pricemonitor Completed" event occurs, which means:
1. A monitoring task (fetching offers) has successfully finished, and/or
2. The price recommendation calculation task has been completed.
The HTTP method to use when making the request. Supported methods are GET and POST. If not provided, the default method is GET.
An optional name for the callback, used for identification purposes.
An optional Mustache template to define the body of the request.
The following placeholders are available in the template:
- startTime: The time when the monitoring task started (in ISO 8601 format).
- contractId: The unique identifier of the contract.
Example default template: {"startTime":"{{startTime}}"}.
{ "pricemonitorCompleted": [ { … } ] }
Create or update callbacks for the given contract. This is used to upsert (insert or update) all callbacks at once. Keep in mind that callbacks can be used by multiple parties (Omnia internal, Omnia Plugins, Users). It's strongly recommended to provide your callbacks with a unique name to easily identify them later. To update a single callback, you must also provide all other callbacks to ensure no callbacks from other parties are lost. To delete all callbacks, you can provide an empty list.
The request body should contain a list of callbacks to be stored.
A list of callbacks that are triggered when the "Pricemonitor Completed" event occurs, which means:
1. A monitoring task (fetching offers) has successfully finished, and/or
2. The price recommendation calculation task has been completed.
The HTTP method to use when making the request. Supported methods are GET and POST. If not provided, the default method is GET.
An optional name for the callback, used for identification purposes.
An optional Mustache template to define the body of the request.
The following placeholders are available in the template:
- startTime: The time when the monitoring task started (in ISO 8601 format).
- contractId: The unique identifier of the contract.
Example default template: {"startTime":"{{startTime}}"}.
curl -i -X PUT \
-u <username>:<password> \
https://api-docs.omniaretail.dev/_mock/api/omnia/api/2/v/contracts/qbcxvb/settings/callbacks \
-H 'Content-Type: application/json' \
-d '{
"pricemonitorCompleted": [
{
"method": "string",
"name": "string",
"bodyTemplate": "string",
"url": "string",
"headers": {
"property1": "string",
"property2": "string"
}
}
]
}'Returns the callbacks that have been successfully stored.
A list of callbacks that are triggered when the "Pricemonitor Completed" event occurs, which means:
1. A monitoring task (fetching offers) has successfully finished, and/or
2. The price recommendation calculation task has been completed.
The HTTP method to use when making the request. Supported methods are GET and POST. If not provided, the default method is GET.
An optional name for the callback, used for identification purposes.
An optional Mustache template to define the body of the request.
The following placeholders are available in the template:
- startTime: The time when the monitoring task started (in ISO 8601 format).
- contractId: The unique identifier of the contract.
Example default template: {"startTime":"{{startTime}}"}.
{ "pricemonitorCompleted": [ { … } ] }