Choose a version:

cartAttributesUpdate

mutation

Updates the attributes on a Cart. Attributes are custom key-value pairs that store additional information, such as gift messages, special instructions, or order notes.

Anchor to Arguments

Arguments

Anchor to attributesattributes

•[AttributeInput!]!

required

An array of key-value pairs that contains additional information about the cart.

The input must not contain more than 250 values.

Show input fields

Anchor to cartIdcartId

•ID!

required

The ID of the cart.

Was this section helpful?

Anchor to CartAttributesUpdatePayload returnsCartAttributesUpdatePayload returns

Anchor to cartcart •Cart: The updated cart.

Show fields
Anchor to userErrorsuserErrors •[CartUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields
Anchor to warningswarnings •[CartWarning!]! non-null: A list of warnings that occurred during the mutation.

Show fields

Was this section helpful?

Examples

cartAttributesUpdate reference

Mutation Reference

mutation cartAttributesUpdate($attributes: [AttributeInput!]!, $cartId: ID!) {

cartAttributesUpdate(attributes: $attributes, cartId: $cartId) {

cart {

# Cart fields

}

userErrors {

field

message

}

warnings {

# CartWarning fields

}

Input

{

"attributes": [

{

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

"value": "<your-value>"

}

"cartId": "gid://shopify/<objectName>/10079785100"

}

Variables

{
  "attributes": [
    {
      "key": "<your-key>",
      "value": "<your-value>"
    }
  ],
  "cartId": "gid://shopify/<objectName>/10079785100"
}

Schema

input AttributeInput {
  key: String!
  value: String!
}