Get a family

GET

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

Family

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

Response Example

200 - Example 1

{
    "attribute_as_image": "picture",
    "attribute_as_label": "name",
    "attribute_requirements": {
        "ecommerce": [
            "sku",
            "name",
            "description",
            "price",
            "color"
        ],
        "tablet": [
            "sku",
            "name",
            "description",
            "price"
        ]
    },
    "attributes": [
        "sku",
        "name",
        "description",
        "price",
        "color",
        "picture"
    ],
    "code": "caps",
    "labels": {
        "en_US": "Caps",
        "fr_FR": "Casquettes"
    }
}

Request

Path Params

code

string

required

Code of the resource

Responses

🟢200OK

application/json

Body

attribute_as_image

string

optional

Attribute code used as the main picture in the user interface (only since v2.0)

Default:

null

attribute_as_label

string

required

Attribute code used as label

attribute_requirements

object

optional

Attributes codes of the family that are required for the completeness calculation for each channel

channelCode

array[string]

optional

attributes

array[string]

optional

Attributes codes that compose the family

code

string

required

Family code

labels

object

optional

Family labels for each locale

Default:

{}

localeCode

string

optional

Family label for the locale localeCode

🟠401Authentication required

🟠403Access forbidden

🟠404Resource not found

🟠406Not Acceptable

Create a new family

Update/create a family