Sign in

v1

latestSwagger 2.02026-07-13137761.0 MB
Family

Get a family

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

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

Path parameters

codestring required

Code of the resource

Response

OK

codestring required

Family code

attribute_as_labelstring required

Attribute code used as label

attribute_as_imagestring

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

attributesstring[]

Attributes codes that compose the family

Example response

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