v1

latestSwagger 2.02026-07-13137761.0 MB

Family variant

Get a family variant

This endpoint allows you to get the information about a given family variant.

get/api/rest/v1/families/{family_code}/variants/{code}

Path parameters

family_codestring required

Code of the family

codestring required

Code of the resource

Response

codestring required

Family variant code

common_attributesstring[]

Codes of attributes that are common to all levels of the family variant

Example response

{
  "code": "shoesVariant",
  "labels": {
    "en_US": "Shoes variant",
    "fr_FR": "Variante de chaussures"
  },
  "common_attributes": [
    "name",
    "description"
  ],
  "variant_attribute_sets": [
    {
      "level": 1,
      "attributes": [
        "color",
        "material"
      ],
      "axes": [
        "color"
      ]
    },
    {
      "level": 2,
      "attributes": [
        "sku",
        "size"
      ],
      "axes": [
        "size"
      ]
    }
  ]
}