IEditSession Interface |
Accumulates a sequence of entity changes that can be applied atomically at the end.
Namespace: Resto.Front.Api.Editors
Assembly: Resto.Front.Api.V9 (in Resto.Front.Api.V9.dll)
SyntaxC#
public interface IEditSession
The IEditSession type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | HasChanges |
Determines whether an edit session has changes.
|
Methods| Name | Description | |
|---|---|---|
 | ActivateReserveAndBindToOrder | Closes reserve and creates order on reserved table. Closed reserve is binded to the created order. Number of guests in the created order equals to number of guests in the reserve. |
| AddCardLoyaltyDiscounts | Adds discounts grouped by order items. |
| AddDeliveryAutoAddition | Adds some items according to the product auto-addition settings. |
| AddDiscount | Adds simple discount of known type to existing order. User must have rights to work with discounts. |
| AddDiscountByCardNumber | Add discount by card number. |
| AddExternalFiscalizedPaymentItem(Decimal, IPaymentItemAdditionalData, IPaymentType, IOrderStub, IAdditionalCurrency, IOrderGuestItemStub) | Add new externally fiscalized payment item to order. |
| AddExternalFiscalizedPaymentItem(Guid, Decimal, IPaymentItemAdditionalData, IPaymentType, IOrderStub, IAdditionalCurrency, IOrderGuestItemStub) | Add new external fiscalized payment item to order. |
| AddExternalPaymentItem(Decimal, Boolean, IPaymentItemAdditionalData, OrganizationDetailsInfo, IPaymentType, IOrderStub, IAdditionalCurrency, IOrderGuestItemStub) | Add new external payment item to order. |
| AddExternalPaymentItem(Guid, Decimal, Boolean, IPaymentItemAdditionalData, OrganizationDetailsInfo, IPaymentType, IOrderStub, IAdditionalCurrency, IOrderGuestItemStub) | Add new external payment item to order. |
| AddFlexibleSumDiscount | Adds simple discount of known type to existing order. User must have rights to work with discounts. |
| AddFlexibleSumDiscountByCardNumber | Add discount by card number. |
| AddOrderCombo | Create order combo item. Order must contain new combo items. |
| AddOrderCompoundItem(IProduct, IOrderStub, IOrderGuestItemStub, IProductSize, OrderItemCourse) | Adds compound item to the guest in existing order. User must have permission to edit orders. |
| AddOrderCompoundItem(Guid, IProduct, IOrderStub, IOrderGuestItemStub, IProductSize, OrderItemCourse) | Adds compound item to the guest in existing order. User must have permission to edit orders. |
| AddOrderExternalData | Adds external data to the order. Cannot update public external data for closed order. Use DeleteOrderExternalData(String, IOrderStub) to delete the data when it's no longer needed. |
| AddOrderGuest(String, IOrderStub) | Adds new guest to existing order. User must have rights to edit orders. |
| AddOrderGuest(Guid, String, IOrderStub) | Adds new guest with the given ID to existing order. User must have rights to edit orders. |
| AddOrderModifierItem(Int32, IProduct, IProductGroup, IOrderStub, IOrderCompoundItemComponentStub, NullableInt32, NullableDecimal) | Adds order item modifier to the compound item component in existing order. User must have rights to edit orders. |
| AddOrderModifierItem(Int32, IProduct, IProductGroup, IOrderStub, IOrderCompoundItemStub, NullableInt32, NullableDecimal) | Adds order item modifier to the compound item in existing order. User must have rights to edit orders. |
| AddOrderModifierItem(Int32, IProduct, IProductGroup, IOrderStub, IOrderProductItemStub, NullableInt32, NullableDecimal) | Adds order item modifier to the order item in existing order. User must have rights to edit orders. |
| AddOrderModifierItem(Guid, Int32, IProduct, IProductGroup, IOrderStub, IOrderCompoundItemComponentStub, NullableInt32, NullableDecimal) | Adds order item modifier to the compound item component in existing order. User must have rights to edit orders. |
| AddOrderModifierItem(Guid, Int32, IProduct, IProductGroup, IOrderStub, IOrderCompoundItemStub, NullableInt32, NullableDecimal) | Adds order item modifier to the compound item in existing order. User must have rights to edit orders. |
| AddOrderModifierItem(Guid, Int32, IProduct, IProductGroup, IOrderStub, IOrderProductItemStub, NullableInt32, NullableDecimal) | Adds order item modifier to the order item in existing order. User must have rights to edit orders. |
| AddOrderProductItem(Decimal, IProduct, IOrderStub, IOrderGuestItemStub, IProductSize, OrderItemCourse, NullableDecimal) | Adds assortment position to the guest in existing order. User must have rights to edit orders. |
| AddOrderProductItem(Guid, Decimal, IProduct, IOrderStub, IOrderGuestItemStub, IProductSize, OrderItemCourse, NullableDecimal) | Adds assortment position to the guest in existing order. User must have rights to edit orders. |
| AddOrderServiceItem | Adds time pay service item to the guest in existing order. User must have permission to edit orders. |
| AddOrUpdateModifierForPrintedItem | Adds order item modifier for product which is already printed. User must have rights to edit orders. |
| AddPaymentItem(Decimal, IPaymentItemAdditionalData, IPaymentType, IOrderStub, IAdditionalCurrency, IOrderGuestItemStub) | Add new payment item to order. |
| AddPaymentItem(Guid, Decimal, IPaymentItemAdditionalData, IPaymentType, IOrderStub, IAdditionalCurrency, IOrderGuestItemStub) | Add new payment item to order. |
| AddPreliminaryPaymentItem(Decimal, IPaymentItemAdditionalData, IPaymentType, IDeliveryOrderStub, IOrderGuestItemStub) | Add new preliminary payment item to order. |
| AddPreliminaryPaymentItem(Guid, Decimal, IPaymentItemAdditionalData, IPaymentType, IDeliveryOrderStub, IOrderGuestItemStub) | Add new preliminary payment item to order. |
| AddPrimaryComponent(IProduct, IOrderStub, IOrderCompoundItemStub, NullableDecimal) | Adds a primary component to the compound item. |
| AddPrimaryComponent(Guid, IProduct, IOrderStub, IOrderCompoundItemStub, NullableDecimal) | Adds a primary component to the compound item. |
| AddSecondaryComponent(IProduct, IOrderStub, IOrderCompoundItemStub, NullableDecimal) | Adds a secondary component to the compound item. |
| AddSecondaryComponent(Guid, IProduct, IOrderStub, IOrderCompoundItemStub, NullableDecimal) | Adds a secondary component to the compound item. |
| AttachToJournalEvent | Sets default attributes of order for journal event. |
| BindReserveToOrder | Converts exising reserve or banquet without order to banquet with order. |
| ChangeClientAddresses | Changes client addresses. |
| ChangeClientBirthDate | Changes client's birth date. |
| ChangeClientBlacklistInfo | Changes client blacklist info. |
| ChangeClientCardNumber | Changes client card number. |
| ChangeClientComment | Changes client comment. |
| ChangeClientConsentDates | Changes client's dates of consent. |
| ChangeClientEmails | Changes client emails list. |
| ChangeClientGender | Change client's gender. |
| ChangeClientIikoBizId | Changes client's account in iiko.biz. |
| ChangeClientLastOrderDate | Changes client's last order date. |
| ChangeClientLinkedCounteragent | Changes client linked counter agent. |
| ChangeClientMainAddressIndex | Changes client main address index. |
| ChangeClientMarketingSource | Changes client marketing source. |
| ChangeClientName | Changes client name. |
| ChangeClientNick | Changes client nickname. |
| ChangeClientOrganizationDetailsInfo | Changes organization details information of client. |
| ChangeClientPersonalDataConsent | Changes whether client consented processing their personal data. |
| ChangeClientPersonalDataProcessingDates | Changes dates of the time interval which allows client's legal personal data processing without thier consent. |
| ChangeClientPhones | Changes client phones list. |
| ChangeClientReceivesLoyaltySystemNotifications | Changes whether client receives loyalty system notification messages. |
| ChangeClientReceivesOrderStatusNotifications | Changes whether client receives order status notification messages. |
| ChangeClientReceivesPromotionalNotifications | Changes whether client receives promotional notification messages. |
| ChangeClientSurname | Changes client surname. |
| ChangeComboAmount | Change combo amount. |
| ChangeComboPrice | Change combo price. |
| ChangeComboSize | Change combo size. |
| ChangeCookingPriority | Changes custom cooking priority and top priority flag. |
| ChangeDeliveryActualDeliverTime | Change time when the order was actually delivered. |
| ChangeDeliveryAddress | Changes address of delivery |
| ChangeDeliveryClientName | Change name of delivery client. |
| ChangeDeliveryComment | Change the order comment. |
| ChangeDeliveryConfirmTime | Changes delivery confirmation state and time. |
| ChangeDeliveryCourier | Assign/Change the order courier. Can use this action only before the order is to be delivered. |
| ChangeDeliveryCustomApiData | Change the delivery custom data from api. |
| ChangeDeliveryDuration | Sets duration of delivery processing. |
| ChangeDeliveryEmail | Change the order e-mail. |
| ChangeDeliveryExpectedDeliverTime | Change time when client wants the order to be delivered. |
| ChangeDeliveryExpectedDuration | Sets calculated delivery duration without overrided value on terminal. |
| ChangeDeliveryExternalCourierService | Changes external courier service for delivery. |
| ChangeDeliveryFixedRestrictions | Fixes delivery restrictions check result values, so that they could not be corrected in iikoFront from now on. Or unfixes them for iikoFront to reevaluate them later on. |
| ChangeDeliveryLastVerifiedRestrictionsHash | Sets calculated delivery restirictions hash. |
| ChangeDeliveryLocation | Changes delivery address location. |
| ChangeDeliveryMarketingSource | Assign/change order marketing source. |
| ChangeDeliveryMoveIds | Sets identifiers of: the new delivery created to transfer current one to a new terminal. the group of a new delivery created to transfer current one to a new terminal. the old delivery, from which the current one was created after transferring to a new terminal. the group of an old delivery, from which the current one was created after transferring to a new terminal. |
| ChangeDeliveryOperator | Assign/change the order operator. |
| ChangeDeliveryOrderPredictedCookingCompleteTime | Change predicted time when the order cooking should be completed. Can change property only for Unconfirmed, New or Waiting delivery. |
| ChangeDeliveryPhone | Changes the order phone. |
| ChangeDeliveryPredictedDeliveryTime | Change predicted time when the order should be delivered. Can change property only for Unconfirmed, New or Waiting delivery. |
| ChangeDeliveryProblemComment | Change the order problem comment. |
| ChangeDeliveryProblemStatus | Change the order problem status. |
| ChangeDeliverySplitBetweenPersons | Changes the order property if it should be splitted between persons. |
| ChangeDeliveryZone | Sets matching the address calculated delivery zone name. |
| ChangeEstimatedOrderGuestsCount | Changes estimated order guests count. Use this method to set estimated guests count when guests collection doesn't reflect actual state of affairs. |
| ChangeExternalPaymentItemCustomData | Changes custom data of existing external payment item. |
| ChangeOrderAppliedIikoCard5ManualConditions | Bind or unbind iikoCard5 manual conditions for order. |
| ChangeOrderComment | Changes order comment. |
| ChangeOrderCookingItemAmount | Changes the amount of the assortment position in existing order. User must have rights to edit orders. |
| ChangeOrderCookingItemCourse | Changes the course of the order item. |
| ChangeOrderCookingItemSize | Changes the product size of the order item. |
| ChangeOrderExternalNumber | Sets order it's corresponding external number from an external system. |
| ChangeOrderIikoCard5Coupon | Bind or unbind order iikoCard5 coupon, used in iikoCard5 system. |
| ChangeOrderItemComment | Changes product order item's comment. |
| ChangeOrderItemMarkingCode | Changes the marking code of a product within an order item. Skip scanning of marking code option will be reset. Use SkipScanningOrderItemMarkingCode(IOrderStub, IOrderProductItemStub) to set this option. |
| ChangeOrderItemsCookingPlace | Changes cooking place for order cooking items. |
| ChangeOrderItemWaiter | Changes product order item's waiter. |
| ChangeOrderModifierItemAmount(Int32, IOrderStub, IOrderCompoundItemComponentStub, IOrderModifierItemStub, NullableInt32) | Changes the amount of the compound component modifier. User must have rights to edit orders. |
| ChangeOrderModifierItemAmount(Int32, IOrderStub, IOrderCompoundItemStub, IOrderModifierItemStub, NullableInt32) | Changes the amount of the compound item common modifier. User must have rights to edit orders. |
| ChangeOrderModifierItemAmount(Int32, IOrderStub, IOrderProductItemStub, IOrderModifierItemStub, NullableInt32) | Changes the amount of the product item modifier. User must have rights to edit orders. |
| ChangeOrderOriginName | Sets order origin — name of the source this order was received from. Specifying origin allows to analyse efficiency of external order sources such as different web-sites, mobile applications and so on. Origin name can be set only once. |
| ChangeOrderPricingTime | Change order pricing time, which determines the price of products. By default time taken from items print time. |
| ChangeOrderTables | Changes tables of the order. |
| ChangeOrderWaiter | Changes order's waiter. |
| ChangePaymentItemCustomData | Changes custom data of existing payment item. |
| ChangePaymentItemSum | Changes sum of existing payment item. |
| ChangePreliminaryPaymentItemCustomData | Changes custom data of existing preliminary payment item. |
| ChangePreliminaryPaymentItemSum | Changes sum of existing preliminary payment item. |
| ChangePriceCategory | Changes price category of the order. |
| ChangeReserveComment | Changes reserve comment. Use empty string to clear comment. |
| ChangeReserveDuration | Changes estimated reserve duration (amount of time betwen visit's start and end). Default reserve duration is 2 hours, banquet duration is 3 hours. |
| ChangeReserveEstimatedStartTime | Changes estimated reserve start time. |
| ChangeReserveGuestsCount | Changes estimated guests count for reserve. Default value is 2. |
| ChangeReserveReminder | Changes reserve reminder flag. |
| ChangeReserveTables | Changes reserving tables. |
| ChangeSelectiveDiscount(IReadOnlyListValueTupleGuid, Decimal, IOrderStub, IDiscountType) | Change discount item selective application settings. For each item Id, the discount amount is set separately. |
| ChangeSelectiveDiscount(IOrderStub, IDiscountType, IReadOnlyListIOrderProductItemStub, IReadOnlyListIOrderModifierItemStub, IReadOnlyListIOrderCompoundItemComponentStub) | Change discount item selective application settings. Set both products and modifiers to null if you want the discount item to be applied to the whole order (including future order items), otherwise provide order item products and modifiers for selective discount item application. |
| ChangeStreetName | Changes street's name. |
| ConvertToTableServiceOrder | Converts FastFood order to TableService order. |
| CreateBanquet(DateTime, String, IClientStub, IOrderStub, Guid) | Creates reservation for planned event in future. Order's table will be marked as reserved to prevent collision with other events at the same time. |
| CreateBanquet(DateTime, String, IClientStub, IReadOnlyListITable, Guid) | Creates reservation for planned event in future. Table will be marked as reserved to prevent collision with other events at the same time. |
| CreateClient | Creates new client. The client must have a card number or at least one phone number. |
| CreateClientWithOrganizationDetails | Creates new client. The client must have orgatizations details info. |
| CreateDeliveryOrder(NullableInt32, DateTime, String, AddressDto, NullableDateTime, IOrderType, IClientStub, IUser, NullableTimeSpan, String, Boolean, Boolean) | Creates new delivery order. User must have rights to edit delivery orders. Specify address for courier-service; leave it null for self-service. |
| CreateDeliveryOrder(Guid, Guid, NullableInt32, DateTime, String, AddressDto, NullableDateTime, IOrderType, IClientStub, IUser, NullableTimeSpan, String, Boolean, Boolean) | Creates new delivery order. User must have rights to edit delivery orders. Specify address for courier-service; leave it null for self-service. |
| CreateJournalEvent | Creates new journal event. |
| CreateOrder | Creates new order on specified table. User must have rights to create orders. |
| CreateReserve | Creates reservation for planned visit in future. Table will be marked as reserved to prevent collision with other guests at the same time. |
| CreateStreet(String) | Creates new street. |
| CreateStreet(Guid, String, ICity) | Creates new street. |
| DeleteDiscount | Removes discount of known type from existing order. User must have rights to work with discounts. |
| DeleteExternalFiscalizedPaymentItem | Delete existing externally fiscalized payment item from order. |
| DeleteExternalPaymentItem | Delete existing external payment item from order. |
| DeleteOrderCombo | Delete order combo item. |
| DeleteOrderExternalData | Deletes external data from the order. |
| DeleteOrderGuest | Deletes guest without any products from order. |
| DeleteOrderItem | Deletes order item from order that represents the assortment position. User must have rights to edit orders. |
| DeleteOrderItemComment | Deletes product order item's comment. |
| DeleteOrderModifierItem(IOrderStub, IOrderCompoundItemComponentStub, IOrderModifierItem) | Deletes order item modifier from order item that represents the assortment position. User must have rights to edit orders. |
| DeleteOrderModifierItem(IOrderStub, IOrderCompoundItemStub, IOrderModifierItem) | Deletes order item modifier from order item that represents the assortment position. User must have rights to edit orders. |
| DeleteOrderModifierItem(IOrderStub, IOrderProductItemStub, IOrderModifierItem) | Deletes order item modifier from order item that represents the assortment position. User must have rights to edit orders. |
| DeleteOrRestoreStreet | Deletes street. |
| DeletePaymentItem | Delete existing payment item from order. |
| DeletePreliminaryPaymentItem | Delete existing preliminary payment item from order. |
| DeletePrintedOrderItemComment | Deletes product order item's comment. |
| DeletePrintedOrderItems | Deletes order items that is already printed. User must have rights to edit orders. |
| DeletePrintedOrderModifierItem | Deletes order item modifier that is already printed. User must have rights to edit orders. |
| GroupOrderCookingItems | Combines the order item products into mix group so that they will be cooked together. Only consecutive products of the same guest can be combined into mix group. |
| MarkOrderAsAdditional | Marks order as additional. |
| MarkOrderAsTab | Marks the order as tab and assigns tab name. |
| MoveOrderItemToAnotherGuest | Moves product item between guests of the same order. |
| MoveOrderItemToAnotherOrder | Moves product item between orders. |
| OverrideVatInclusionForOrder | Overrides default VAT inclusion settings for items of the specified order. |
| RecoverCorruptedReserve | Recovers banquet which is bound to non-existent order. Normally such cases should never occur, but due to entities storage implementation details sometimes banquet may loose its order. Note that new empty order will be created from scratch. |
| RenameOrderGuest | Renames order's guest. |
| ReopenReserve | Reopens previously closed or canceled reserve. |
| ResetIsPrintedDeliveryBillActual | Resets whether latest printed bill is actual to 'false' value. Use when you want delivery bill to be print again according to settings. For example, if you changed courier and wish to have actual name on the bill, call this action and delivery will automatically printed according to settings. On the contrary, if you don't want bill to be printed again (for example, courier is written to the bill later by hands), you have no need to call this action. |
| ResetOderLastChangeTimeByWaiter | Reset order last change time by waiter time to now. User must have rights to edit orders. |
| ResetPriceCategory | Resets price category of the order. |
| ServeOrderCookingItem | Mark order item product as served. |
| SetChequeAdditionalInfo | Sets cheque information to the order. |
| SetCompoundItemComponentCustomName | Sets the custom name of the compound component. User must have rights to edit orders. |
| SetDeliveryCloseTime | Changes delivery closing status and time. |
| SetDeliveryCustomerAuthorizedInIikoBiz | Changes whether the client is already authorized in iiko.biz. WARNING: use with caution! Illegal value can lead to unsuccessful iiko.biz operations. Do NOT set this property to 'true' if you are not sure that all authorization properties are correct and customer is registered in iiko.biz; that will cause iiko.biz payment failure. |
| SetDeliveryDelivered | Changes delivery status from OnWay to Delivere and sets current time as time when the order was actually delivered. |
| SetDeliveryUndelivered | Returns the delivery from the Delivered status back to the OnWay status. |
| SetJournalEventAttribute | Sets attribute for journal event. |
| SetOpenPrice | Changes order item open price. |
| SetOrderHasFixedIikoCardDiscounts | Sets that the order has fixed iikoCard discounts. |
| SetOrderModifierItemCustomName(String, IOrderStub, IOrderCompoundItemComponentStub, IOrderModifierItemStub) | Sets the custom name of the compound component modifier. User must have rights to edit orders. |
| SetOrderModifierItemCustomName(String, IOrderStub, IOrderCompoundItemStub, IOrderModifierItemStub) | Sets the custom name of the compound item common modifier. User must have rights to edit orders. |
| SetOrderModifierItemCustomName(String, IOrderStub, IOrderProductItemStub, IOrderModifierItemStub) | Sets the custom name of the product item modifier. User must have rights to edit orders. |
| SetOrderType | Sets order type for order. |
| SetProductItemCustomName | Sets the custom name of the product item. User must have rights to edit orders. |
| SetServiceItemCustomName | Sets the custom name of the service item. User must have rights to edit orders. |
| SetServiceItemPeriodCustomName | Sets the custom name of the service period. User must have rights to edit orders. |
| SkipScanningOrderItemMarkingCode | Skips scanning marking code of a product within an order item. Marking code of order item will be reset to null. Use ChangeOrderItemMarkingCode(String, IOrderStub, IOrderProductItemStub) to reset this option. |
| SplitOrderCookingItem | Cut off specified amount from product to new one. |
| StartBanquet | Transits banquet to the started status. |
| UngroupOrderCookingItems | Separates the order item products from mix group so that they will be cooked independently. |
| UnserveOrderCookingItem | Mark order item product as unserved. |
| UpdateOrderComboItems | Update existing order combo items. Order must contain new combo items. |
Extension Methods| Name | Description | |
|---|---|---|
 | ChangeReserveTable | Changes reserving table. (Defined by EditSessionExtensions.) |
| CreateBanquet | Creates reservation for planned event in future. Table will be marked as reserved to prevent collision with other events at the same time. (Defined by EditSessionExtensions.) |
| CreateOrder | Creates new order on specified table. User must have rights to create orders. (Defined by EditSessionExtensions.) |
| CreateReserve | Creates reservation for planned visit in future. Table will be marked as reserved to prevent collision with other guests at the same time. (Defined by EditSessionExtensions.) |
See Also