Sign in

v1

latestOpenAPI 3.0.32026-07-173196215.4 KB
attributes

List 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 use /attributes to retrieve all your attribute groups. To get only a few attribute groups, you can specify their attribute group IDs or their attribute group names. You can also get individual attribute groups and their attribute values with /v1/attributes/{attributeGroupName}.

get/v1/attributes

Query parameters

namesstring[]

Only include results with groupName matching one of the specified names.

[
  "color",
  "brand"
]
idsinteger[]

Only include results with groupId matching one of the specified ids.

[
  550,
  1000
]
withstring[]

Include related attribute resource. Right now, the only possible include is values. When adding the with=values parameter, the response will also include the available attribute values for each attribute group.

[
  "values"
]
shopIdstring required

In case you are operating multiple shops (for example, for different domain names or different languages), each shop is identified by its specific shopId

Response

successful operation

idinteger required
keystring required

Reference that identifies the attribute

labelstring required

The label that describes the attribute group will be set according to the shop's language in the SCAYLE Panel.

multiSelectboolean required

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

typestring required

Attribute type

Example response

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