Cart Items Methods

SmartCart.automaticDiscountTotalAmountSaved ⇒ number¶

Returns the total amount saved from automatic discounts on items in the cart

Returns: number - the total amount saved from automatic discounts on items in the cart\ (excludes items with subtotal exclusions) ## SmartCart.compareAtPrice ⇒ number | null

Gets the compare at price for a cart item

Returns: number | null - The compare at price of the cart item or null if not applicable

SmartCart.decreaseItem¶

Decreases the quantity of a cart item

Example

// Decrease quantity of an item (removes if quantity becomes 0)
const items = SmartCart.items();
if (items.length > 0 && items[0].quantity > 1) {
  SmartCart.decreaseItem(items[0], () => {
    console.log('Item quantity decreased');
  });
}

SmartCart.hasAutomaticDiscountApplied ⇒ boolean¶

Determines whether any of the items in the cart have an automatic discount applied

Returns: boolean - Boolean indicating whether any of the items in the cart have an automatic discount applied ## SmartCart.hasItemProperties ⇒ boolean

Determines if the cart item has any content it should render in the line item properties area in the Smart Cart

Returns: boolean - Whether the cart item has any properties to render (or a delivery frequency with Switch to Subscription disabled)

SmartCart.hasItems ⇒ boolean¶

Determines whether the cart has items

Returns: boolean - Boolean indicating whether the cart has items

Example

// Check if cart has items before showing checkout
if (SmartCart.hasItems()) {
  console.log('Cart has items, ready for checkout');
} else {
  console.log('Cart is empty');
}

SmartCart.hasLineItemDiscount ⇒ boolean¶

Determines whether the cart item has a line item discount

Returns: boolean - Boolean indicating whether the cart item has a line item discount

SmartCart.hiddenItems ⇒ Array.<object>¶

Returns the hidden items in the cart

Returns: Array.<object> - Array of hidden items in the cart ## SmartCart.hideQuantitySelectors ⇒ boolean

Determines whether the quantity selectors should be hidden for the cart item\ based on product tags or properties

Returns: boolean - Boolean indicating whether the quantity selectors should be hidden

SmartCart.increaseItem¶

Increases the quantity of a cart item

Example

// Get the first item and increase its quantity
const items = SmartCart.items();
if (items.length > 0) {
  SmartCart.increaseItem(items[0], () => {
    console.log('Item quantity increased');
  });
}

SmartCart.isHiddenItem ⇒ boolean¶

Determines whether the cart item should be hidden in the Smart Cart based on product tags or properties

Returns: boolean - Boolean indicating whether the cart item should be hidden

SmartCart.itemCount ⇒ number¶

Returns the total number of items in the cart (excluding hidden items)

Returns: number - The total number of items in the cart

Example

// Update a custom cart counter element
const count = SmartCart.itemCount();
document.querySelector('.my-cart-count').textContent = count;

// Conditionally show/hide empty cart message
if (count === 0) {
  document.querySelector('.empty-cart-message').style.display = 'block';
}

SmartCart.itemHasDiscount ⇒ boolean¶

Determines whether the cart item has a discount

Returns: boolean - Boolean indicating whether the cart item has a discount

SmartCart.itemPrice ⇒ number¶

Gets the price for a cart item

Returns: number - The price of the cart item

SmartCart.itemProductTagsClasses ⇒ string¶

Gets a string of tag-based classes for the line item

Returns: string - String of tag-based classes for the line item

SmartCart.itemProperties ⇒ Array.<object>¶

Gets the line item properties to display in the cart

Returns: Array.<object> - Array of properties for the item

SmartCart.itemPropertyClasses ⇒ string¶

Gets a string of multiple property-based classes for the line item

Returns: string - String of multiple property-based classes for the line item

SmartCart.itemPropertyKeyClass ⇒ string¶

Gets a single CSS class for the line item property key

Returns: string - single CSS class for the line item property key

SmartCart.itemPropertyValueClass ⇒ string¶

Gets a single CSS class for the line item property value

Returns: string - single CSS class for the line item property value

SmartCart.itemURL ⇒ string¶

Gets the URL for a cart item

Returns: string - The URL for the cart item

SmartCart.items ⇒ Array.<object>¶

Returns the items in the cart

Returns: Array.<object> - Array of items in the cart

Example

// Get all items in the cart
const items = SmartCart.items();

// Log each item's title and quantity
items.forEach(item => {
  console.log(`${item.title} x ${item.quantity}`);
});

// Calculate total quantity across all items
const totalQty = items.reduce((sum, item) => sum + item.quantity, 0);
console.log('Total items:', totalQty);

SmartCart.itemsWithSubtotalExclusions ⇒ Array.<object>¶

Gets the cart items with or without subtotal exclusions

Returns: Array.<object> - Array of cart items

SmartCart.lineItemDiscountMessage ⇒ string | null¶

Gets the discount message for a line item

Returns: string | null - The discount message or null if no discount

SmartCart.removeItem¶

Removes an item from the cart

Example

// Remove the first item from the cart
const items = SmartCart.items();
if (items.length > 0) {
  SmartCart.removeItem(items[0], () => {
    console.log('Item removed from cart');
  });
}