Skip to navigation

CartDigitalItem

OBJECT
Cart digital item.

Fields

entityIdStringRequired

The line-item ID.

productEntityIdIntegerRequired
ID of the product.
nameStringRequired
The item's product name.
isMutableBooleanRequired
Whether you can change or remove the item from the cart. Items that are immutable include those added automatically by promotions.
quantityIntegerRequired
Quantity of this item.
isTaxableBooleanRequired
Whether the item is taxable.
discountslist of CartDiscountsRequired
List of discounts applied to this item.
discountedAmountMoneyRequired

The total value of all discounts applied to this item (excluding coupon).

discountedAmountInDisplayCurrencyMoneyRequired
Discounted amount in display currency.
couponAmountMoneyRequired
The total value of all coupons applied to this item.
couponAmountInDisplayCurrencyMoneyRequired
Coupon amount in display currency.
listPriceMoneyRequired

The net item price before discounts and coupons. It is based on the product default price or sale price (if set) configured in BigCommerce Admin.

listPriceInDisplayCurrencyMoneyRequired
List price in display currency.
originalPriceMoneyRequired

An item’s original price is the same as the product default price in the admin panel.

originalPriceInDisplayCurrencyMoneyRequired
Original price in display currency.
salePriceMoneyRequired

Item’s price after all discounts are applied. (The final price before tax calculation).

salePriceInDisplayCurrencyMoneyRequired
Sale price in display currency.
extendedListPriceMoneyRequired
Item's list price multiplied by the quantity.
extendedListPriceInDisplayCurrencyMoneyRequired
Extended list price in display currency.
extendedSalePriceMoneyRequired
Item's sale price multiplied by the quantity.
extendedSalePriceInDisplayCurrencyMoneyRequired
Extended sale price in display currency.
extendedComparisonPriceMoneyRequired
The items comparison price multiplied by the quantity.
extendedComparisonPriceInDisplayCurrencyMoneyRequired
The items comparison price multiplied by the quantity in display currency.
comparisonPriceMoneyRequired
The comparison price of the item.
comparisonPriceInDisplayCurrencyMoneyRequired
Comparison price in display currency.
retailPriceMoneyRequired
The retail price of the item.
retailPriceInDisplayCurrencyMoneyRequired
Retail price in display currency.
taxTotalMoneyRequired
The total tax for the item.
taxTotalInDisplayCurrencyMoneyRequired
Tax total in display currency.
selectedOptionslist of CartSelectedOptionsRequired
The list of selected options for this product.
pathStringRequired
Relative URL path to product page.
urlStringRequiredDeprecated

The product URL.

Deprecated: Use path instead

parentEntityIdStringOptional
The product is part of a bundle such as a product pick list, then the parentId or the main product id will populate.
variantEntityIdIntegerOptional
ID of the variant.
skuStringOptional
SKU of the variant.
brandStringOptional
The product brand.
addedByAttributeIdStringOptional
The ID of the option that caused this item to be added to the cart, if applicable.
stockPositionCartItemStockPositionOptional
Stock position information for the item, indicating quantities on hand, backordered, and out of stock.
imageImageOptional
Image for the item.
baseCatalogProductProductOptional
The base product information.
catalogProductWithOptionSelectionsProductOptional
The product with option selections applied.
bulkPriceCartBulkPriceOptional
Bulk price information for this item.
imageUrlStringOptionalDeprecated

URL of an image of this item, accessible on the internet.

Deprecated: Use image field instead.

Referenced by