younifyd
Menu

Get Family Variant By Code

Get a family variant

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

Use it in a workflow

  1. Add a step and choose the Akeneo connector.
  2. Pick the Get Family Variant By Code action (under Family variant).
  3. Fill in the fields below, then reference the result from later steps as {{getFamilyVariantByCode.response.data}}.

Request

Path parameters

family_codestringrequired

This path parameter is used to specify the unique identifier of the family you want to retrieve or manipulate. It is essential for identifying the specific family in the API requests. Ensure that the family code is correctly formatted and corresponds to an existing family in the system.

codestringrequired

This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate. It is essential for identifying the specific entity in the API requests. Ensure that the code is correctly formatted and corresponds to an existing entity in the system.

Response

Returns 200 with an object. Read it in later steps with {{getFamilyVariantByCode.response.data.<field>}}.

codestring

Family variant code

common_attributesarray<string>

Codes of attributes that are common to all variants (not specific to any enrichment level)

Default []

variant_attribute_setsarray<object>

Attributes distribution according to the enrichment level

levelintegerrequired

Enrichment level

axesarray<string>required

Codes of attributes used as variant axes

Default []

attributesarray<string>

Codes of attributes bind to this enrichment level

Default []

labelsobject

Family variant labels for each locale

Default {}

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

Need more? See the Akeneo guide for connection setup and behaviour shared by every action.