GET /products/{productId}/variants

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

Get ids of all product's variants, both active and inactive.

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

Example

``` { "result": { "code": 200, "status": "OK" }, "data": [ { "id": "F192621", "variant_id": 56151651, "product_id": 73984, "title": "Title of variant", "status": "A", "in_stock": 23, "price": 5.6, "fair_price": 5.7, "rrp": 29, } ] }

Headers

  • X-Application-Name string

Path parameters

  • productId string Required

    Partner's product identifier

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

    Variant list OK response

    One of:
GET /products/{productId}/variants
curl \
 -X GET https://mpapi.proxy.omnicado.com/v1/products/F192621/variants?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": [
    {
      "variant_id": 10000305472,
      "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": [
    {
      "variant_id": 10000305472,
      "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
  }
}