Get variant data

GET /products/{productId}/variants/{variantId}

Responses

200

Variant detail OK response
Hide response attributes Show response attributes object
- data object
  
  Hide data attributes Show data attributes object
  
  article_id integer(int64)
  
  ID of MALL article
  
  url string
  
  url under which the article will be displayed on MALL store front
  
  fair_price number
  
  Fair Price
  
  overrides array[object]
  
  Overridden data of the article. Overrides are defined by MALL and cannot be changed from partners'side. See example.
  
  Hide overrides attributes Show overrides attributes array[object]
  
  value string
  
  Value to which the override was set
  
  valid_from string(date-time)
  
  Validity start date and time
  
  valid_to string(date-time)
  
  Validity end date and time
  
  id string
  
  Partners article (product/variant) ID (validated against /[a-z0-9_][a-z0-9\-_.]*/i regex pattern)
  
  title string
  
  Title of product (max. length is 200 chars)
  
  Maximum length is 200.
  
  shortdesc string
  
  Short description of the product
  
  Maximum length is 300.
  
  longdesc string
  
  Long description of the product (it can also contains simple html formatting)
  
  Maximum length is 13000.
  
  priority integer
  
  Priority for ordering products on list (or variants in context of product) - higher number means a higher priority on list
  
  barcode string
  
  EAN code of product/variant (if the product has variants, use this attribute only in the variant data structure)
  
  price number
  
  Price of product (used only if the product is without variants, otherwise it is in the variant data structure)
  
  rrp number Deprecated
  
  Recommended retail price (if the product has variants, use this attribute only in the variant data structure)
  
  media array[object]
  
  Product media with supported types: JPEG, GIF, PNG. Format PDF can be uploaded only for information list and energy labels. Format of picture is 4:3 (max. width 2000px) or 3:4 (max. height 2000px), max. 1.5 MB. URL cannot contain IP address or port. If the product has variants, use this attribute only in the variant data structure. If you want to update product/variant image, you need to make any change to the image URL
  
  Hide media attributes Show media attributes array[object]
  
  url string Required
  
  Url of media is validated - picture must be available on this url when the product is sent via API.
  
  main boolean Required
  
  Identifies the main product picture visible on the product list. Only one image can be main.
  
  switch string
  
  Identifies the picture used as a variant switch for specific variable parameter. Visible bellow the product description at the detail webpage. Used only for variants.
  
  energy_label boolean
  
  Identifies the picture or pdf as energy label. Energy label is legally required for following categories of products:
  
  Televisions and electronic displays
  
  Refrigerating appliances
  
  Dishwashers
  
  Washers and washers with dryer
  
  Dryers
  
  Light sources (new designation valid from September 2021)
  
  The picture or pdf is currently not required for product creation, but it will be required in the future and it is strongly encouraged to provide the energy label already.
  
  information_list boolean
  
  Identifies the picture or pdf as information list. Information list is legally required for following categories of products:
  
  Televisions and electronic displays
  
  Refrigerating appliances
  
  Dishwashers
  
  Washers and washers with dryer
  
  Dryers
  
  Light sources (new designation valid from September 2021)
  
  The picture or pdf is currently not required for product creation, but it will be required in the future and it is strongly encouraged to provide the information list already.
  
  promotions array[object] Deprecated
  
  Promotions data of product/variant. Promotion is highlighted on product list/detail of product. If the product has variants, use this attribute only in the variant data structure.
  
  Hide promotions attributes Show promotions attributes array[object] Deprecated
  
  price number Required
  
  Promotion price
  
  from string(date-time) Required
  
  Date and time of promotion start
  
  to string(date-time) Required
  
  Date and time of promotion end
  
  labels array[object]
  
  Labels data of the product/variant. Labels are used for sorting products. Each product can have assigned any number of valid labels. There are some standard labels - if partner wants special labels, it must be created in cooperation with MALL. See Labels.
  
  Hide labels attributes Show labels attributes array[object]
  
  label string Required
  
  Code of the label
  
  from string(date-time) Required
  
  Date and time of label start
  
  to string(date-time) Required
  
  Date and time of label end
  
  parameters object
  
  an array of parameters. Should you send one or more values, it is required to send them as an array of values for each parameter. Parameter value must be a string or an array of strings. See example.
  
  Hide parameters attribute Show parameters attribute object
  
  Additional properties: string
  
  dimensions object
  
  Hide dimensions attributes Show dimensions attributes object
  
  weight number
  
  Weight in kg, 3 decimal points float format
  
  width number
  
  Width in cm, 1 decimal point float format
  
  length number
  
  Length in cm, 1 decimal point float format
  
  height number
  
  Height in cm, 1 decimal point float format
  
  availability object
  
  Hide availability attributes Show availability attributes object
  
  status string Required
  
  Status of availability
  
  Values are A or N.
  
  in_stock integer Required
  
  Amount of items in stock
  
  Minimum value is 0, maximum value is 9999.
  
  recommended array[string]
  
  Ids of recommended products (if the product has variants, use this attribute only in the variant data structure). Max. limit of recommended products is 30.
  
  delivery_delay integer
  
  Number of days the delivery will be delayed for the product or variant. Value 0 means the item can be delivered the same day. If the product has variants and they have different value, use this attribute in the variant data structure. If the value is the same for all variants, it is enough to use the attribute only in the product data structure.
  
  Minimum value is 0.
  
  free_delivery boolean
  
  Activate / deactivate free delivery for the whole purchase (package) containing this article
  
  package_size string
  
  smallbox or bigbox package size
  
  Values are smallbox or bigbox. Default value is smallbox.
  
  mallbox_allowed boolean
  
  Allowed/denied Mallbox delivery
- result object
  
  Hide result attributes Show result attributes object
  
  code integer(int)
  
  status string

GET /products/{productId}/variants/{variantId}

curl \
 -X GET https://mpapi.proxy.omnicado.com/v1/products/{productId}/variants/{variantId}?client_id=api_token_value

Response examples (200)

{
  "data": {
    "article_id": 100000249018,
    "url": "https://www.mall.cz/id/100000249018",
    "fair_price": 1462.8,
    "overrides": [
      {
        "label": [
          {
            "value": "BFLV",
            "valid_from": "2022-01-02 00:00:00",
            "valid_to": "2022-02-06 23:59:59"
          }
        ],
        "priority": [
          {
            "value": 195,
            "valid_from": "2022-01-02 00:00:00",
            "valid_to": "2022-02-06 23:59:59"
          }
        ]
      }
    ],
    "id": "A3984",
    "title": "Title of product",
    "shortdesc": "Short description of the product",
    "longdesc": "Long description of <strong>the product</strong>",
    "priority": 1,
    "barcode": 9788025612019,
    "price": 1933.0,
    "rrp": 2133.0,
    "media": [
      {
        "url": "https://img.domain.tld/15880228.jpg",
        "main": true,
        "switch": "COLOR",
        "energy_label": false,
        "information_list": false
      }
    ],
    "promotions": [
      {
        "price": 1700.0,
        "from": "2015-07-19 00:00:00",
        "to": "2015-11-14 23:59:59"
      }
    ],
    "labels": [
      {
        "label": "SALE",
        "from": "2015-07-19 00:00:00",
        "to": "2015-11-14 23:59:59"
      }
    ],
    "parameters": {
      "COLOR": "red",
      "SIZE": "M"
    },
    "dimensions": {
      "weight": 10.5,
      "width": 10.0,
      "length": 10.0,
      "height": 10.0
    },
    "availability": {
      "status": "A",
      "in_stock": 23
    },
    "recommended": [
      "M191128",
      "M191129"
    ],
    "delivery_delay": 2,
    "free_delivery": true,
    "package_size": "smallbox",
    "mallbox_allowed": false
  },
  "result": {
    "code": 200,
    "status": "OK"
  }
}

Response examples (200)

{
  "data": {
    "article_id": 100000249018,
    "url": "https://www.mall.cz/id/100000249018",
    "fair_price": 1462.8,
    "overrides": [
      {
        "label": [
          {
            "value": "BFLV",
            "valid_to": "2022-02-06 23:59:59",
            "valid_from": "2022-01-02 00:00:00"
          }
        ],
        "priority": [
          {
            "value": 195,
            "valid_to": "2022-02-06 23:59:59",
            "valid_from": "2022-01-02 00:00:00"
          }
        ]
      }
    ],
    "id": "A3984",
    "title": "Title of product",
    "shortdesc": "Short description of the product",
    "longdesc": "Long description of <strong>the product</strong>",
    "priority": 1,
    "barcode": 9788025612019,
    "price": 1933.0,
    "rrp": 2133.0,
    "media": [
      {
        "url": "https://img.domain.tld/15880228.jpg",
        "main": true,
        "switch": "COLOR",
        "energy_label": false,
        "information_list": false
      }
    ],
    "promotions": [
      {
        "price": 1700.0,
        "from": "2015-07-19 00:00:00",
        "to": "2015-11-14 23:59:59"
      }
    ],
    "labels": [
      {
        "label": "SALE",
        "from": "2015-07-19 00:00:00",
        "to": "2015-11-14 23:59:59"
      }
    ],
    "parameters": {
      "SIZE": "M",
      "COLOR": "red"
    },
    "dimensions": {
      "weight": 10.5,
      "width": 10.0,
      "length": 10.0,
      "height": 10.0
    },
    "availability": {
      "status": "A",
      "in_stock": 23
    },
    "recommended": [
      "M191128",
      "M191129"
    ],
    "delivery_delay": 2,
    "free_delivery": true,
    "package_size": "smallbox",
    "mallbox_allowed": false
  },
  "result": {
    "code": 200,
    "status": "OK"
  }
}