clover-android-sdk/com.clover.sdk.v3.order/IOrderServiceV3_1/Default

Default

public class Default implements IOrderServiceV3_1

Default implementation for IOrderServiceV3_1.

Constructors

IOrderServiceV3_1.Default

public void IOrderServiceV3_1.Default()

Properties

DESCRIPTOR

public final static String DESCRIPTOR

Functions

addAuthorization

public AuthorizationFdParcelable addAuthorization(String orderId, AuthorizationFdParcelable authorization, ResultStatus status)

Not available to non-Clover apps.

addBatchLineItemDiscounts

public OrderFdParcelable addBatchLineItemDiscounts(String orderId, List<String> lineItemIds, DiscountListFdParcelable discounts, ResultStatus status)

addBatchLineItemModifications

public OrderFdParcelable addBatchLineItemModifications(String orderId, List<String> lineItemIds, ModifierFdParcelable fdModifier, int quantity, ResultStatus status)

addCredit

public CreditFdParcelable addCredit(String orderId, CreditFdParcelable fdCredit, ResultStatus status)

Not available to non-Clover apps.

addCreditRefund

public CreditRefundFdParcelable addCreditRefund(String orderId, CreditRefundFdParcelable creditRefund, ResultStatus status)

Not available to non-Clover apps.

addCustomLineItem

public LineItemFdParcelable addCustomLineItem(String orderId, LineItemFdParcelable fdLineItem, boolean isTaxable, ResultStatus status)

Add a custom line item to an order.

addDiscount

public OrderFdParcelable addDiscount(String orderId, DiscountFdParcelable fdDiscount, ResultStatus status)

addDiscount2

public DiscountFdParcelable addDiscount2(String orderId, DiscountFdParcelable fdDiscount, ResultStatus status)

Just like addDiscount but returns a Discount instead of an Order.

addFixedPriceLineItem

public LineItemFdParcelable addFixedPriceLineItem(String orderId, String itemId, String binName, String userData, ResultStatus status)

Add a fixed-price line item to an order.

addFixedPriceLineItems

public LineItemListFdParcelable addFixedPriceLineItems(String orderId, String itemId, String binName, String userData, int numItems, ResultStatus status)

Add 1 or more fixed-price line item to an order.

addLineItemDiscount

public OrderFdParcelable addLineItemDiscount(String orderId, String lineItemId, DiscountFdParcelable fdDiscount, ResultStatus status)

addLineItemDiscount2

public DiscountFdParcelable addLineItemDiscount2(String orderId, String lineItemId, DiscountFdParcelable fdDiscount, ResultStatus status)

Just like addLineItemDiscount but returns a Discount instead of an Order.

addLineItemModification

public OrderFdParcelable addLineItemModification(String orderId, String lineItemId, ModifierFdParcelable fdModifier, ResultStatus status)

addLPMPayment

public OrderFdParcelable addLPMPayment(String orderId, PaymentFdParcelable payment, ResultStatus status)

Not available to non-Clover apps.

addMenuFixedPriceLineItems

public LineItemListFdParcelable addMenuFixedPriceLineItems(String orderId, String menuId, String itemId, String binName, String userData, int numItems, ResultStatus status)

addMenuPerUnitLineItems

public LineItemListFdParcelable addMenuPerUnitLineItems(String orderId, String menuId, String itemId, int unitQuantity, String binName, String userData, int numItems, ResultStatus status)

addMenuPerUnitLineItemsWithDecimal

public LineItemListFdParcelable addMenuPerUnitLineItemsWithDecimal(String orderId, String menuId, String itemId, int unitQuantity, int unitQtyDecimalDigits, String binName, String userData, int numItems, ResultStatus status)

addMenuVariablePriceLineItems

public LineItemListFdParcelable addMenuVariablePriceLineItems(String orderId, String menuId, String itemId, long price, String binName, String userData, int numItems, ResultStatus status)

addOnOrderUpdatedListener

public void addOnOrderUpdatedListener(IOnOrderUpdateListener listener)

addOnOrderUpdatedListener2

public void addOnOrderUpdatedListener2(IOnOrderUpdateListener2 listener)

addOrderFee

public OrderFdParcelable addOrderFee(String orderId, String orderFeeId, ResultStatus status)

This method can be used to apply an order fee to the order

addPayment

public OrderFdParcelable addPayment(String orderId, PaymentFdParcelable fdPayment, LineItemListFdParcelable fdLineItems, ResultStatus status)

Not available to non-Clover apps.

addPayment2

public OrderFdParcelable addPayment2(String orderId, PaymentFdParcelable fdPayment, LineItemListFdParcelable fdLineItems, ResultStatus status)

Not available to non-Clover apps.

addPayment3

public OrderFdParcelable addPayment3(String orderId, PaymentFdParcelable payment, LineItemListFdParcelable fdLineItems, boolean createOnServer, ResultStatus status)

This is a replacement for the methods addPayment2() and addLPMPayment() It will handle a payment with optional line items so can be used in full POS mode (Register, Dining) It will also handle both card transactions that have already been processed on server via /v1/pay or (via createOnServer boolean flag) will POST the transaction to the CreatePayment endpoint on server Additionally, it will support being called by SiTef apps if a) the device has TRANSACTION_OPERATION_MODE of SITEF, and b) if the calling package is in RAW_TRANSACTION_SERVICE_WHITELIST Not available to most non-Clover apps.

addPerUnitLineItem

public LineItemFdParcelable addPerUnitLineItem(String orderId, String itemId, int unitQuantity, String binName, String userData, ResultStatus status)

Add a per-unit line item to an order.

addPerUnitLineItems

public LineItemListFdParcelable addPerUnitLineItems(String orderId, String itemId, int unitQuantity, String binName, String userData, int numItems, ResultStatus status)

Add 1 or more per-unit line item to an order.

addPerUnitLineItemsWithDecimal

public LineItemListFdParcelable addPerUnitLineItemsWithDecimal(String orderId, String itemId, int unitQuantity, int unitQtyDecimalDigits, String binName, String userData, int numItems, ResultStatus status)

This method should be used when unit quatity comes from scale for reason of some compliance Add 1 or more per-unit line item to an order along with decimal precision.

addPreAuth

public OrderFdParcelable addPreAuth(String orderId, PaymentFdParcelable preAuth, ResultStatus status)

Not available to non-Clover apps.

addPrintGroup

public OrderFdParcelable addPrintGroup(String orderId, PrintGroupFdParcelable fdPrintGroup, ResultStatus status)

Add new PrintGroup on order object.

addRefund

public RefundFdParcelable addRefund(String orderId, RefundFdParcelable refund, ResultStatus status)

Not available to non-Clover apps.

addRefund3

public RefundFdParcelable addRefund3(String orderId, RefundFdParcelable fdRefund, Map passThroughExtras, ResultStatus resultStatus)

This is a replacement for the method refund2(), with passthroughs It will record a refund locally and also update refund on the server Additionally, it will support being called by SiTef apps if a) the device has TRANSACTION_OPERATION_MODE of SITEF, and b) if the calling package is in RAW_TRANSACTION_SERVICE_WHITELIST Not available to most non-Clover apps.

addRefundOffline

public RefundFdParcelable addRefundOffline(String orderId, RefundFdParcelable fdRefund, ResultStatus status)

Not available to non-Clover apps.

addServiceCharge

public OrderFdParcelable addServiceCharge(String orderId, String serviceChargeId, ResultStatus status)

Add a com.clover.sdk.v3.base.ServiceCharge to an order.

addServiceCharge2

public OrderFdParcelable addServiceCharge2(String orderId, String serviceChargeId, boolean isAutoApplied, ResultStatus status)

Add a com.clover.sdk.v3.base.ServiceCharge to an order with a flag if it was added automatically or not.

addTip

public OrderFdParcelable addTip(String orderId, String paymentId, long amount, boolean online, ResultStatus status)

Not available to non-Clover apps.

addTipWithAdditionalCharges

public OrderFdParcelable addTipWithAdditionalCharges(String orderId, String paymentId, long amount, List<AdditionalChargeAmount> addtionalChargeAmounts, boolean online, ResultStatus status)

Not available to non-Clover apps.

addVariablePriceLineItem

public LineItemFdParcelable addVariablePriceLineItem(String orderId, String itemId, long price, String binName, String userData, ResultStatus status)

Add a variably-priced line item to the order.

addVariablePriceLineItems

public LineItemListFdParcelable addVariablePriceLineItems(String orderId, String itemId, long price, String binName, String userData, int numItems, ResultStatus status)

Add 1 or more variably-priced line item to the order.

asBinder

public IBinder asBinder()

captureAuth

public AuthorizationFdParcelable captureAuth(String orderId, AuthorizationFdParcelable auth, ResultStatus status)

Capture the create/incremented authorization at server.

captureAuthorization

public OrderFdParcelable captureAuthorization(String orderId, AuthorizationFdParcelable authorization, ResultStatus status)

Not available to non-Clover apps.

capturePreAuth

public OrderFdParcelable capturePreAuth(String orderId, PaymentFdParcelable preAuth, LineItemListFdParcelable fdLineItems, ResultStatus status)

Not available to non-Clover apps.

capturePreAuthorization

public OrderFdParcelable capturePreAuthorization(String orderId, PaymentFdParcelable preAuth, PaymentFdParcelable closingPayment, LineItemListFdParcelable fdLineItems, ResultStatus status)

Not available to non-Clover apps.

cleanUpPreAuthAfterTransaction

public OrderFdParcelable cleanUpPreAuthAfterTransaction(String orderId, VoidReason voidReason, ResultStatus status)

Not available to non-Clover apps.

copyLineItems

public LineItemListFdParcelable copyLineItems(String sourceOrderId, String destinationOrderId, List<String> lineItemIds, ResultStatus status)

createAuthorization

public AuthorizationFdParcelable createAuthorization(String orderId, PaymentFdParcelable payment, ResultStatus status)

Authorise the particular payment and creates new authorization.

createLineItemsFrom

public LineItemMapFdParcelable createLineItemsFrom(String sourceOrderId, String destinationOrderId, List<String> lineItemIds, ResultStatus status)

createLineItemsFrom2

public LineItemMapFdParcelable createLineItemsFrom2(String sourceOrderId, String destinationOrderId, List<String> lineItemIds, boolean copyPrinted, boolean broadcastLineItems, ResultStatus status)

Just like createLineItemsFrom but additionally when copyPrinted is set to true it will copy print flags on line items (normally did not), and when broadcastLineItems is set to true it will broadcastLineItems (normally did).

createOrder

public OrderFdParcelable createOrder(OrderFdParcelable fdOrder, ResultStatus status)

Create a new Order.

deleteCredit

public OrderFdParcelable deleteCredit(String orderId, String creditId, ResultStatus status)

Not available to non-Clover apps.

deleteCreditRefund

public OrderFdParcelable deleteCreditRefund(String orderId, String creditRefundId, ResultStatus status)

Not available to non-Clover apps.

deleteDiscounts

public OrderFdParcelable deleteDiscounts(String orderId, List<String> discountIds, ResultStatus status)

deleteLineItemDiscounts

public OrderFdParcelable deleteLineItemDiscounts(String orderId, String lineItemId, List<String> discountIds, ResultStatus status)

deleteLineItemModifications

public OrderFdParcelable deleteLineItemModifications(String orderId, String lineItemId, List<String> modificationIds, ResultStatus status)

deleteLineItems

public OrderFdParcelable deleteLineItems(String orderId, List<String> lineItemIds, ResultStatus status)

Delete LineItems from an Order.

deleteLineItems2

public OrderFdParcelable deleteLineItems2(String orderId, List<String> lineItemIds, ClientEventType clientEventType, String approvedByEmployeeId, ResultStatus status)

Delete LineItems from an Order with optional approver employee id and clientEventType.

deleteLineItemsWithReason

public OrderFdParcelable deleteLineItemsWithReason(String orderId, List<String> lineItemIds, String reason, ClientEventType clientEventType, ResultStatus status)

Delete LineItems from an Order.

deleteLineItemsWithReason2

public OrderFdParcelable deleteLineItemsWithReason2(String orderId, List<String> lineItemIds, String reason, ClientEventType clientEventType, String approvedByEmployeeId, ResultStatus status)

Delete LineItems from an Order.

deleteOrder

public boolean deleteOrder(String orderId, ResultStatus status)

Delete an Order.

deleteOrder2

public boolean deleteOrder2(String orderId, boolean allowDeleteIfLineItemPrinted, ResultStatus status)

Just like deleteOrder but additionally when allowDeleteIfLineItemPrinted is true it will delete the order when line items are printed (normally did not).

deleteOrder3

public boolean deleteOrder3(String orderId, boolean deleteOnline, boolean allowDeleteIfLineItemPrinted, boolean allowDeleteIfNoEmployeePermission, ResultStatus status)

Delete an Order.

deleteOrderFee

public OrderFdParcelable deleteOrderFee(String orderId, String orderFeeLineItemId, ResultStatus status)

This method can be used to remove an order fee from the order

deleteOrderOnline

public boolean deleteOrderOnline(String orderId, ResultStatus status)

Delete an Order synchronously on the server.

deleteOrderOnline2

public boolean deleteOrderOnline2(String orderId, boolean usePermissionForOrderDeletions, ResultStatus status)

Not available to non-Clover apps.

deletePreAuth

public OrderFdParcelable deletePreAuth(String orderId, String paymentId, VoidReason voidReason, VoidExtraData voidExtraData, ResultStatus status)

Not available to non-Clover apps.

deletePreAuth2

public OrderFdParcelable deletePreAuth2(String orderId, Authorization auth, VoidReason voidReason, VoidExtraData voidExtraData, ResultStatus status)

Not available to non-Clover apps.

deleteRefund

public OrderFdParcelable deleteRefund(String orderId, String refundId, ResultStatus status)

Not available to non-Clover apps.

deleteServiceCharge

public OrderFdParcelable deleteServiceCharge(String orderId, String serviceChargeId, ResultStatus status)

Add a com.clover.sdk.v3.base.ServiceCharge to an order.

exchangeItem

public LineItemFdParcelable exchangeItem(String orderId, String oldLineItemId, String itemId, String binName, String userData, ResultStatus status)

fire

public boolean fire(String sourceOrderId, ResultStatus status)

Print line items to the kitchen or order printer quickly.

fire2

public boolean fire2(String sourceOrderid, boolean requireAllItems, ResultStatus status)

Just like fire but additionally when requireAllItems is set to true it will not print and return false if some items on the order haven't been printed yet and would not be printed because they are not associated with an order printer.

fireLineItems

public boolean fireLineItems(String sourceOrderid, List<LineItem> lineItemList, ResultStatus status)

Send all line items added in the List to the kitchen or order printer.

firePrintGroups

public boolean firePrintGroups(String orderId, List<String> printGroupsIds, boolean requireAllItems, ResultStatus status)

Send all line items in the given print groups to the kitchen or order printer.

fireVoidedLineItem

public boolean fireVoidedLineItem(String orderId, ResultStatus resultStatus)

Fire voided line items(deleted items) to order printer

getLineItemsToFire

public List<String> getLineItemsToFire(String orderId, ResultStatus status)

Get list of lineitem ids for the order that has printtag to print.

getOrder

public OrderFdParcelable getOrder(String orderId, ResultStatus status)

Get the Order for the given ID.

getOrders

public OrderListFdParcelable getOrders(List<String> orderIds, ResultStatus status)

Get the Orders for the given IDs.

getPendingPayments

public PaymentListFdParcelable getPendingPayments(ResultStatus status)

This pulls pending payments from the local device db

incrementAuthorization

public AuthorizationFdParcelable incrementAuthorization(String orderId, String authId, long incrementAmount, ResultStatus status)

Authorise the incremented amount for particular authorization.

partialRefundV3

public RefundFdParcelable partialRefundV3(String orderId, RefundFdParcelable fdRefund, boolean tipIncluded, ResultStatus resultStatus)

Not available to non-Clover apps.

pay

public PaymentFdParcelable pay(String orderId, PaymentRequestFdParcelable fdPaymentRequest, boolean isAllowOffline, String note, ResultStatus status)

Not available to non-Clover apps.

queueVoid

public OrderFdParcelable queueVoid(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, TransactionInfo transactionInfo, Map passThroughExtras, VoidReason reason, VoidExtraData voidExtraData, String source, ResultStatus resultStatus)

Not available to non-Clover apps.

refire

public boolean refire(String orderId, ResultStatus status)

Reprint all lineitems that has a printtag even if they are printed.

refund

public RefundFdParcelable refund(String orderId, RefundFdParcelable fdRefund, ResultStatus status)

Not available to non-Clover apps.

refund2

public RefundFdParcelable refund2(String orderId, RefundFdParcelable fdRefund, Map passThroughExtras, ResultStatus resultStatus)

Refund with passthrough data Not available to non-Clover apps.

removeOnOrderUpdatedListener

public void removeOnOrderUpdatedListener(IOnOrderUpdateListener listener)

removeOnOrderUpdatedListener2

public void removeOnOrderUpdatedListener2(IOnOrderUpdateListener2 listener)

removePayment

public OrderFdParcelable removePayment(String orderId, String paymentId, ResultStatus status)

Not available to non-Clover apps.

reopenOrder

public boolean reopenOrder(String orderId, ResultStatus status)

Reopen an order for further edits if possible.

setFulfillmentInfo

public OrderFdParcelable setFulfillmentInfo(String orderId, FulfillmentInfo fulfillmentInfo, ResultStatus status)

Set the fulfillment info for an order.

setLineItemNote

public OrderFdParcelable setLineItemNote(String orderId, String lineItemId, String note, ResultStatus status)

splitLineItems

public LineItemListFdParcelable splitLineItems(String orderId, List<String> lineItemIds, List<String> binNames, ResultStatus resultStatus)

Splits line items without taking a payment.

updateCashDiscount

public OrderFdParcelable updateCashDiscount(String orderId, List<String> lineItemIds, DiscountFdParcelable cashDiscount, ResultStatus status)

Adds a native cash discount on an order.

updateLineItems

public LineItemListFdParcelable updateLineItems(String orderId, LineItemListFdParcelable fdLineItems, ResultStatus status)

Update LineItems on an Order.

updateOnlineOrderState

public void updateOnlineOrderState(String orderId, OrderState orderState, Reason reason, ResultStatus resultStatus)

Update the online order state.

updateOrder

public OrderFdParcelable updateOrder(OrderFdParcelable fdOrder, ResultStatus status)

Update an Order.

updatePayment

public PaymentFdParcelable updatePayment(String orderId, PaymentFdParcelable fdPayment, ResultStatus status)

Not available to non-Clover apps.

updatePaymentStatus

public PaymentFdParcelable updatePaymentStatus(String orderId, PaymentFdParcelable payment, ResultStatus status)

Not available to non-Clover apps.

updatePrintGroup

public OrderFdParcelable updatePrintGroup(String orderId, PrintGroupFdParcelable fdPrintGroupToUpdate, ResultStatus status)

Update PrintGroup on order object.

vaultedCreditRefund

public CreditRefund vaultedCreditRefund(String orderId, String creditId, ResultStatus status)

voidPayment

public OrderFdParcelable voidPayment(String orderId, String paymentId, ResultStatus status)

Not available to non-Clover apps.

voidPayment2

public OrderFdParcelable voidPayment2(String orderId, String paymentId, String iccContainer, VoidReason reason, String source, ResultStatus status)

Not available to non-Clover apps.

voidPayment3

public OrderFdParcelable voidPayment3(String orderId, String paymentId, String iccContainer, Map passThroughExtras, VoidReason reason, String source, ResultStatus status)

Card not present void with passthrough data Not available to non-Clover apps.

voidPaymentCardPresent

public OrderFdParcelable voidPaymentCardPresent(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, TransactionInfo transactionInfo, VoidReason reason, String source, ResultStatus status)

Card present void Not available to non-Clover apps.

voidPaymentCardPresent2

public OrderFdParcelable voidPaymentCardPresent2(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, TransactionInfo transactionInfo, Map passThroughExtras, VoidReason reason, String source, ResultStatus resultStatus)

Card present void with passthrough data Not available to non-Clover apps.

voidPaymentCardPresent3

public OrderFdParcelable voidPaymentCardPresent3(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, TransactionInfo transactionInfo, Map passThroughExtras, VoidReason reason, VoidExtraData voidExtraData, String source, ResultStatus resultStatus)

Card present void with passthrough data and POI components.

voidPaymentWithCard

public OrderFdParcelable voidPaymentWithCard(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, VoidReason reason, String source, ResultStatus status)

Not available to non-Clover apps.

voidPreAuth

public OrderFdParcelable voidPreAuth(String orderId, String preAuthId, String iccContainer, VoidReason voidReason, String source, ResultStatus status)

Not available to non-Clover apps.

voidPreAuthOnline

public OrderFdParcelable voidPreAuthOnline(String orderId, String preAuthId, String iccContainer, VoidReason voidReason, String source, ResultStatus status)

Not available to non-Clover apps.

voidRefund

public RefundFdParcelable voidRefund(String orderId, RefundFdParcelable fdRefund, ResultStatus status)

Not available to non-Clover apps.

voidRefundOffline

public RefundFdParcelable voidRefundOffline(String orderId, RefundFdParcelable fdRefund, ResultStatus status)

Not available to non-Clover apps.