Docs
Dashboard

JsonMetafield

Object

Fields returned for json metafield.

#

Fields


allowEmpty
Boolean

Indicates whether an empty JSON value is allowed and normalized to an empty object.

categoryIds
[ID!]!

The category ids associated with this json metafield.

defaultValue
String!

The default raw JSON value used when no value is assigned.

hasAssignedValue
Boolean!

Indicates whether this owner has an explicit value assigned for the metafield.

hasCategoryRestrictions
Boolean!

Indicates whether the metafield is limited to specific product categories.

id
ID!

The unique ID of the metafield definition.

key
String!

The key that uniquely identifies this metafield within its namespace.

kind
MetafieldDefinitionKind!

The value kind supported by the 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 display name of the metafield definition.

namespace
String!

The namespace that groups this metafield definition.

ownerType
MetafieldOwnerType!

The owner type this metafield definition can be assigned to.

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.

value
String!

The validated raw JSON value of the metafield.