com.clover.sdk.v3.order

Interface IOrderServiceV3_1

All Superinterfaces:

IInterface

All Known Implementing Classes:

IOrderServiceV3_1.Default, IOrderServiceV3_1.Stub

public interface IOrderServiceV3_1
extends IInterface

An interface for interacting with the Clover order service.

You may also interact with this service through the OrderConnector class, which handles binding and asynchronous invocation of service methods.

This service is backed by a local database which is synced to cloud.

Searching and listing orders may done via the OrderContract.

Implementation Details

This service mirrors the functionality of IOrderService but uses a different mechanism for trasferring Clover SDK objects. Specifically, as can be seen from the interface definition below, CloverSDK objects are transferred wrapped by a FdParcelable. This includes SDK objects passed to the service and objects returned from the server.

For example, to create an FD parcelablable input for an Order argument,

   
   OrderFdParcelable fdo = new OrderFdParcelable(order);
   service.updateOrder(fdo, ...);
   
 

To obtain an Order object return value from an FD parcelable,

   
   OrderFdParcelable fdo = service.getOrder(...);
   Order order = fdo.getValue();
   
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IOrderServiceV3_1.Default Default implementation for IOrderServiceV3_1.
static class	IOrderServiceV3_1.Stub Local-side IPC implementation stub class.

Method Summary

Modifier and Type	Method and Description
OrderFdParcelable	addBatchLineItemDiscounts(String orderId, List<String> lineItemIds, DiscountListFdParcelable discounts, ResultStatus status)
OrderFdParcelable	addBatchLineItemModifications(String orderId, List<String> lineItemIds, ModifierFdParcelable fdModifier, int quantity, ResultStatus status)
LineItemFdParcelable	addCustomLineItem(String orderId, LineItemFdParcelable fdLineItem, boolean isTaxable, ResultStatus status) Add a custom line item to an order.
OrderFdParcelable	addDiscount(String orderId, DiscountFdParcelable fdDiscount, ResultStatus status)
DiscountFdParcelable	addDiscount2(String orderId, DiscountFdParcelable fdDiscount, ResultStatus status) Just like addDiscount(java.lang.String, com.clover.sdk.v3.order.DiscountFdParcelable, com.clover.sdk.v1.ResultStatus) but returns a Discount instead of an Order.
LineItemFdParcelable	addFixedPriceLineItem(String orderId, String itemId, String binName, String userData, ResultStatus status) Add a fixed-price line item to an order.
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.
OrderFdParcelable	addLineItemDiscount(String orderId, String lineItemId, DiscountFdParcelable fdDiscount, ResultStatus status)
DiscountFdParcelable	addLineItemDiscount2(String orderId, String lineItemId, DiscountFdParcelable fdDiscount, ResultStatus status) Just like addLineItemDiscount(java.lang.String, java.lang.String, com.clover.sdk.v3.order.DiscountFdParcelable, com.clover.sdk.v1.ResultStatus) but returns a Discount instead of an Order.
OrderFdParcelable	addLineItemModification(String orderId, String lineItemId, ModifierFdParcelable fdModifier, ResultStatus status)
void	addOnOrderUpdatedListener(IOnOrderUpdateListener listener)
void	addOnOrderUpdatedListener2(IOnOrderUpdateListener2 listener)
LineItemFdParcelable	addPerUnitLineItem(String orderId, String itemId, int unitQuantity, String binName, String userData, ResultStatus status) Add a per-unit line item to an order.
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.
OrderFdParcelable	addPrintGroup(String orderId, PrintGroupFdParcelable fdPrintGroup, ResultStatus status) Add new PrintGroup on order object.
OrderFdParcelable	addServiceCharge(String orderId, String serviceChargeId, ResultStatus status) Add a ServiceCharge to an order.
OrderFdParcelable	addServiceCharge2(String orderId, String serviceChargeId, boolean isAutoApplied, ResultStatus status) Add a ServiceCharge to an order with a flag if it was added automatically or not.
LineItemFdParcelable	addVariablePriceLineItem(String orderId, String itemId, long price, String binName, String userData, ResultStatus status) Add a variably-priced line item to the order.
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.
LineItemListFdParcelable	copyLineItems(String sourceOrderId, String destinationOrderId, List<String> lineItemIds, ResultStatus status)
LineItemMapFdParcelable	createLineItemsFrom(String sourceOrderId, String destinationOrderId, List<String> lineItemIds, ResultStatus status)
LineItemMapFdParcelable	createLineItemsFrom2(String sourceOrderId, String destinationOrderId, List<String> lineItemIds, boolean copyPrinted, boolean broadcastLineItems, ResultStatus status) Just like createLineItemsFrom(java.lang.String, java.lang.String, java.util.List<java.lang.String>, com.clover.sdk.v1.ResultStatus) 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).
OrderFdParcelable	createOrder(OrderFdParcelable fdOrder, ResultStatus status) Create a new Order.
OrderFdParcelable	deleteDiscounts(String orderId, List<String> discountIds, ResultStatus status)
OrderFdParcelable	deleteLineItemDiscounts(String orderId, String lineItemId, List<String> discountIds, ResultStatus status)
OrderFdParcelable	deleteLineItemModifications(String orderId, String lineItemId, List<String> modificationIds, ResultStatus status)
OrderFdParcelable	deleteLineItems(String orderId, List<String> lineItemIds, ResultStatus status) Delete LineItems from an Order.
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.
OrderFdParcelable	deleteLineItemsWithReason(String orderId, List<String> lineItemIds, String reason, ClientEventType clientEventType, ResultStatus status) Delete LineItems from an Order.
OrderFdParcelable	deleteLineItemsWithReason2(String orderId, List<String> lineItemIds, String reason, ClientEventType clientEventType, String approvedByEmployeeId, ResultStatus status) Delete LineItems from an Order.
boolean	deleteOrder(String orderId, ResultStatus status) Delete an Order.
boolean	deleteOrder2(String orderId, boolean allowDeleteIfLineItemPrinted, ResultStatus status) Just like deleteOrder(java.lang.String, com.clover.sdk.v1.ResultStatus) but additionally when allowDeleteIfLineItemPrinted is true it will delete the order when line items are printed (normally did not).
boolean	deleteOrderOnline(String orderId, ResultStatus status) Delete an Order synchronously on the server.
OrderFdParcelable	deleteServiceCharge(String orderId, String serviceChargeId, ResultStatus status) Add a ServiceCharge to an order.
LineItemFdParcelable	exchangeItem(String orderId, String oldLineItemId, String itemId, String binName, String userData, ResultStatus status)
boolean	fire(String sourceOrderId, ResultStatus status) Print line items to the kitchen or order printer quickly.
boolean	fire2(String sourceOrderid, boolean requireAllItems, ResultStatus status) Just like fire(java.lang.String, com.clover.sdk.v1.ResultStatus) 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.
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.
List<String>	getLineItemsToFire(String orderId, ResultStatus status) Get list of lineitem ids for the order that has printtag to print.
OrderFdParcelable	getOrder(String orderId, ResultStatus status) Get the Order for the given ID.
OrderListFdParcelable	getOrders(List<String> orderIds, ResultStatus status) Get the Orders for the given IDs.
PaymentListFdParcelable	getPendingPayments(ResultStatus status) This pulls pending payments from the local device db
boolean	refire(String orderId, ResultStatus status) Reprint all lineitems that has a printtag even if they are printed.
void	removeOnOrderUpdatedListener(IOnOrderUpdateListener listener)
void	removeOnOrderUpdatedListener2(IOnOrderUpdateListener2 listener)
OrderFdParcelable	setLineItemNote(String orderId, String lineItemId, String note, ResultStatus status)
LineItemListFdParcelable	splitLineItems(String orderId, List<String> lineItemIds, List<String> binNames, ResultStatus resultStatus) Splits line items without taking a payment.
LineItemListFdParcelable	updateLineItems(String orderId, LineItemListFdParcelable fdLineItems, ResultStatus status) Update LineItems on an Order.
void	updateOnlineOrderState(String orderId, OrderState orderState, Reason reason, ResultStatus resultStatus) Update the online order state.
OrderFdParcelable	updateOrder(OrderFdParcelable fdOrder, ResultStatus status) Update an Order.
OrderFdParcelable	updatePrintGroup(String orderId, PrintGroupFdParcelable fdPrintGroupToUpdate, ResultStatus status) Update PrintGroup on order object.

Methods inherited from interface android.os.IInterface

asBinder

Method Detail

addOnOrderUpdatedListener

void addOnOrderUpdatedListener(IOnOrderUpdateListener listener)
                        throws RemoteException

Throws:

RemoteException

removeOnOrderUpdatedListener

void removeOnOrderUpdatedListener(IOnOrderUpdateListener listener)
                           throws RemoteException

Throws:

RemoteException

getOrder

OrderFdParcelable getOrder(String orderId,
                           ResultStatus status)
                    throws RemoteException

Get the Order for the given ID. If the order is not synchronized on this device, the order is fetched from the server.

Parameters:

orderId - The ID of the Order to retrieve.

Returns:

The Orders corresponding to the provided ID, or null if the order does not exists locally and it cannot be fetched from the server. Note that this may be because the server is not reachable or because the order for the given ID does not exist.

Throws:

RemoteException

getOrders

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

Get the Orders for the given IDs. If the orders are not synchronized on this device, they are fetched from the server.

Parameters:

orderIds - The list of orders to retrieve

Returns:

The list of Orders corresponding to the provided IDs

Throws:

RemoteException

createOrder

OrderFdParcelable createOrder(OrderFdParcelable fdOrder,
                              ResultStatus status)
                       throws RemoteException

Create a new Order. Only the following fields are allowed during creation:

• title
• List
• orderType.id
• note

The following fields are set automatically by this call:

• id
• device - set the this device.
• currency - set to the merchant's currency.
• vat - set according to the merchant's setting.
• groupLineItems - set according to the merchant's setting.
• testMode - set according to the merchant's setting.
• createdTime - set to this device's current time.
• taxRemoved - set to false.
• total - set to 0.
• employee - set to the current employee logged into this device.

Any other fields included in this call will result in failure to create the order. Adding line items and making other changes should be done after order creation using other methods in this class.

Parameters:

order - The order to create.

Throws:

RemoteException

updateOrder

OrderFdParcelable updateOrder(OrderFdParcelable fdOrder,
                              ResultStatus status)
                       throws RemoteException

Update an Order. The following fields may be updated,

• title
• note
• taxRemoved
• groupLineItems
• manualTransactions
• testMode
• orderType.id
• List
• payType
• employee.id

All other fields are ignored.

Parameters:

order - The Order to updated.

Throws:

RemoteException

deleteOrder

boolean deleteOrder(String orderId,
                    ResultStatus status)
             throws RemoteException

Delete an Order.

Parameters:

orderId - The ID of the Order to be deleted.

Returns:

true if the Order was deleted successfully, otherwise false.

Throws:

RemoteException

See Also:

deleteOrderOnline(java.lang.String, com.clover.sdk.v1.ResultStatus)

addServiceCharge

OrderFdParcelable addServiceCharge(String orderId,
                                   String serviceChargeId,
                                   ResultStatus status)
                            throws RemoteException

Add a ServiceCharge to an order.

Parameters:

orderId - The order ID on which to add the service charge.

serviceChargeId - The ID of the service charge to be added to the order.

Returns:

The updated order with the service charge added.

Throws:

RemoteException

deleteServiceCharge

OrderFdParcelable deleteServiceCharge(String orderId,
                                      String serviceChargeId,
                                      ResultStatus status)
                               throws RemoteException

Add a ServiceCharge to an order.

Parameters:

orderId - The order ID on which to add the service charge.

serviceChargeId - The ID of the service charge to be added to the order.

Returns:

The updated order with the service charge removed.

Throws:

RemoteException

addFixedPriceLineItem

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

Add a fixed-price line item to an order. A fixed price line item is priced per item. LineItems are linked to Items with an item ID. Think of the Item as a template for creating a LineItem, and a LineItem as the order's copy of an Item.

Parameters:

orderId - The ID of the order to which to add the line item.

itemId - The item ID from which to create the line item to be added to the order.

binName - The BIN name for the line item. May be null.

userData - Meta-data to attach to the line item. May be null.

Returns:

The newly created LineItem.

Throws:

RemoteException

addPerUnitLineItem

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

Add a per-unit line item to an order. A per unit line item is priced per unit, not per item. A good example is items that are sold by weight (e.g., per ounce). LineItems are linked to Items with an item ID. Think of the Item as a template for creating a LineItem, and a LineItem as the order's copy of an Item.

Parameters:

orderId - The ID of the order to which to add the line item.

itemId - The item ID from which to create the line item to be added to the order.

unitQuantity - The unit quantity for the line item (e.g., "10 ounces").

binName - The BIN name for the line item. May be null.

userData - Meta-data to attach to the line item. May be null.

Returns:

The newly created LineItem.

Throws:

RemoteException

addVariablePriceLineItem

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

Add a variably-priced line item to the order. A variably priced line item's price is determined at the time of sale. Note that this method is not consistent with others in this interface as it returns a LineItem. All other methods return the complete, updated Order.

Parameters:

orderId - The ID of the order to which to add the line item.

itemId - The item ID from which to create the line item to be added to the order.

price - The price of the line item.

binName - The BIN name for the line item. May be null.

userData - Meta-data to attach to the line item. May be null.

Throws:

RemoteException

addCustomLineItem

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

Add a custom line item to an order. Custom line items are not associated with an inventory item. Note that this method is not consistent with others in this interface as it returns a LineItem. All other methods return the complete, updated Order.

Parameters:

orderId - The ID of the order to which to add the line item.

lineItem - The line item to add to the order.

isTaxable - true if this line item is taxable, otherwise false.

Throws:

RemoteException

updateLineItems

LineItemListFdParcelable updateLineItems(String orderId,
                                         LineItemListFdParcelable fdLineItems,
                                         ResultStatus status)
                                  throws RemoteException

Update LineItems on an Order. Only the following fields may be updated,

• binName
• printed
• note
• userData

All other fields are ignored.

Parameters:

orderId - The ID of the order on which to update the line items.

lineItemIds - The LineItems to update on the order.

Returns:

The updated LineItems.

Throws:

RemoteException

deleteLineItems

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

Delete LineItems from an Order.

Parameters:

orderId - The ID of the Order from which to delete the line items.

lineItemIds - The LineItem IDs to delete.

Returns:

The updated Order.

Throws:

RemoteException

copyLineItems

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

Throws:

RemoteException

setLineItemNote

OrderFdParcelable setLineItemNote(String orderId,
                                  String lineItemId,
                                  String note,
                                  ResultStatus status)
                           throws RemoteException

Throws:

RemoteException

addLineItemModification

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

Throws:

RemoteException

deleteLineItemModifications

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

Throws:

RemoteException

exchangeItem

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

Throws:

RemoteException

addDiscount

OrderFdParcelable addDiscount(String orderId,
                              DiscountFdParcelable fdDiscount,
                              ResultStatus status)
                       throws RemoteException

Throws:

RemoteException

deleteDiscounts

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

Throws:

RemoteException

addLineItemDiscount

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

Throws:

RemoteException

deleteLineItemDiscounts

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

Throws:

RemoteException

deleteOrderOnline

boolean deleteOrderOnline(String orderId,
                          ResultStatus status)
                   throws RemoteException

Delete an Order synchronously on the server. Differing from #deleteOrder(String), this method only completes successfully if this device can reach the server and retrieve confirmation that the order was deleted.

Parameters:

orderId - The ID of the order to be deleted.

Returns:

true if the order was deleted successfully, otherwise false.

Throws:

RemoteException

See Also:

deleteOrder(java.lang.String, com.clover.sdk.v1.ResultStatus)

addBatchLineItemModifications

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

Throws:

RemoteException

addBatchLineItemDiscounts

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

Throws:

RemoteException

createLineItemsFrom

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

Throws:

RemoteException

fire

boolean fire(String sourceOrderId,
             ResultStatus status)
      throws RemoteException

Print line items to the kitchen or order printer quickly. Only prints inventory items that are associated with a printer. The association is done by linking an item and a printer with a tag. It will only print line items once, subsequent invocations will not cause additional prints, but the method will still return true.

Returns:

true, unless the order has no line items in it that can be fired to a printer, will return true but not print anything if all items have been already printed

Throws:

RemoteException

See Also:

com.clover.sdk.v3.inventory.IInventoryService.assignTagsToItem

addOnOrderUpdatedListener2

void addOnOrderUpdatedListener2(IOnOrderUpdateListener2 listener)
                         throws RemoteException

Throws:

RemoteException

removeOnOrderUpdatedListener2

void removeOnOrderUpdatedListener2(IOnOrderUpdateListener2 listener)
                            throws RemoteException

Throws:

RemoteException

addDiscount2

DiscountFdParcelable addDiscount2(String orderId,
                                  DiscountFdParcelable fdDiscount,
                                  ResultStatus status)
                           throws RemoteException

Just like addDiscount(java.lang.String, com.clover.sdk.v3.order.DiscountFdParcelable, com.clover.sdk.v1.ResultStatus) but returns a Discount instead of an Order.

Throws:

RemoteException

addLineItemDiscount2

DiscountFdParcelable addLineItemDiscount2(String orderId,
                                          String lineItemId,
                                          DiscountFdParcelable fdDiscount,
                                          ResultStatus status)
                                   throws RemoteException

Just like addLineItemDiscount(java.lang.String, java.lang.String, com.clover.sdk.v3.order.DiscountFdParcelable, com.clover.sdk.v1.ResultStatus) but returns a Discount instead of an Order.

Throws:

RemoteException

fire2

boolean fire2(String sourceOrderid,
              boolean requireAllItems,
              ResultStatus status)
       throws RemoteException

Just like fire(java.lang.String, com.clover.sdk.v1.ResultStatus) 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.

Returns:

just like fire(java.lang.String, com.clover.sdk.v1.ResultStatus), but additionally returns false if there are unprinted items without a printer associated.

Throws:

RemoteException

createLineItemsFrom2

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

Just like createLineItemsFrom(java.lang.String, java.lang.String, java.util.List<java.lang.String>, com.clover.sdk.v1.ResultStatus) 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).

Throws:

RemoteException

deleteOrder2

boolean deleteOrder2(String orderId,
                     boolean allowDeleteIfLineItemPrinted,
                     ResultStatus status)
              throws RemoteException

Just like deleteOrder(java.lang.String, com.clover.sdk.v1.ResultStatus) but additionally when allowDeleteIfLineItemPrinted is true it will delete the order when line items are printed (normally did not).

Throws:

RemoteException

getPendingPayments

PaymentListFdParcelable getPendingPayments(ResultStatus status)
                                    throws RemoteException

This pulls pending payments from the local device db

Throws:

RemoteException

deleteLineItemsWithReason

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

Delete LineItems from an Order.

Parameters:

orderId - The ID of the Order from which to delete the line items.

lineItemIds - The LineItem IDs to delete.

reason - optional. Why was the line item removed?

clientEventType - optional. What app did the delete come from?

Returns:

The updated Order.

Throws:

RemoteException

getLineItemsToFire

List<String> getLineItemsToFire(String orderId,
                                ResultStatus status)
                         throws RemoteException

Get list of lineitem ids for the order that has printtag to print. The items that are already printed are not part of the list

Parameters:

orderId - The ID of the Order from which to delete the line items.

Throws:

RemoteException

refire

boolean refire(String orderId,
               ResultStatus status)
        throws RemoteException

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

Parameters:

orderId - The ID of the Order from which to delete the line items.

Throws:

RemoteException

addFixedPriceLineItems

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

Add 1 or more fixed-price line item to an order. A fixed price line item is priced per item. LineItems are linked to Items with an item ID. Think of the Item as a template for creating a LineItem, and a LineItem as the order's copy of an Item.

Parameters:

orderId - The ID of the order to which to add the line item.

itemId - The item ID from which to create the line item to be added to the order.

binName - The BIN name for the line item. May be null.

userData - Meta-data to attach to the line item. May be null.

numItems - number of LineItems to create

Returns:

The newly created LineItem.

Throws:

RemoteException

addPerUnitLineItems

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

Add 1 or more per-unit line item to an order. A per unit line item is priced per unit, not per item. A good example is items that are sold by weight (e.g., per ounce). LineItems are linked to Items with an item ID. Think of the Item as a template for creating a LineItem, and a LineItem as the order's copy of an Item.

Parameters:

orderId - The ID of the order to which to add the line item.

itemId - The item ID from which to create the line item to be added to the order.

unitQuantity - The unit quantity for the line item (e.g., "10 ounces").

binName - The BIN name for the line item. May be null.

userData - Meta-data to attach to the line item. May be null.

numItems - number of LineItems to create

Returns:

The newly created LineItem.

Throws:

RemoteException

addVariablePriceLineItems

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

Add 1 or more variably-priced line item to the order. A variably priced line item's price is determined at the time of sale. Note that this method is not consistent with others in this interface as it returns a LineItem. All other methods return the complete, updated Order.

Parameters:

orderId - The ID of the order to which to add the line item.

itemId - The item ID from which to create the line item to be added to the order.

price - The price of the line item.

binName - The BIN name for the line item. May be null.

userData - Meta-data to attach to the line item. May be null.

numItems - number of LineItems to create

Returns:

The newly created LineItem.

Throws:

RemoteException

splitLineItems

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

Splits line items without taking a payment. Each LineItem in lineItemIds is equally split across all bins in binNames. For example, given a single line item ID and bin names "a" and "b", then two new line items are created. One for bin "a" and another for bin "b". The original line item is then deleted. Each new line item represents an equal fraction of the original by using a fraction of the original's unit quantity. Using this method allows for items to be shared without locking the order.

Restrictions A line item may not be split more than once. If a line item cannot be split, it is skipped.

Parameters:

orderId - the ID of the order to modify.

lineItemIds - the line items to split.

binNames - the bin names to split lineItemIds across.

Returns:

the newly created LineItems.

Throws:

RemoteException

updateOnlineOrderState

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

Update the online order state.

Throws:

RemoteException

addPrintGroup

OrderFdParcelable addPrintGroup(String orderId,
                                PrintGroupFdParcelable fdPrintGroup,
                                ResultStatus status)
                         throws RemoteException

Add new PrintGroup on order object.

Parameters:

orderId - The ID of the order to be updated

fdPrintGroup - PrintGroup to be added to an Order

Returns:

the updated order

Throws:

RemoteException

deleteLineItems2

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

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

Parameters:

orderId - The ID of the Order from which to delete the line items.

lineItemIds - The LineItem IDs to delete.

clientEventType - What app did the delete come from? If null, no clientEventType will be added.

approvedByEmployeeId - Approval id of the employee who approved the deletion of the line item, if null no approver is added.

Returns:

The updated Order.

Throws:

RemoteException

firePrintGroups

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

Send all line items in the given print groups to the kitchen or order printer. Only prints items that have tags (also called labels) associating them with a printer. Line items will only be printed once. Subsequent invocations will not cause additional prints, but the method will still return true.

Parameters:

orderId - the ID of the order to fire.

printGroupIds - fire items from all given PrintGroups. If null, fire all PrintGroups.

requireAllItems - when true, it will not print and return false if some items in the PrintGroups haven't been printed and will not be printed because they are not associated with an order printer.

Returns:

behaves like fire(String, ResultStatus) when requireAllItems is false. When requireAllItems is true, returns false if there are unprinted items without a printer associated.

Throws:

RemoteException

See Also:

com.clover.sdk.v3.inventory.IInventoryService.assignTagsToItem, com.clover.sdk.v3.order.IOrderServiceV3_1.addPrintGroup

addServiceCharge2

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

Add a ServiceCharge to an order with a flag if it was added automatically or not.

Parameters:

orderId - The order ID on which to add the service charge.

serviceChargeId - The ID of the service charge to be added to the order.

isAutoApplied - The flag indicating if service charge is applied automatically or not.

Returns:

The updated order with the service charge added.

Throws:

RemoteException

deleteLineItemsWithReason2

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

Delete LineItems from an Order.

Parameters:

orderId - The ID of the Order from which to delete the line items.

lineItemIds - The LineItem IDs to delete.

reason. - Why was the line item removed?

clientEventType - optional. What app did the delete come from?

approvedByEmployeeId. - Who approved the delete request?

Returns:

The updated Order.

Throws:

RemoteException

updatePrintGroup

OrderFdParcelable updatePrintGroup(String orderId,
                                   PrintGroupFdParcelable fdPrintGroupToUpdate,
                                   ResultStatus status)
                            throws RemoteException

Update PrintGroup on order object.

Parameters:

orderId - The ID of the order to be updated

fdPrintGroupToUpdate - PrintGroup to be updated

Returns:

the order with updated PrintGroup

Throws:

RemoteException