Cart item

Explore what information is available for cart items.

This type includes product details like price, quantity, total cost, and order-specific data such as applied coupons and discounts.

Properties

These are the available properties:

index

The order in which the item was added to the cart, starting at 0.

id

The unique identifier of the product. For example, "1234" or "a9b2745f".

name

The name of the product. For example, "Running shoes" or "Smartphone".

sku(optional)

The merchant's internal identifier for a product. For example, "CS-987-BLACK".

category(optional)

The category of the product. For example, "Shoes" or "Electronics".

brand(optional)

The brand of the product. For example, "Nike" or "Apple".

variant(optional)

The variation of the product, such as color or size. For example, "Red" for a red shirt or "XL" for an extra-large shirt.

displayPrice(optional)

The price of the product as displayed to the user. It usually refers to the price after any discounts are applied.

originalPrice(optional)

The original price of a product, also known as list price or full price. It usually refers to the price before any discounts are applied.

url(optional)

The URL of the product page.

image(optional)

The URL of the product image.

quantity

The number of units of this item in the cart, as a positive integer.

price

The price of a single unit of this item.

coupon(optional)

The coupon code applied specifically to this item for a discount. For example, "SUMMER20".

discount(optional)

Any discounts applied to this item, as an absolute value. For example, 10.00 for a $10 discount.

total

The total cost for this item, including any discounts and any other adjustment. It is usually the quantity multiplied by the price minus any discounts.