Docs
Dashboard

MetafieldDefinition

Interface

Shared fields implemented by metafield definition types.

#

Fields


categoryIds
[ID!]!

The category ids associated with this metafield definition.

hasCategoryRestrictions
Boolean!

The has category restrictions associated with this metafield definition.

id
ID!

The unique identifier of the resource.

isPrivate
Boolean!

The is private associated with this metafield definition.

key
String!

The key associated with this metafield definition.

kind
MetafieldDefinitionKind!

The kind associated with this metafield definition.

Possible enum values
  • DECIMAL

    Stores a decimal-number value.

  • DROPDOWN

    Stores one value selected from a predefined list.

  • INTEGER

    Stores a whole-number value.

  • JSON

    Stores structured JSON data.

  • MEDIA

    Stores a reference to media.

  • MONEY

    Stores a monetary amount and currency.

  • PRODUCT_PICKER

    Stores a reference to a product.

  • TAGS

    Stores multiple text tags.

  • TEXT

    Stores a text value.

  • VARIANT_PICKER

    Stores a reference to a product variant.

name
String!

The name associated with this metafield definition.

namespace
String!

The namespace associated with this metafield definition.

ownerType
MetafieldOwnerType!

The owner type associated with this metafield definition.

Possible enum values
  • CATEGORY

    A category can own the metafield.

  • COLLECTION

    A collection can own the metafield.

  • CUSTOMER

    A customer can own the metafield.

  • ORDER

    An order can own the metafield.

  • PRODUCT

    A product can own the metafield.

  • PRODUCT_ATTRIBUTE

    A product attribute can own the metafield.

  • PRODUCT_ATTRIBUTE_VALUE

    A product attribute value can own the metafield.

  • PRODUCT_VARIANT

    A product variant can own the metafield.

possibleValues
[String!]!

The distinct values currently assigned to this metafield, or the configured options for a dropdown.

#

Implementations


DecimalMetafieldDefinition
DecimalMetafieldDefinition

Fields returned for decimal metafield definition.

DropdownMetafieldDefinition

Fields returned for dropdown metafield definition.

IntegerMetafieldDefinition
IntegerMetafieldDefinition

Fields returned for integer metafield definition.

JsonMetafieldDefinition
JsonMetafieldDefinition

Fields returned for json metafield definition.

MediaMetafieldDefinition
MediaMetafieldDefinition

Fields returned for media metafield definition.

MoneyMetafieldDefinition
MoneyMetafieldDefinition

Fields returned for money metafield definition.

ProductPickerMetafieldDefinition
ProductPickerMetafieldDefinition

Fields returned for product picker metafield definition.

TagsMetafieldDefinition
TagsMetafieldDefinition

Fields returned for tags metafield definition.

TextMetafieldDefinition
TextMetafieldDefinition

Fields returned for text metafield definition.

VariantPickerMetafieldDefinition
VariantPickerMetafieldDefinition

Fields returned for variant picker metafield definition.