Fields
productEntityIdIntegerRequired
ID of the product.
allowGiftWrappingBooleanRequired
Whether gift wrapping is allowed for this item.
nameStringRequired
The item's product name.
quantityIntegerRequired
Quantity of this item.
isTaxableBooleanRequired
Whether the item is taxable.
isMutableBooleanRequired
Whether you can change or remove the item from the cart. Items that are immutable include those added automatically by promotions.
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.
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.
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.
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.
extendedSalePriceMoneyRequired Item's sale price multiplied by the quantity.
extendedSalePriceInDisplayCurrencyMoneyRequired Extended sale price in display currency.
The retail price of the item.
retailPriceInDisplayCurrencyMoneyRequired Retail price in display currency.
The total tax for the item.
taxTotalInDisplayCurrencyMoneyRequired Tax total in display currency.
isShippingRequiredBooleanRequired
Whether this item requires shipping to a physical address.
The list of selected options for this item.
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.
Gift wrapping for this item.
The base product information.
catalogProductWithOptionSelectionsProductOptional The product with option selections applied.
Bulk price information for this item.
imageUrlStringOptionalDeprecated
URL of an image of this item, accessible on the internet.
Deprecated: Use image field instead.
Stock position information for the item, indicating quantities on hand, backordered, and out of stock.
Deprecated: Alpha version. Do not use in production.
