Offer

public class Offer

This represents the data that is shared between the terminal and the Android application. Setting the fields is only relevant when sending the data to the terminal, and conversely, getting the fields is only relevant when receiving this object from the terminal.

Methods

create

public static Offer create()

create Offer

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.

getAssociatedProductCode

public String getAssociatedProductCode()

Only applies to special product offers. This is optional.

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.

getMerchantOfferCode

public String getMerchantOfferCode()

Field for merchant specific offers. This is optional.

getName

public String getName()

A human-readable name. This is optional.

getOfferCombinable

public boolean getOfferCombinable()

Indicates if the offer may combined with other combinable offers. This is optional.

getOfferDiscount

public Decimal getOfferDiscount()

Discount as a GAAP-standard BigDecimal in the transaction currency. This is represented as negative amount. Either this or offerPercentDiscount is required, setting one will override the other.

getOfferId

public String getOfferId()

Alphanumeric offer reference. May be multiple offers in the same transaction. Could be a back end loaded offer that the POS will redeem or a manufacturer coupon code. This is required.

getOfferPercentDiscount

public Decimal getOfferPercentDiscount()

Percentage discount associated with the offer as a BigInteger(13,2). Either this or offerDiscount is required, setting one will override the other.

getOfferRefundable

public boolean getOfferRefundable()

Indicates if the purchase is returnable. This is optional.

getOfferStatus

public OfferStatus getOfferStatus()

The status of the offer. This is mainly applicable for LoyaltyVas

getOfferType

public OfferType getOfferType()

The type of the offer. This is required.

getProductCode

public String getProductCode()

Represented as SKU or UPC. This is optional.

getProgramId

public String getProgramId()

Unique reference to identify the Loyalty Program. This is required.

getQrCode

public String getQrCode()

Reserved for future use. This is ignored.

getReferenceBasketLineItemId

public String getReferenceBasketLineItemId()

The ID of the basket line if this is applied to a specific item in the basket. This is optional.

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.

getSpecialProductCode

public String getSpecialProductCode()

E.g., BOGO (Buy One Get One) using productCode and associatedProductCode. BOGOH (Buy One Get One Half Off) using productCode, percentageDiscount and associatedProductCode. This is optional.

getTax

public Decimal getTax()

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

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.

setAssociatedProductCode

public void setAssociatedProductCode(String productCode)

Refer to getAssociatedProductCode().

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.

setMerchantOfferCode

public void setMerchantOfferCode(String offerCode)

Refer to getMerchantOfferCode().

setName

public void setName(String name)

A human-readable name. This is optional.

setOfferCombinable

public void setOfferCombinable(boolean offerCombinable)

Refer to getOfferCombinable().

setOfferDiscount

public void setOfferDiscount(Decimal offerDiscount)

Refer to getOfferDiscount().

setOfferId

public void setOfferId(String offerId)

Refer to getOfferId().

setOfferPercentDiscount

public void setOfferPercentDiscount(Decimal percentDiscount)

Refer to getOfferPercentDiscount().

setOfferRefundable

public void setOfferRefundable(boolean offerRefundable)

Refer to getOfferRefundable().

setOfferStatus

public void setOfferStatus(OfferStatus offerStatus)

Refer to getOfferStatus().

setOfferType

public void setOfferType(OfferType offerType)

Refer to getOfferType().

setProductCode

public void setProductCode(String productCode)

Refer to getProductCode().

setProgramId

public void setProgramId(String programId)

Refer to getProgramId().

setQrCode

public void setQrCode(String qrCode)

Refer to getQrCode().

setReferenceBasketLineItemId

public void setReferenceBasketLineItemId(String basketLineItemId)

Refer to getReferenceBasketLineItemId().

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.

setSpecialProductCode

public void setSpecialProductCode(String productCode)

Refer to getSpecialProductCode().

setTax

public void setTax(Decimal tax)

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

setUpc

public void setUpc(String upc)

EAN / UPC of the item. This is optional.

update

public void update(Offer offer)

Someday, implement to allow in basket updates to make it easier when sending items between the service and back.