Content-Type in header with default of application/json - string - required
include in query - string
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.
Updates an existing, single line item in the Cart.
Notes
Currently, only updating list_price and quantity are supported. Updating a product’s list_price will make that item ineligible for V3 product-level promotions.
If the product has modifiers, omit the variant_id and instead use the option_selections array to describe both the variant and the modifier selections.
If a variant needs to be changed or updated, the product will need to be removed and re-added to the cart with the correct variants using the Add Cart Line Items endpoint.
custom_items cannot be updated via the API at this time. To update your cart, add a new updated custom item and delete the outdated one. If your cart contains only one line item, perform the add operation before the delete operation.
Deleting all line items from the cart will invalidate the cart.
Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results.
Authentication
X-Auth-Token in header - requiredShow details
Parameters
store_hash in path - string
itemId in path - string - required
include in query - string
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.
NOTE: Discounted line items are re-evaluated on cart actions and may be automatically added back to your cart with a new line item ID to satisfy promotional requirements.
Body
object | application/json
A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data.
idstring
Cart ID, provided after creating a cart with a POST request.
parent_idstring
Bundled items will have the ID of their parent item.
customer_idinteger
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
The currency. This is the same for both the cart and its subsequent checkout.
tax_includedboolean
base_amountnumber
Sum of cart line-item amounts before cart-level discounts, coupons, or taxes.
discount_amountnumber
Order-based discounted amount only - Excludes coupon discounts and product-based discounts.
cart_amountnumber
Sum of cart line-item amounts minus cart-level discounts and coupons. This amount includes taxes (where applicable).
couponsarray[object]
discountsarray[object]
line_itemsobject
GET
created_timestring
Time when the cart was created.
updated_timestring
Time when the cart was last updated.
channel_idinteger
The channel ID. If no channel is specified, defaults to 1.
localestring
Locale of the cart. Accepts strings of format xx or xx-YY. Uses the ISO-639 standard format.
promotionsobject
This is available only when "include=promotions.banners" is presented in the URL.