Skip to Content
ReferenceStorefrontv1.1.0 API Reference (Latest)ObjectsCartNoteUpdatePayload

CartNoteUpdatePayload

Payload returned by the cartNoteUpdate mutation. Contains the updated cart and any errors that occurred during the note update operation.

Type Definition

type CartNoteUpdatePayload {
  cart: Cart
  userErrors: [UserError]!
}

Fields

FieldTypeDescription
cartCartThe updated cart
userErrors[UserError]!List of errors that occurred during cart note update

Relationships

CartNoteUpdatePayload is returned by the cartNoteUpdate mutation and contains references to the Cart object that was updated, along with any UserError objects that describe validation or processing errors that occurred during the mutation.

Example

mutation UpdateCartNote {
  cartNoteUpdate(cartId: "eyJhbGciOiJIUzI1NiJ9...", note: "Gift for anniversary") {
    cart {
      id
      note
    }
    userErrors {
      field
      message
    }
  }
}

Implements

This type does not implement any interfaces.