Ometria data API

Welcome to the Ometria API reference.


The Ometria API is organized around the REST methodology, and it uses resource-oriented URLs, and common HTTP response codes to indicate API errors. All requests are authenticated using an API key which can be obtained from your account settings.


HTTPS


All requests to the Ometria API MUST be carried out via HTTPS. API servers do not listen on unsecured HTTP ports to avoid the possibility of insecure information exchange.


Message encoding

The V2 Ometria API uses JSON encoding for all data exchanges and assumes UTF-8 character encoding throughout.


Rate limits

The Ometria API has a default rate limit of 4 requests per second per Ometria account. If you expect to exceed this limit, please contact us.

In the case of your application being rate limited, the HTTP code 429 (too many requests) will be returned. In this case your application should reduce the number of requests it is trying to send.


Note that the asynchronous push API also has a maximum of 50,000 asynchronous import records. If you attempt to push more than this number of records in a short timeframe, you will also receive the HTTP 429 status code.


Authentication

apikey 

name    X-Ometria-Auth
in    header

description


Ometria API key which can be obtained from your Ometria account administrator



Products

Products


List Products

GET /products


Return a list of products with optional filters


limit

Number of items to return. Max 250.

typestring 10inqueryoffset

Index of first record.

typestring 0inqueryactive

Should we return only active or inactive products? true for return only active. false for return only inactive. If not defined, active and inactive products are returned.

typestring , x ∈ { true , false }inquery
200 OK Product 

List of Product objects

403 Forbidden

API key is not authorised to access this resource

Response Example (200 OK)
[
  {
    "@type": "product",
    "attributes": [
      {
        "id": "category:womens",
        "label": "Womens",
        "type": "category"
      },
      {
        "id": "style:casual",
        "label": "Casual",
        "type": "style"
      }
    ],
    "id": "12345",
    "image_url": "http://www.example.com/product.jpg",
    "is_active": true,
    "listings": [
      {
        "currency": "EUR",
        "image_url": "http://www.example.com/fr/product.jpg",
        "is_active": true,
        "price": 50,
        "store": "example.com/fr",
        "title": "Produit d'essai",
        "url": "http://www.example.com/fr/product.html"
      },
      {
        "currency": "EUR",
        "image_url": "http://www.example.com/de/product.jpg",
        "is_active": false,
        "price": 50,
        "store": "example.com/de",
        "title": "Das Product",
        "url": "http://www.example.com/de/product.html"
      }
    ],
    "price": 50,
    "properties": {
      "custom_key": "custom value"
    },
    "sku": "FHSG-2738-FHI",
    "special_price": 45,
    "special_price_dt_from": "2015-03-02T09:00:00+00",
    "special_price_dt_to": "2015-01-02T09:00:00+00",
    "title": "Test Product",
    "url": "http://www.example.com/product.html"
  }
]