AttributeDefinition

A custom field that can be set on a record, such as “Material” on a product.

type AttributeDefinition {
  archivedAt: ISO8601DateTime
  attributeClass: AttributeClassEnum!
  attributeGroup: String
  attributeType: AttributeTypeEnum!
  commonValues: [AttributeCommonValue!]!
  createdAt: ISO8601DateTime!
  description: String
  entityType: AttributeEntityTypeEnum!
  handle: String
  id: ID!
  name: String!
  settings: AttributeDefinitionSettings!
  updatedAt: ISO8601DateTime!
}

Fields

AttributeDefinition.archivedAt ● ISO8601DateTime scalar common

When present, the attribute definition has been archived.

AttributeDefinition.attributeClass ● AttributeClassEnum! non-null enum common

Derived from the settings and the attribute type.

AttributeDefinition.attributeGroup ● String scalar common

Optional group name for organizing attribute definitions into sections.

AttributeDefinition.attributeType ● AttributeTypeEnum! non-null enum common

The kind of value the field holds. Fixed when the definition is created.

AttributeDefinition.commonValues ● [AttributeCommonValue!]! non-null object products

The values most often given to this field across the entity it describes (top 20), most used first. Useful for filter suggestions.

AttributeDefinition.createdAt ● ISO8601DateTime! non-null scalar common

When the definition was created.

AttributeDefinition.description ● String scalar common

What this field captures.

AttributeDefinition.entityType ● AttributeEntityTypeEnum! non-null enum common

The kind of record this definition describes.

AttributeDefinition.handle ● String scalar common

A stable slug used to reference the definition. Unique per company and entity type.

AttributeDefinition.id ● ID! non-null scalar common

Stable identifier of the definition.

AttributeDefinition.name ● String! non-null scalar common

Display name of the field, as people see it.

AttributeDefinition.settings ● AttributeDefinitionSettings! non-null object common

Where the field is offered across the interface.

AttributeDefinition.updatedAt ● ISO8601DateTime! non-null scalar common

When the definition last changed.

Returned By

attributesAddDefinition mutation ● attributesUpdateDefinition mutation

Member Of

AttributeDefinitionConnection object ● AttributeDefinitionEdge object