Modifier

public class Modifier

Allows attaching a modifier to an existing merchandise object.

Methods

create

public static Modifier create()

create Modifier

getAmount

public Decimal getAmount()

The final total amount for this item as a GAAP-standard BigDecimal, including the extendedPrice, tax, and discount. This is required.

getAmounts

public AmountTotals getAmounts()

Returns the amounts for this item in the basket.

getAttachedToBasketItemId

public String getAttachedToBasketItemId()

return basket item id attached

getBasketItemId

public String getBasketItemId()

The unique ID for this merchandise item as it exists in the basket. If multiple items with the same SKU/UPC are added individually to the basket, this basket item ID will be used to distinguish between them. This will be generated by the service if not provided.

getDescription

public String getDescription()

A human-readable description. This is optional.

getDisplayLine

public String getDisplayLine()

The line to display to the customer. This may include standard tab and line break characters if desired for normal text, or this may use HTML formatting. This will be generated by the service if not provided.

getDisplayOrder

public int getDisplayOrder()

The display order for this item. This is generally auto-incremented as items are added to the basket, using a gap value to allow insertion between items at a later time.

getName

public String getName()

A human-readable name. This is optional.

getQuantity

public Decimal getQuantity()

Refer to setQuantity(Decimalquantity).

getRemoved

public boolean getRemoved()

Set to true if this item was removed from the basket, useful for business analytics. Removed items do not contribute to the total transaction amount, and are not displayed nor on the receipt. This is set by the service.

getSequence

public int getSequence()

The sequence for this item. This is generally auto-incremented as items are added to the basket. This is generally set by the underlying service, but can be set manually if required.

getSku

public String getSku()

SKU of the item. This is optional.

getTax

public Decimal getTax()

The tax for this merchandise based on total quantity as a GAAP-standard BigDecimal. This is optional.

getUnitOfMeasurement

public String getUnitOfMeasurement()

return The unit of Measurement for Quantity value

getUpc

public String getUpc()

EAN / UPC of the item. This is optional.

setAmount

public void setAmount(Decimal amount)

The final total amount for this item as a GAAP-standard BigDecimal, including the extendedPrice, tax, and discount. This is required.

setAmounts

public void setAmounts(AmountTotals amounts)

Set the amounts for this item.

setAttachedToBasketItemId

public void setAttachedToBasketItemId(String attachedToBasketItemId)

Set the basket item ID for the item to which this modifier is attached. If not set, this will be set automatically.

setBasketItemId

public void setBasketItemId(String itemId)

The unique ID for this merchandise item as it exists in the basket. If multiple items with the same SKU/UPC are added individually to the basket, this basket item ID will be used to distinguish between them. This will be generated by the service if not provided.

setDescription

public void setDescription(String description)

A human-readable description. This is optional.

setDisplayLine

public void setDisplayLine(String displayLine)

The line to display to the customer. This may include standard tab and line break characters if desired for normal text, or this may use HTML formatting. This will be generated by the service if not provided.

setDisplayOrder

public void setDisplayOrder(int displayOrder)

The display order for this item. This is generally auto-incremented as items are added to the basket, using a gap value to allow insertion between items at a later time.

setName

public void setName(String name)

A human-readable name. This is optional.

setQuantity

public void setQuantity(Decimal quantity)

Refer to setQuantity(Decimalquantity).

setRemoved

public void setRemoved(boolean removed)

Set to true if this item was removed from the basket, useful for business analytics. Removed items do not contribute to the total transaction amount, and are not displayed nor on the receipt. This is set by the service.

setSequence

public void setSequence(int sequence)

The sequence for this item. This is generally auto-incremented as items are added to the basket. This is generally set by the underlying service, but can be set manually if required.

setSku

public void setSku(String sku)

SKU of the item. This is optional.

setTax

public void setTax(Decimal tax)

The tax for this merchandise based on total quantity as a GAAP-standard BigDecimal. This is optional.

setUnitOfMeasurement

public void setUnitOfMeasurement(String unitOfMeasurement)

The unit of Measurement for Quantity value

setUpc

public void setUpc(String upc)

EAN / UPC of the item. This is optional.