Updating cart quantities

How to update the quantity of an item in your shopping cart

Problem

You have some items in your shopping cart and you want to update their quantity.

A sample cart quantity selection

Solution

To set the quantity of an item in your shopping cart you need to change its quantity attribute. To do that, send a PATCH request to the /api/line_items/:id endpoint.

Example

Request

The following request updates the line item identified by the "aBmNkPQRst" ID with a quantity of 6:

curl -g -X PATCH \
  'http://yourdomain.commercelayer.io/api/line_items/aBmNkPQRst' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -d '{
  "data": {
    "id": "aBmNkPQRst",
    "type": "line_items",
    "attributes": {
      "quantity": 6
    }
  }
}'

Response

On success, the API responds with a 200 OK status code, returning the line item object updated with the new quantity:

{
  "data": {
    "id": "aBmNkPQRst",
    "type": "line_items",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/line_items/aBmNkPQRst"
    },
    "attributes": {
      "sku_code": "TSHIRTB5B5B5XL",
      "quantity": 6,
      "currency_code": "EUR",
      "unit_amount_cents": 12900,
      "unit_amount_float": 129.0,
      "formatted_unit_amount": "129,00€",
      "options_amount_cents": 0,
      "options_amount_float": 0.0,
      "formatted_options_amount": "$0.00",
      "total_amount_cents": 77400,
      "total_amount_float": 774.0,
      "formatted_total_amount": "774,00€",
      "name": "Grey T-Shirt XL",
      "image_url": "https://img.yourdomain.com/skus/TSHIRTB5B5B5XL.png",
      "tax_rate": null,
      "tax_breakdown": {},
      "item_type": "skus",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": null,
      "metadata": {}
    },
    "relationships": {
      "order": {
        "links": {...}
      },
      "item": {
        "links": {...}
      },
      "line_item_options": {
        "links": {...}
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "Qr8sStTuUv",
      "trace_id": "0a3b6c9d2e5f8a1b4c7d0e3f6a9b2c5d8e1f4a7b0c3d6e9f2a5b8c1d4e7f0a3b6"
    }
  },
  "meta": {
    "mode": "test",
    "organization_id": "Qr8sStTuUv",
    "trace_id": "0a3b6c9d2e5f8a1b4c7d0e3f6a9b2c5d8e1f4a7b0c3d6e9f2a5b8c1d4e7f0a3b6"
  }
}

Mapping

The image below shows how the related action on the product quantity is mapped to a specific attribute of the line item object.

A sample cart quantity update mapping

More to read

See our documentation if you need more information on how to update a line item.