CartItem SFO

note

Field	Type	Comment/Sample
amount	[BigDecimal](./bigdecimal-sfo.md)	total amount of item (unit cost * quantity)
autoOrderSchedule	string	if the item is an auto order and the customer has chosen a schedule, this field will contain it. this field is modified later in the checkout stream.
description	string	item description
descriptionWithBreaks	string	item description with newlines changed to tags for easier display
discount	[BigDecimal](./bigdecimal-sfo.md)	discount, if any
formattedAmount	[BigDecimal](./bigdecimal-sfo.md)	formatted amount with currency symbols, commas, and periods
formattedDiscount	string	formatted discount with currency symbols, commas, and periods
hasDiscount	boolean	if true, the item has a discount. useful to show/hide table colums or divs
highlight	boolean	if true, this item should be highlighted for some reason
itemIndex	integer	the item position in the current cart.
merchantItemOid	integer	internal unique id of the item
merchantItemId	string	item id
options	[CartItemOption](./cartitemoption-sfo.md)[ ]	an array of item options, if any
quantity	[BigDecimal](./bigdecimal-sfo.md)	quantity of item in the cart
remove	boolean	flag to instruct cart engine to remove this item. if remove is true, the item is removed. see view_cart.vm for usage example.
showArbitraryUnitCost	boolean	if true, the arbitrary unit cost should be displayed.
thumbnailHeight	integer	default is 80 (pixels)
thumbnailUrl	string
thumbnailWidth	integer	default is 80 (pixels)
viewUrl	string	the url of viewing this item. this points to the catalog page for the item, if there is one. check this value for null before automatically creating a link to it.

Methods

Method	Returns	Parameters	Parameter Types	Comments/Sample

See Also

CartItem

Properties

Field	Type	Comment/Sample
amount	string	notice this is a formatted string with currency symbols
arbitraryUnitCost	string	if an arb. cost is in place, this is the value.
description	string
discount	string	notice this is a formatted string with currency symbols
itemIndex	integer	the item position in the current cart.

Method	Returns	Parameters	Parameter Types	Comments/Sample
getItem()	[Item](./item-sfo.md)			returns the underlying Item. While CartItem contains information specific to the current shopping cart (quantity in cart, etc), this Item object contains the general item information.

See Also