Sign in
attributes

Get information about attributes

To work with attributes, we distinguish between attribute groups and attribute values:

  • Each product can be assigned to many attribute values, for example: white or M.
  • Each attribute belongs to exactly one attribute group, for example: color or size.

When generally talking about attributes, both attribute groups and attribute values are sometimes referred to as just attributes. To avoid confusion when addressing technical details, use the more specific terms attribute groups and attribute values.

You can set up and modify your available attribute groups and values through the Panel.

You can use /attributes to retrieve all your attribute groups. The response will also include the available attribute values for each attribute group.

To get only a few attribute groups, you can specify their attribute group IDs or their attribute group names, for example, /attributes?ids=123,456,789 or /attributes?name=color.

You can also get individual attribute groups and their attribute values with /v1/attributes/{attributeGroupName}.

get/v1/attributes

Query parameters

namesstring
Example:brand

Only include attributes groups matching one of the specified names. Also returns all of that attribute group's values.

idsinteger
Example:42

Only include attribute groups matching one of the specified ids. Also returns all of that attribute group's values.

Response

successful operation

idinteger nullable required
keystring required

Reference that identifies the attribute

labelstring required

The locale is defined by the configuration of the shop associated with the authentication token. Translations of the individual attributes are maintained in the SCAYLE Panel.

multiSelectboolean required

A flag which determines whether an attribute has a single or possibly multiple values.

typestring nullable required

Attribute type

Example response

[
  {
    "values": [
      {
        "id": 428,
        "label": "Tommy Jeans",
        "value": "hilfiger_denim"
      }
    ]
  }
]

Changes