updateCartItems mutation

The updateCartItems mutation allows you to modify items in the specified cart. You can also replace the current quantity of one or more cart items with the specified quantities. The mutation does not perform calculations to determine the quantity of cart items.

Setting the quantity to 0 removes an item from the cart.

Syntax

mutation: {updateCartItems(input: UpdateCartItemsInput): {UpdateCartItemsOutput}}

Example usage

The following example changes the quantity of cart item 13. The new quantity is 3.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
mutation {
  updateCartItems(
    input: {
      cart_id: "IeTUiU0oCXjm0uRqGCOuhQ2AuQatogjG",
      cart_items: [
        {
          cart_item_id: 13
          quantity: 3
        }
      ]
    }
  ){
    cart {
      items {
        id
        product {
          name
        }
        quantity
      }
      prices {
        grand_total{
          value
          currency
        }
      }
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
  "data": {
    "updateCartItems": {
      "cart": {
        "items": [
          {
            "id": "13",
            "product": {
              "name": "Strive Shoulder Pack"
            },
            "quantity": 3
          },
          {
            "id": "14",
            "product": {
              "name": "Affirm Water Bottle "
            },
            "quantity": 1
          }
        ],
        "prices": {
          "grand_total": {
            "value": 103,
            "currency": "USD"
          }
        }
      }
    }
  }
}

Input attributes

The UpdateCartItemsInput object is listed first. All child objects are listed in alphabetical order.

UpdateCartItemsInput attributes

The UpdateCartItemsInput object must contain the following attributes.

CartItemUpdateInput attributes

The CartItemUpdateInput object can contain the following attributes.

CustomizableOptionInput attributes

The CustomizableOptionInput object must contain the following attributes.

GiftMessageInput attributes

The GiftMessageInput object must contain the following attributes.

Output attributes

The UpdateCartItemsOutput object contains the Cart object.

Cart object

Cart query output provides more information about the Cart object.

Errors