Update/create several family variants

PATCH

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

Family variant

This endpoint allows you to update and/or create several family variants at once, for a given family.

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

200 - Example 1

{
  "code": "string",
  "identifier": "string",
  "line": 0,
  "message": "string",
  "status_code": 0
}

Request

Path Params

family_code

string

required

Code of the family

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

🟢200OK

application/json

Body

code

string

optional

Resource code, only filled when the resource is not a product

identifier

string

optional

Resource identifier, only filled when the resource is a product

line

integer

optional

Line number

message

string

optional

Message explaining the error

status_code

integer

optional

HTTP status code, see Client errors to understand the meaning of each code

🟠401Authentication required

🟠403Access forbidden

🟠413Request Entity Too Large

🟠415Unsupported Media type

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

Get list of family variants

Get a family variant