Update/create a family variant

PATCH

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

Family variant

This endpoint allows you to update a given family variant. Know more about Update behavior. Note that if no family variant exists for the given code, it creates it.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/rest/v1/families//variants/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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
        }
    ]
}'

Response Example

201 - Example 1

{}

Request

Path Params

family_code

string

required

Code of the family

code

string

required

Code of the resource

Body Params application/json

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

Examples

Responses

🟢201Created

application/json

Body

object {0}

🟢204No content to return

🟠400Bad request

🟠401Authentication required

🟠403Access forbidden

🟠415Unsupported Media type

🟠422Unprocessable entity

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

Get a family variant

Get a list of locales