Attribute Object

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!
  privateMetadata: [MetadataItem!]!
  privateMetafield(
    key: String!
  ): String
  privateMetafields(
    keys: [String!]
  ): Metadata
  metadata: [MetadataItem!]!
  metafield(
    key: String!
  ): String
  metafields(
    keys: [String!]
  ): Metadata
  inputType: AttributeInputTypeEnum
  entityType: AttributeEntityTypeEnum
  referenceTypes(
    limit: PositiveInt = 100
  ): [ReferenceType!]
  name: String
  slug: String
  type: AttributeTypeEnum
  unit: MeasurementUnitsEnum
  choices(
    sortBy: AttributeChoicesSortingInput
    filter: AttributeValueFilterInput
    where: AttributeValueWhereInput
    search: String
    before: String
    after: String
    first: Int
    last: Int
  ): AttributeValueCountableConnection
  valueRequired: Boolean!
  visibleInStorefront: Boolean!
  filterableInStorefront: Boolean! @deprecated
  filterableInDashboard: Boolean!
  availableInGrid: Boolean! @deprecated
  storefrontSearchPosition: Int! @deprecated
  translation(
    languageCode: LanguageCodeEnum!
  ): AttributeTranslation
  withChoices: Boolean!
  productTypes(
    before: String
    after: String
    first: Int
    last: Int
  ): ProductTypeCountableConnection!
  productVariantTypes(
    before: String
    after: String
    first: Int
    last: Int
  ): ProductTypeCountableConnection!
  externalReference: String
}

Fields

`Attribute.id` ● `ID!` non-null scalar miscellaneous

The ID of the attribute.

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

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

`Attribute.privateMetafield` ● `String` scalar miscellaneous

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

`Attribute.privateMetafield.key` ● `String!` non-null scalar miscellaneous

`Attribute.privateMetafields` ● `Metadata` scalar miscellaneous

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

`Attribute.privateMetafields.keys` ● `[String!]` list scalar miscellaneous

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

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

`Attribute.metafield` ● `String` scalar miscellaneous

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

`Attribute.metafield.key` ● `String!` non-null scalar miscellaneous

`Attribute.metafields` ● `Metadata` scalar miscellaneous

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

`Attribute.metafields.keys` ● `[String!]` list scalar miscellaneous

`Attribute.inputType` ● `AttributeInputTypeEnum` enum attributes

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

`Attribute.entityType` ● `AttributeEntityTypeEnum` enum attributes

The entity type which can be used as a reference.

`Attribute.referenceTypes` ● `[ReferenceType!]` list union miscellaneous

The reference types (product or page type) that are used to narrow down the choices of reference objects.

Added in Saleor 3.22

`Attribute.referenceTypes.limit` ● `PositiveInt` scalar miscellaneous

Maximum number of objects to return. Value must be greater than 0. Default is 100.

`Attribute.name` ● `String` scalar miscellaneous

Name of an attribute displayed in the interface.

`Attribute.slug` ● `String` scalar miscellaneous

Internal representation of an attribute name.

`Attribute.type` ● `AttributeTypeEnum` enum attributes

The attribute type.

`Attribute.unit` ● `MeasurementUnitsEnum` enum miscellaneous

The unit of attribute values.

`Attribute.choices` ● `AttributeValueCountableConnection` object attributes

A list of predefined attribute choices available for selection. Available only for attributes with predefined choices.

`Attribute.choices.sortBy` ● `AttributeChoicesSortingInput` input attributes

Sort attribute choices.

`Attribute.choices.filter` ● `AttributeValueFilterInput` deprecated input attributes

DEPRECATED

Use where filter instead.

Filtering options for attribute choices.

`Attribute.choices.where` ● `AttributeValueWhereInput` input attributes

Where filtering options for attribute choices.

Added in Saleor 3.22

`Attribute.choices.search` ● `String` scalar miscellaneous

Search attribute choices.

Added in Saleor 3.22

`Attribute.choices.before` ● `String` scalar miscellaneous

Return the elements in the list that come before the specified cursor.

`Attribute.choices.after` ● `String` scalar miscellaneous

Return the elements in the list that come after the specified cursor.

`Attribute.choices.first` ● `Int` scalar miscellaneous

Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

`Attribute.choices.last` ● `Int` scalar miscellaneous

Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.