Skip to main content

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:

NameDescriptionExample
DROPDOWNList of predefined choices; rendered as a single-select dropdown.Store a color of a variant with predefined choices: orange, black, blue, etc.
MULTISELECTList of predefined choices; rendered as a multi-select dropdown.Add multiple tags to a product or a page.
FILEAllows 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.
REFERENCEValues are references to other entities such as products, variants, pages, categories or collections.Render a list of related products on a product page.
SINGLE_REFERENCEStores a reference to other entity such as product, variant, page, collection or category.Render a related collection on a product page.
NUMERICValues 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_TEXTValue is stored as rich-text content; rendered as a rich-text editor.Additional content blocks for a page or product.
PLAIN_TEXTValue is stored as plain text; rendered as a text input.Stores unformatted text for simple labels, e.g., "Material: 100% Cotton"
SWATCHStores a color code or an image.Stores a color or an image to visually represent options like colors or patterns.
BOOLEANAllows storing boolean values.Yes/no properties, e.g. "Product is fair trade certified: yes/no".
DATEAllows storing date values.Store release date of a product.
DATE_TIMEAllows storing date time values.Store release date with time of a product.

Fetching Attributes​

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

query Attributes($first: Int, $where: AttributeWhereInput) {
  attributes(first: $first, where: $where) {
    totalCount
    edges {
      node {
        name
        slug
        inputType
        entityType
        referenceTypes {
          ... on ProductType {
            id
            slug
          }
          ... on PageType {
            id
            slug
          }
        }
        unit
        choices(first: $first) {
          edges {
            node {
              name
            }
          }
        }
      }
    }
  }
}

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 and SINGLE_REFERENCE input types; represents the type of entities associated as references, e.g., PAGE or PRODUCT.
  • referenceTypes - Allowed target types for reference attributes. For attributes with the PRODUCT or PRODUCT_VARIANT entity type, this lists allowed product types; for attributes with the PAGE entity type, this lists allowed page types. Not supported for CATEGORY or COLLECTION reference attributes.
  • unit - Used only with NUMERIC input types; represents the optional measurement unit.
  • choices - Used only with DROPDOWN, MULTISELECT and SWATCH; a list of predefined choices you can use as values. The choices field supports pagination and filtering, e.g., searching choices by name.

Fetching Product Assigned Attributes​

Attributes assigned to an object are represented by the AssignedAttribute GraphQL interface. Below is an example of fetching the material attribute (of single-choice type) and single references to pages connected to the product.

query Product($productSlug: String, $channel: String, $languageCode: LanguageCodeEnum!) {
  product(slug: $productSlug, channel: $channel) {
    name
    material: assignedAttribute(slug: "material") {
      ... on AssignedSingleChoiceAttribute {
        value {
          slug
          translation(languageCode:$languageCode)
        }
      }
    }
    brandReferences: assignedAttribute(slug: "brand") {
      ... on AssignedSinglePageReferenceAttribute {
        value {
          title
          translation(languageCode: $languageCode){
            title
          }
        }
      }
    }
  }
}

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

Fetching Product With All Types of Assigned Attributes​

To fetch all attributes assigned to products or variant with values use the ObjectWithAttributes interface.

query Product($productSlug: String, $channel: String) {
  product(slug: $productSlug, channel: $channel) {
    name
    ...Attributes
  }
}

fragment Attributes on ObjectWithAttributes {
  assignedAttributes {
    attribute {
      id
      slug
    }
    ... on AssignedNumericAttribute {
      number: value
    }
    ... on AssignedTextAttribute {
      text: value
    }
    ... on AssignedPlainTextAttribute {
      plain_text: value
    }
    ... on AssignedFileAttribute {
      file: value {
        contentType
      }
    }
    ... on AssignedSingleChoiceAttribute {
      choice: value {
        name
        slug
      }
    }
    ... on AssignedMultiChoiceAttribute {
      choices: value {
        name
        slug
      }
    }
    ... on AssignedSwatchAttribute {
      swatch: value {
        name
        slug
        hexColor
        file {
          url
          contentType
        }
      }
    }
    ... on AssignedBooleanAttribute {
      bool: value
    }
    ... on AssignedDateAttribute {
      date: value
    }
    ... on AssignedDateTimeAttribute {
      datetime: value
    }
    ... on AssignedSinglePageReferenceAttribute {
      page_ref: value {
        __typename
        slug
      }
    }
    ... on AssignedSingleProductReferenceAttribute {
      product_ref: value {
        __typename
        slug
      }
    }
    ... on AssignedSingleProductVariantReferenceAttribute {
      variant_ref: value {
        __typename
        sku
      }
    }
    ... on AssignedSingleCategoryReferenceAttribute {
      category_ref: value {
        __typename
        slug
      }
    }
    ... on AssignedSingleCollectionReferenceAttribute {
      collection_ref: value {
        __typename
        slug
      }
    }
    ... on AssignedMultiPageReferenceAttribute {
      pages: value {
        __typename
        slug
      }
    }
    ... on AssignedMultiProductReferenceAttribute {
      products: value {
        __typename
        slug
      }
    }
    ... on AssignedMultiProductVariantReferenceAttribute {
      variants: value {
        __typename
        sku
      }
    }
    ... on AssignedMultiCategoryReferenceAttribute {
      categories: value {
        __typename
        slug
      }
    }
    ... on AssignedMultiCollectionReferenceAttribute {
      collections: value {
        __typename
        slug
      }
    }
  }
}

Filtering Products 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: Int, $channel: String, $where: ProductWhereInput) {
  products(first: $first, where: $where, channel: $channel) {
    edges {
      node {
        name
      }
    }
  }
}

Setting Allowed Reference Types​

The attribute’s inputType must be REFERENCE or SINGLE_REFERENCE, and entityType must be PRODUCT, PRODUCT_VARIANT, or PAGE to use referenceTypes.

Creating an Attribute with Allowed Reference Types​

Create a PRODUCT reference attribute with restricted product types with the use of attributeCreate mutation:

mutation attributeCreate($input: AttributeCreateInput!) {
  attributeCreate(input: $input) {
    attribute {
      id
      referenceTypes {
        ... on ProductType {
          __typename
          id
          slug
        }
      }
    }
    errors {
      field
      code
      message
    }
  }
}

Create a PAGE single-reference attribute with restricted page types:

mutation attributeCreate($input: AttributeCreateInput!) {
  attributeCreate(input: $input) {
    attribute {
      id
      referenceTypes {
        ... on PageType {
          __typename
          id
          slug
        }
      }
    }
    errors {
      field
      code
      message
    }
  }
}

Update Allowed Reference Types​

Adjust the allowed product types for a PRODUCT reference attribute with the use of attributeUpdate mutation:

mutation attributeUpdate($id: ID, $input: AttributeUpdateInput!) {
  attributeUpdate(id: $id, input: $input) {
    attribute {
      id
      referenceTypes {
        ... on ProductType {
          id
          slug
        }
      }
    }
    errors {
      field
      code
      message
    }
  }
}

Clear restrictions (disables type validation for future updates/new values; existing references are not modified):

mutation attributeUpdate($id: ID, $input: AttributeUpdateInput!) {
  attributeUpdate(id: $id, input: $input) {
    attribute {
      id
      referenceTypes {
        ... on ProductType {
          id
          slug
        }
      }
    }
    errors {
      field
      code
      message
    }
  }
}