Skip to main content

AttributeValue Object

Represents a value of an attribute.

type AttributeValue implements Node {
  id: ID!
  name: String
  slug: String
  value: String
  translation(languageCode: LanguageCodeEnum!): AttributeValueTranslation
  inputType: AttributeInputTypeEnum
  reference: ID
  file: File
  richText: JSONString
  plainText: String
  boolean: Boolean
  date: Date
  dateTime: DateTime
  externalReference: String
}

Fields​

id ● ID!​

The ID of the attribute value.

name ● String​

Name of a value displayed in the interface.

slug ● String​

Internal representation of a value (unique per attribute).

value ● String​

Represent value of the attribute value (e.g. color values for swatch attributes).

translation ● AttributeValueTranslation​

Returns translated attribute value fields for the given language code.

languageCode ● LanguageCodeEnum!​

A language code to return the translation for attribute value.

inputType ● AttributeInputTypeEnum​

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

reference ● ID​

The ID of the referenced object.

file ● File​

Represents file URL and content type (if attribute value is a file).

richText ● JSONString​

Represents the text of the attribute value, includes formatting.

Rich text format. For reference see https://editorjs.io/

plainText ● String​

Represents the text of the attribute value, plain text without formatting.

boolean ● Boolean​

Represents the boolean value of the attribute value.

date ● Date​

Represents the date value of the attribute value.

dateTime ● DateTime​

Represents the date/time value of the attribute value.

externalReference ● String​

External ID of this attribute value.

Interfaces​

Node​

An object with an ID

Member Of​

AttributeValueCountableEdge object ● AttributeValueCreate object ● AttributeValueCreated object ● AttributeValueDelete object ● AttributeValueDeleted object ● AttributeValueTranslatableContent object ● AttributeValueTranslate object ● AttributeValueUpdate object ● AttributeValueUpdated object ● SelectedAttribute object