Sign in

v1

latestOpenAPI 3.0.32026-07-173196215.4 KB
attributes

Get an attribute

Get attribute group specified by groupName. The response will also include the available attribute values for the attribute group.

get/v1/attributes/{groupName}

Path parameters

groupNamestring required
Example:brand

Get attribute group with values by specified groupName.

Query parameters

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"
    }
  ]
}