Attributes API guide

Permissions

To edit and create attributes, a user needs to have the following permissions:

• MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES
• MANAGE_PAGE_TYPES_AND_ATTRIBUTES

To assign attributes to products and pages, a user needs only the following permissions: MANAGE_PRODUCTS and MANAGE_PAGES.

Input types

Each attribute has an input type defined upon attribute creation. Input types determine the data type you can enter as the attribute values in the dashboard. Available input types are defined in the AttributeInputTypeEnum enum. Below is the list of available input types:

Name	Description	Example
DROPDOWN	List of predefined choices; rendered as a single-select dropdown.	Store a color of a variant with predefined choices: orange, black, blue, etc.
MULTISELECT	List of predefined choices; rendered as a multi-select dropdown.	Add multiple tags to a product or a page.
FILE	Allows to store a file as an attribute value; rendered as a file input.	Store a product manual as a PDF file; store a hero image for a page.
REFERENCE	Values are references to other entities such as products, variants or pages.	Render a list of related products on a product page.
NUMERIC	Values are numbers; optionally, a unit can be provided to represent measures and dimensions.	Dimensions of a product represented with three numeric attributes: length, width, depth.
RICH_TEXT	Value is stored as rich-text content; rendered as a rich-text editor.	Additional content blocks for a page or product.
BOOLEAN	Allows storing boolean values.	Yes/no properties, e.g. "Product is fair trade certified: yes/no".
DATE	Allows storing date values.	Store release date of a product.
DATE_TIME	Allows storing date time values.	Store release date with time of a product.

Fetching all attributes

To fetch the list of attributes, use the attributes query:

{
  attributes(first: 5) {
    edges {
      node {
        name
        slug
        inputType
        entityType
        unit
        choices(first: 5) {
          edges {
            node {
              name
              slug
            }
          }
        }
      }
    }
  }
}

Expand ▼

The attributes field supports pagination and filtering, e.g., searching attributes by name. For each attribute, we fetch the following properties, some of which are used only with specific input types:

• name - Name of the attribute, use it to render attribute in the frontend.
• slug - A unique attribute handle you can use to fetch an attribute or reference it in filters.
• inputType - Represents the input type.
• entityType - Used only with REFERENCE input types; represents the type of entities associated as references, e.g., PAGE or PRODUCT.
• unit - Used only with NUMERIC input types; represents the optional measurement unit.
• choices - Used only with DROPDOWN and MULTISELECT; a list of predefined choices you can use as values. The choices field supports pagination and filtering, e.g., searching choices by name.

Fetching assigned attributes

Attributes assigned to an object are represented by the SelectedAttribute GraphQL type. Below is the example of fetching attributes assigned to a product:

{
  product(slug: "colored-parrot-cushion", channel: "default-channel") {
    name
    attributes {
      attribute {
        slug
      }
      values {
        slug
      }
    }
  }
}

Similarly, you can fetch assigned attributes for ProductVariant and Page types.

Filtering by attributes

A user can use a slug to filter products by attributes. The query parameters can be encoded in URL and will be the same in all languages.

An example of a products query:

query {
  products(
    first: 5
    filter: { attributes: [{ slug: "bucket-size", values: "25l" }] }
    channel: "default-channel"
  ) {
    edges {
      node {
        name
      }
    }
  }
}

Response:

{
  "data": {
    "products": {
      "edges": [
        {
          "node": {
            "name": "Hyperspace Turquoise Paint"
          }
        },
        {
          "node": {
            "name": "Light Speed Yellow Paint"
          }
        },
        {
          "node": {
            "name": "Nebula Night Sky Paint"
          }
        },
        {
          "node": {
            "name": "Red Dwarf Red Paint"
          }
        },
        {
          "node": {
            "name": "Space Dust Navy Paint"
          }
        }
      ]
    }
  }
}

Expand ▼