Skip to navigation
RESTAdminManagementCartsItems

Update Cart Line Item

Updates an existing, single line item in the Cart.

Notes

Send one of line_item, custom_item, or gift_certificate in the request body, matching the type of the line item you’re updating. Use line_item for physical and digital products.

A line_item update requires quantity and either product_id or variant_id. You can also update the following fields:

  • list_price: Overrides the item’s price. 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.
  • name: Overrides the item’s name.
  • weight and dimensions: Override the item’s shipping weight and dimensions.
  • product_options: Changes the item’s variant and modifier selections. Send product_id with it; a request with only variant_id returns a 422 error. The line item keeps its ID. Sending a different variant_id, or sending option_selections, doesn’t change the item’s options.
  • gift_wrapping: Adds or replaces the item’s gift wrapping. Set it to null to remove gift wrapping.

A custom_item update requires sku, name, quantity, and list_price. A gift_certificate update requires name, theme, amount, quantity, sender, and recipient.

Deleting all line items from the cart will invalidate the cart.

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 NamePermissionParameter
Cartsmodifystore_cart
Cartsread-onlystore_cart_read_only
Information & Settingsmodifystore_v2_information
Information & Settingsread-onlystore_v2_information

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Path parameters

cartIdstringRequiredformat: "UUID"
The identifier of a specific cart.
itemIdstringRequiredformat: "number"
The ID of the line item.
store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

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.
  • line_items.physical_items.stock_position: Returns backorder and stock availability details for physical items.
  • line_items.digital_items.stock_position: Returns backorder and stock availability details for digital items. Since digital products cannot be backordered, backorder values are always zero.
  • promotions.banners: Returns a list of eligible banners.

Request

This endpoint expects an object.
line_itemobjectOptional

Updates a physical or digital product line item. Send product_id, variant_id, or both.

custom_itemobjectOptional
Updates a custom item.
gift_certificateobjectOptional
Updates a gift certificate.
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

The requested cart.
dataobjectOptional

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

metaobjectOptional
Response metadata.

Errors

409
Conflict Error