Public API
/
Company Management
/
Get all contracts for company

Omnia 2.0 API (0.0.7136)

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.

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

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

Operations

Company Management

Company management related endpoints.

Operations

Create company

Request

Allows users without a company to create a new company.

Bodyapplication/jsonrequired

The company's name

string
curl -i -X POST \
  -u <username>:<password> \
  https://api-docs.omniaretail.dev/_mock/api/omnia/api/2/companies \
  -H 'Content-Type: application/json'

Responses

Information about the created company.

Bodyapplication/json
dataobject(CreateCompanyResponse)required
data.​idinteger(int64)
data.​namestring
Response
application/json
{
  "data": {
    "id": 0,
    "name": "string"
  }
}

Get all contracts for company

Request

Get all contracts for the given company.

Path
companyIdinteger(int64)required

ID of a company

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

Responses

No response was specified

Bodyapplication/json
dataArray of objects(ApiContract)required
data[].​activeboolean
data[].​companyNamestring
data[].​contractIdstring
data[].​contractNamestring
data[].​contractTypestring
data[].​expirationDatestring(date-time)
Response
application/json
{
  "data": [
    { … }
  ]
}

Add contract for company

Request

Add a contract for the given company.

Path
companyIdinteger(int64)required

ID of a company

Example: 1
Bodyapplication/jsonrequired

Contract to be added

contractTypestringrequired

Type of the contract. Currently, only 2 types are supported: - Pricemonitor for manufacturers - Pricemonitor for resellers

contractNamestringrequired

Name of the new contract

expirationDatestring(date-time)

Expiration date

curl -i -X POST \
  -u <username>:<password> \
  https://api-docs.omniaretail.dev/_mock/api/omnia/api/2/companies/1/contracts \
  -H 'Content-Type: application/json' \
  -d '{
    "contractType": "string",
    "contractName": "string",
    "expirationDate": "2019-08-24T14:15:22Z"
  }'

Responses

No response was specified

Bodyapplication/json
dataobject(ApiContract)required
data.​activeboolean
data.​companyNamestring
data.​contractIdstring
data.​contractNamestring
data.​contractTypestring
data.​expirationDatestring(date-time)
Response
application/json
{
  "data": {
    "active": true,
    "companyName": "string",
    "contractId": "string",
    "contractName": "string",
    "contractType": "string",
    "expirationDate": "2019-08-24T14:15:22Z"
  }
}

Orders Management

Manage your orders.

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 the 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 registered plugins.

Operations