Choose a version:

cartMetafieldsSet

mutation

Sets Metafield values on a cart, creating new metafields or updating existing ones. Accepts up to 25 metafields per request.

Cart metafields can automatically copy to order metafields when an order is created, if there's a matching order metafield definition with the cart to order copyable capability enabled.

Note

This mutation doesn't trigger Shopify Functions. Changes aren't available to Shopify Functions until the buyer goes to checkout or performs another cart interaction that triggers the functions.

Anchor to Arguments

Arguments

Anchor to metafieldsmetafields

•[CartMetafieldsSetInput!]!

required

The list of Cart metafield values to set. Maximum of 25.

The input must not contain more than 250 values.

Was this section helpful?

Anchor to CartMetafieldsSetPayload returnsCartMetafieldsSetPayload returns

Anchor to metafieldsmetafields •[Metafield!]: The list of cart metafields that were set.
Anchor to userErrorsuserErrors •[MetafieldsSetUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

cartMetafieldsSet reference

Mutation Reference

mutation cartMetafieldsSet($metafields: [CartMetafieldsSetInput!]!) {

cartMetafieldsSet(metafields: $metafields) {

metafields {

# Metafield fields

}

userErrors {

field

message

}

Input

{

"metafields": [

{

"ownerId": "gid://shopify/<objectName>/10079785100",

"key": "<your-key>",

"value": "<your-value>",

"type": "<your-type>"

}

]

}

Variables

{
  "metafields": [
    {
      "ownerId": "gid://shopify/<objectName>/10079785100",
      "key": "<your-key>",
      "value": "<your-value>",
      "type": "<your-type>"
    }
  ]
}

Schema

input CartMetafieldsSetInput {
  ownerId: ID!
  key: String!
  value: String!
  type: String!
}