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

CartNoteUpdatePayload

Payload returned by the cartNoteUpdate mutation

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 (the updated cart after the note update operation) and UserError objects (any errors encountered during the update process).

Example

{
  cartNoteUpdate(input: { cartId: "eyJhbGciOiJIUzI1NiJ9...", note: "Gift message" }) {
    cart {
      id
      note
    }
    userErrors {
      field
      message
    }
  }
}

Implements

No interfaces are implemented by this type.