Attribute

Custom attribute of a product. Attributes can be assigned to products and variants at the product type level.

type Attribute implements Node, ObjectWithMetadata {
  id: ID!
  metadata: [MetadataItem!]!
  privateMetadata: [MetadataItem!]!
  name: String!
  slug: String!
  externalId: String
  externalSource: String
  isLocked: Boolean!
  valueRequired: Boolean!
  visibleInStorefront: Boolean!
  filterableInStorefront: Boolean!
  storefrontSearchPosition: Int!
  filterableInDashboard: Boolean!
  availableInGrid: Boolean!
  inputType: AttributeInputTypeEnum!
  values(
    search: String
    first: Int
  ): [AttributeValue!]!
  createdBy: Seller
  allProductTypes: [ProductType!]!
  productTypes(
    before: String
    after: String
    first: Int
    last: Int
  ): ProductTypeCountableConnection!
  productVariantTypes(
    before: String
    after: String
    first: Int
    last: Int
  ): ProductTypeCountableConnection!
  warnings: [AttributeWarningMessageItem!]!
}

Show more ↓

Fields

Attribute.id ● ID! non-null scalar

The Globally Unique ID of this object

Attribute.metadata ● [MetadataItem!]! non-null object

List of public metadata items. Can be accessed without permissions.

Attribute.privateMetadata ● [MetadataItem!]! non-null object

List of private metadata items. Requires proper staff permissions to access.

Attribute.name ● String! non-null scalar

Name of the attribute

Attribute.slug ● String! non-null scalar

Slug identifier

Attribute.externalId ● String scalar

External system identifier

Attribute.externalSource ● String scalar

External system source

Attribute.isLocked ● Boolean! non-null scalar

Controls if seller users can create dropdown/multiselect values

Attribute.valueRequired ● Boolean! non-null scalar

Whether a value is required

Attribute.visibleInStorefront ● Boolean! non-null scalar

Visible in storefront

Attribute.filterableInStorefront ● Boolean! non-null scalar

Filterable in storefront

Attribute.storefrontSearchPosition ● Int! non-null scalar

Position in storefront search

Attribute.filterableInDashboard ● Boolean! non-null scalar

Filterable in dashboard

Attribute.availableInGrid ● Boolean! non-null scalar

Available in product grid display

Attribute.inputType ● AttributeInputTypeEnum! non-null enum

The input type to use for entering attribute values in the dashboard.

Attribute.values ● [AttributeValue!]! non-null object

The values available for this attribute

Attribute.values.search ● String scalar

Attribute.values.first ● Int scalar

Attribute.createdBy ● Seller object

Seller who created this attribute, if any

Attribute.allProductTypes ● [ProductType!]! non-null object

List of all product types that are using this attribute

Attribute.productTypes ● ProductTypeCountableConnection! non-null object

Product types with this attribute as a product attribute

Attribute.productTypes.before ● String scalar

Returns the items in the list that come before the specified cursor.

Attribute.productTypes.after ● String scalar

Returns the items in the list that come after the specified cursor.

Attribute.productTypes.first ● Int scalar

Returns the first n items from the list.

Attribute.productTypes.last ● Int scalar

Returns the items in the list that come after the specified cursor.

Attribute.productVariantTypes ● ProductTypeCountableConnection! non-null object

Product types with this attribute as a variant attribute

Attribute.productVariantTypes.before ● String scalar

Returns the items in the list that come before the specified cursor.

Attribute.productVariantTypes.after ● String scalar

Returns the items in the list that come after the specified cursor.

Attribute.productVariantTypes.first ● Int scalar

Returns the first n items from the list.

Attribute.productVariantTypes.last ● Int scalar

Returns the items in the list that come after the specified cursor.

Attribute.warnings ● [AttributeWarningMessageItem!]! non-null object

List of warnings for this attribute

Interfaces

Node interface

An object with a Globally Unique ID

ObjectWithMetadata interface

An object that supports metadata.

Returned By

attribute query

Member Of

AttributeCountableEdge object ● AttributeCreate object ● AttributeDelete object ● AttributeUpdate object ● AttributeValue object ● AttributeValueBulkCreate object ● AttributeValueCreate object ● AttributeValueDelete object ● AttributeValuesReorder object ● AttributeValueUpdate object ● CustomFieldTemplate object ● Product object ● ProductType object ● SelectedAttribute object