Get a family variant

GET

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

Family variant

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

Response Example

200 - Example 1

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

Request

Path Params

family_code

string

required

Code of the family

code

string

required

Code of the resource

Responses

🟢200OK

application/json

Body

code

string

required

Family variant code

labels

object

optional

Family variant labels for each locale

Default:

{}

localeCode

string

optional

Family variant label for the locale localeCode

variant_attribute_sets

array [object {3}]

required

Attributes distribution according to the enrichment level

attributes

array[string]

optional

Codes of attributes bind to this enrichment level

axes

array[string]

required

Codes of attributes used as variant axes

level

integer

required

Enrichment level

🟠401Authentication required

🟠403Access forbidden

🟠404Resource not found

🟠406Not Acceptable

Modified at 2023-08-15 05:53:55

Update/create several family variants

Update/create a family variant