Add Cart Line Items | BigCommerce Developer Center

import requests
url = "https://your_store.example.com/api/storefront/carts/cartId/items"
payload = {
    "lineItems": [
        {
            "productId": 230,
            "optionSelections": [
                {
                    "optionId": 10,
                    "optionValue": 117
                },
                {
                    "optionId": 11,
                    "optionValue": 125
                }
            ],
            "quantity": 2,
            "variantId": 124
        }
    ],
    "version": 1
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": "string",
  "customerId": 0,
  "email": "string",
  "currency": {
    "code": "string",
    "decimalPlaces": 2,
    "name": "US Dollar",
    "symbol": "$"
  },
  "isTaxIncluded": true,
  "baseAmount": 0,
  "discountAmount": 0,
  "cartAmount": 0,
  "coupons": [
    {
      "code": "string",
      "couponType": 0,
      "discountedAmount": 0,
      "displayName": "$1.00 off the order total",
      "id": "string"
    }
  ],
  "discounts": [
    {
      "discountedAmount": 0,
      "id": "string"
    }
  ],
  "lineItems": {
    "customItems": [],
    "digitalItems": [
      {
        "quantity": 0,
        "brand": "string",
        "couponAmount": 0,
        "discountAmount": 0,
        "discounts": [
          {
            "discountedAmount": 0,
            "id": 0
          }
        ],
        "extendedListPrice": 0,
        "extendedSalePrice": 0,
        "id": "4",
        "imageUrl": "http://example.com",
        "isMutable": true,
        "isTaxable": true,
        "listPrice": 0,
        "name": "string",
        "options": [
          {
            "name": "string",
            "nameId": 0,
            "value": "string",
            "valueId": 0
          }
        ],
        "originalPrice": 0,
        "parentId": "6",
        "productId": 0,
        "salePrice": 0,
        "sku": "string",
        "type": "digital",
        "url": "http://example.com",
        "variantId": 7
      }
    ],
    "giftCertificates": [
      {
        "amount": 0,
        "recipient": {
          "email": "user@example.com",
          "name": "string"
        },
        "sender": {
          "email": "user@example.com",
          "name": "string"
        },
        "theme": "string",
        "id": "string",
        "taxable": true,
        "message": "string",
        "name": "string",
        "type": "giftCertificate"
      }
    ],
    "physicalItems": [
      {
        "quantity": 0,
        "brand": "string",
        "couponAmount": 0,
        "discountAmount": 0,
        "discounts": [
          {
            "discountedAmount": 0,
            "id": "string"
          }
        ],
        "extendedListPrice": 0,
        "extendedSalePrice": 0,
        "giftWrapping": {
          "amount": 0,
          "message": "string",
          "name": "string"
        },
        "id": "4",
        "imageUrl": "http://example.com",
        "isMutable": true,
        "isShippingRequired": true,
        "isTaxable": true,
        "listPrice": 0,
        "name": "string",
        "options": [
          {
            "name": "string",
            "nameId": 0,
            "value": "string",
            "valueId": 0
          }
        ],
        "originalPrice": 0,
        "parentId": 6,
        "productId": 0,
        "salePrice": 0,
        "sku": "string",
        "type": "physical",
        "url": "http://example.com",
        "variantId": 7
      }
    ]
  },
  "createdTime": "string",
  "updatedTime": "string",
  "locale": "string"
}

Adds a line items to the Cart.

Notes

Substitute your storefront domain for yourstore.example.com.

The Send a Test Request feature is not currently supported for this endpoint.

To prevent lost updates due to concurrent requests overriding changes made by others, it is recommended to enable optimistic concurrency control by including the version field in the request payload. If the provided version does not match the version on the server, a conflict error will be returned, which the client can handle accordingly.

Adds a line items to the *Cart*. > #### Notes > * Substitute your storefront domain for `yourstore.example.com`. > * The Send a Test Request feature is not currently supported for this endpoint. > * To prevent lost updates due to concurrent requests overriding changes made by others, it is recommended to enable optimistic concurrency control by including the `version` field in the request payload. If the provided version does not match the version on the server, a conflict error will be returned, which the client can handle accordingly.

Path parameters

cartIdstringRequired

Request

objectRequired

Response

idstringformat: "UUID"

Cart ID, provided after creating a cart with a POST.

customerIdinteger

ID of the customer to which the cart belongs.

emailstring

The cart's email. This is the same email that is used in the billing address

currencyobject

This will always be the same between cart and checkout.

isTaxIncludedboolean

Whether this item is taxable.

baseAmountdouble

Cost of cart’s contents, before applying discounts.

discountAmountdouble

Order based discounted amount only - Coupon discounts and product based discounts are excluded.

cartAmountdouble

Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes (where applicable).

couponslist of objects

discountslist of objects

lineItemsobject

createdTimestringformat: "ISO-8601"

Time when the cart was created.

updatedTimestringformat: "ISO-8601"

Time when the cart was last updated.

localestring

Locale of the cart.

versioninteger

The current version of the cart increments with each successful update. You can use it to enable optimistic concurrency control for subsequent updates.

Errors

409

Conflict Error