Metafield - storefront - OBJECT

Version: 2024-04

Description:

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

Access Scopes

Fields

  • createdAt: DateTime! - The date and time when the storefront metafield was created.
  • description: String - The description of a metafield.
  • id: ID! - A globally-unique ID.
  • key: String! - The unique identifier for the metafield within its namespace.
  • namespace: String! - The container for a group of metafields that the metafield is associated with.
  • parentResource: MetafieldParentResource! - The type of resource that the metafield is attached to.
  • reference: MetafieldReference - Returns a reference object if the metafield's type is a resource reference.
  • type: String! - The type name of the metafield. Refer to the list of [supported types](https://shopify.dev/apps/metafields/definitions/types).
  • updatedAt: DateTime! - The date and time when the metafield was last updated.
  • value: String! - The data stored in the metafield. Always stored as a string, regardless of the metafield's type.

Connections

  • references: MetafieldReferenceConnection

Related queries

Related mutations

  • cartMetafieldsSet Sets cart metafield values. Cart metafield values will be set regardless if they were previously created or not. Allows a maximum of 25 cart metafields to be set at a time.

Related Unions

Examples