GET /products

ℹ You should never need to call this endpoint with proper API implementation.

Method returns ids of all partner's products. The list can contain both active and inactive products.

With URL parameter filter=basic objects with basic product data are returned instead of list of ids.

Example
{
  "result": {
    "code": 200,
    "status": "OK"
  },
  "paging": {
    "total": 1,
    "pages": 1,
    "size": 1000,
    "page": 1
  },
  "data": [
    {
      "id": "100000000111",
      "product_id": 100000000001,
      "title": "Some product title",
      "status": "A",
      "stage": "live",
      "in_stock": 0,
      "category_id": "MP001",
      "price": 5.6,
      "fair_price": 4.7,
      "rrp": 29
      "variants_count": 0,
      "has_variants": false
    }
  ]
}

Headers

  • X-Application-Name string

Query parameters

  • client_id string Required

    Client identifier

  • filter string

    With URL parameter filter=basic objects with basic data are returned instead of list of ids.

    Value is basic.

Responses

  • 200

    Product list OK response

    One of:
GET /products
curl \
 -X GET https://mpapi.proxy.omnicado.com/v1/products?client_id=yourClientId&client_id=api_token_value \
 -H "X-Application-Name: myApplicationName"
Response examples (200)
{
  "data": {
    "ids": [
      "F192621",
      "F191411"
    ]
  },
  "result": {
    "code": 200,
    "status": "OK"
  },
  "paging": {
    "pages": 1,
    "size": 1,
    "page": 1
  }
}
{
  "data": [
    {
      "stage": "live",
      "category_id": "MP001",
      "variants_count": 0,
      "has_variants": false,
      "id": "A3984",
      "product_id": 10000305472,
      "title": "Title of article",
      "status": "A",
      "in_stock": 23,
      "price": 1933.0,
      "fair_price": 159.3,
      "rrp": 2133.0,
      "force_price": 2051.0
    }
  ],
  "result": {
    "code": 200,
    "status": "OK"
  },
  "paging": {
    "pages": 1,
    "size": 1,
    "page": 1
  }
}
Response examples (200)
{
  "data": {
    "ids": [
      "F192621",
      "F191411"
    ]
  },
  "result": {
    "code": 200,
    "status": "OK"
  },
  "paging": {
    "pages": 1,
    "size": 1,
    "page": 1
  }
}
{
  "data": [
    {
      "stage": "live",
      "category_id": "MP001",
      "variants_count": 0,
      "has_variants": false,
      "id": "A3984",
      "product_id": 10000305472,
      "title": "Title of article",
      "status": "A",
      "in_stock": 23,
      "price": 1933.0,
      "fair_price": 159.3,
      "rrp": 2133.0,
      "force_price": 2051.0
    }
  ],
  "result": {
    "code": 200,
    "status": "OK"
  },
  "paging": {
    "pages": 1,
    "size": 1,
    "page": 1
  }
}