Choose a version:

cartNoteUpdate

mutation

Updates the note on a Cart. The note is a text field that stores additional information, such as a personalized message from the buyer or special instructions for the order.

Anchor to Arguments

Arguments

Anchor to cartIdcartId •ID! required: The ID of the cart.
Anchor to notenote •String! required: The note on the cart.

Was this section helpful?

Anchor to CartNoteUpdatePayload returnsCartNoteUpdatePayload 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

cartNoteUpdate reference

Mutation Reference

mutation cartNoteUpdate($cartId: ID!, $note: String!) {

cartNoteUpdate(cartId: $cartId, note: $note) {

cart {

# Cart fields

}

userErrors {

field

message

}

warnings {

# CartWarning fields

}

Input

{

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

"note": "<your-note>"

}