Add Cart Line Items

import requests
url = "https://api.bigcommerce.com/stores/store_hash/v3/carts/cartId/items"
payload = { "custom_items": [
        {
            "sku": "abc-123",
            "name": "Custom Product",
            "quantity": 1,
            "list_price": 10,
            "image_url": "https://pathtoproductimage/ProductDefault.png"
        }
    ] }
headers = {
    "X-Auth-Token": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "data": {
    "id": "string",
    "customer_id": 1,
    "channel_id": 1,
    "email": "string",
    "currency": {
      "code": "usd"
    },
    "tax_included": true,
    "base_amount": 1.1,
    "discount_amount": 1.1,
    "manual_discount_amount": 1.1,
    "cart_amount": 1.1,
    "coupons": [
      {
        "code": "string",
        "id": "string",
        "coupon_type": "0",
        "discounted_amount": 1.1,
        "display_name": "20% Off"
      }
    ],
    "discounts": [
      {
        "id": "coupon",
        "discounted_amount": 1.1
      }
    ],
    "line_items": {
      "physical_items": [
        {
          "variant_id": 358,
          "product_id": 12,
          "quantity": 5,
          "id": "6e193ce6-f327-4dcc-b75e-72cf6738525e",
          "parent_id": "string",
          "sku": "SMGREEN",
          "name": "T-Shirt",
          "url": "http://your-store-url.mybigcommerce.com/your-product/",
          "taxable": false,
          "image_url": "https://pathtoproductimage/ProductDefault.png",
          "discounts": [
            {
              "id": "string",
              "discounted_amount": 1.1
            }
          ],
          "coupons": 1.1,
          "discount_amount": 4,
          "coupon_amount": 1.1,
          "original_price": 1.1,
          "list_price": 1.1,
          "sale_price": 1.1,
          "extended_list_price": 1.1,
          "extended_sale_price": 1.1,
          "is_require_shipping": false,
          "is_mutable": true,
          "added_by_promotion": false,
          "gift_wrapping": {
            "name": "Gift Wrap 1",
            "message": "Happy Birthday!",
            "amount": 1.99
          }
        }
      ],
      "digital_items": [
        {
          "id": "6e193ce6-f327-4dcc-b75e-72cf6738525e",
          "parent_id": "string",
          "variant_id": 358,
          "product_id": 12,
          "sku": "SMGREEN",
          "name": "T-Shirt",
          "url": "http://your-store-url.mybigcommerce.com/your-product/",
          "quantity": 5,
          "taxable": false,
          "image_url": "https://pathtoproductimage/ProductDefault.png",
          "discounts": [
            {
              "id": "string",
              "discounted_amount": 1.1
            }
          ],
          "coupons": 1.1,
          "discount_amount": 4,
          "coupon_amount": 1.1,
          "original_price": 1.1,
          "list_price": 1.1,
          "sale_price": 1.1,
          "extended_list_price": 1.1,
          "extended_sale_price": 1.1,
          "is_require_shipping": false,
          "is_mutable": true,
          "added_by_promotion": false,
          "download_file_urls": [
            "string"
          ],
          "download_page_url": "string",
          "download_size": "string"
        }
      ],
      "gift_certificates": [
        {
          "id": "string",
          "name": "string",
          "theme": "string",
          "amount": 1.1,
          "taxable": true,
          "sender": {
            "name": "string",
            "email": "string"
          },
          "recipient": {
            "name": "string",
            "email": "string"
          },
          "message": "string"
        }
      ],
      "custom_items": [
        {
          "id": "string",
          "sku": "string",
          "name": "string",
          "quantity": "string",
          "list_price": "string",
          "extended_list_price": 1.1,
          "image_url": "https://pathtoproductimage/ProductDefault.png"
        }
      ]
    },
    "created_time": "string",
    "updated_time": "string",
    "locale": "string",
    "promotions": {
      "banners": {
        "id": "string",
        "type": "string",
        "page": [
          "string"
        ],
        "text": "string"
      }
    },
    "version": 1
  },
  "meta": {}
}

Adds line item to the Cart.

Usage Notes

To add a custom item use custom_items.

By default, overriding a product’s list_price makes it ineligible for V3 product-level promotions. In Store Settings under Promotions and Coupons in the control panel, you can change this behavior to allow promotions on overridden prices.

If a product has modifiers, omit the variant_id and instead use the option_selections array to describe both the variant and the modifier selections.

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 line item to the *Cart*. **Usage Notes** To add a custom item use `custom_items`. By default, overriding a product's list_price makes it ineligible for V3 product-level promotions. In **Store Settings** under **Promotions and Coupons** in the control panel, you can change this behavior to allow promotions on overridden prices. If a product has modifiers, omit the `variant_id` and instead use the `option_selections` array to describe both the **variant** and the **modifier** selections. 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.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Carts	modify	`store_cart`
Carts	read-only	`store_cart_read_only`
Information & Settings	modify	`store_v2_information`
Information & Settings	read-only	`store_v2_information`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

cartIdstringRequired

Query parameters

includelist of enumsOptional

redirect_urls: Create a direct link to a cart. This can be used for the /POST request for carts.
line_items.physical_items.options: The cart returns an abbreviated result. Use this to return physical items product options. To return the extended cart object, use in a /POST request.
line_items.digital_items.options: The cart returns an abbreviated result. Use this to return digital items product options. To return the extended cart object, use in a /POST request.
promotions.banners: Returns a list of eligible banners.

* `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts. * `line_items.physical_items.options`: The cart returns an abbreviated result. Use this to return physical items product options. To return the extended cart object, use in a /POST request. * `line_items.digital_items.options`: The cart returns an abbreviated result. Use this to return digital items product options. To return the extended cart object, use in a /POST request. * `promotions.banners`: Returns a list of eligible banners.

Allowed values:

Request

This endpoint expects an object.

line_itemslist of objectsOptional

gift_certificateslist of objectsOptional

custom_itemslist of objectsOptional

versionintegerOptional

The cart version that you expect to apply the updates. If the provided version doesn’t match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.

Response

dataobject

A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data.

metaobject

Response metadata.

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Query parameters

Request

Response

OAuth scopes

Authentication header

Further reading