Metafield

Version 2019-04 (latest)

Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are comprised of keys, values, and value types.

Show definition

"""
Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are
comprised of keys, values, and value types.
"""
type Metafield implements LegacyInteroperability & Node {
  """
  The description of a metafield.
  """
  description: String
  """
  Globally unique identifier.
  """
  id: ID!
  """
  The key name for a metafield.
  """
  key: String!
  """
  The ID of the corresponding resource in the REST Admin API.
  """
  legacyResourceId: UnsignedInt64!
  """
  The namespace for a metafield.
  """
  namespace: String!
  """
  The value of a metafield.
  """
  value: String!
  """
  Represents the metafield value type.
  """
  valueType: MetafieldValueType!
}

Implements

Fields

description (String)

The description of a metafield.

id (ID!)

Globally unique identifier.

key (String!)

The key name for a metafield.

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

namespace (String!)

The namespace for a metafield.

value (String!)

The value of a metafield.

valueType (MetafieldValueType!)

Represents the metafield value type.

Sign up for a Partner account to get started.

Sign up