Choose a version:

Metafield

object

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 FieldsFields

Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the storefront metafield was created.
Anchor to descriptiondescription •String: The description of a metafield.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to keykey •String! non-null: The unique identifier for the metafield within its namespace.
Anchor to namespacenamespace •String! non-null: The container for a group of metafields that the metafield is associated with.
Anchor to parentResourceparentResource •MetafieldParentResource! non-null: The type of resource that the metafield is attached to.
Anchor to referencereference •MetafieldReference: Returns a reference object if the metafield's type is a resource reference.
Anchor to referencesreferences •MetafieldReferenceConnection: A list of reference objects if the metafield's type is a resource reference list.
Anchor to typetype •String! non-null: The type name of the metafield. Refer to the list of supported types.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the metafield was last updated.
Anchor to valuevalue •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 MutationsMutations

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.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node •interface

Was this section helpful?