Metafield
object

Choose a version:

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

Anchor to section titled 'Fields and connections'

Fields and connections

Anchor to Metafield.createdAt createdAt DateTime! non-null: The date and time when the storefront metafield was created.
Anchor to Metafield.description description String: The description of a metafield.
Anchor to Metafield.id id ID! non-null: A globally-unique ID.
Anchor to Metafield.key key String! non-null: The unique identifier for the metafield within its namespace.
Anchor to Metafield.namespace namespace String! non-null: The container for a group of metafields that the metafield is associated with.
Anchor to Metafield.parentResource parentResource MetafieldParentResource! non-null: The type of resource that the metafield is attached to.
Anchor to Metafield.reference reference MetafieldReference: Returns a reference object if the metafield's type is a resource reference.
Anchor to Metafield.references references MetafieldReferenceConnection: A list of reference objects if the metafield's type is a resource reference list.
Anchor to Metafield.type type String! non-null: The type name of the metafield. Refer to the list of supported types.
Anchor to Metafield.updatedAt updatedAt DateTime! non-null: The date and time when the metafield was last updated.
Anchor to Metafield.value value String! non-null: The data stored in the metafield. Always stored as a string, regardless of the metafield's type.

Was this section helpful?

Anchor to section titled 'Mutations'

Mutations

Anchor to cartMetafieldsSet cartMetafieldsSet mutation: 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.