IEditSession Interface |
Namespace: Resto.Front.Api.V4.Editors
Assembly: Resto.Front.Api.V4 (in Resto.Front.Api.V4.dll)
SyntaxC#
public interface IEditSession
The IEditSession type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | ActivateReserve | Closes reserve and creates order on reserved table. |
| AddDiscount | Adds simple discount of known type to existing order. User must have rights to work with discounts. |
| AddDiscountByCardNumber | Add discount by card number |
| AddExternalPaymentItem | 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 |
| 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. |
| AddOrderItemModifier(Int32, IProduct, IProductGroup, IOrderStub, IOrderItemProductStub) | Adds order item modifier to the order item in existing order. User must have rights to edit orders. |
| AddOrderItemModifier(Guid, Int32, IProduct, IProductGroup, IOrderStub, IOrderItemProductStub) | Adds order item modifier to the order item in existing order. User must have rights to edit orders. |
| AddOrderItemProduct(Decimal, IProduct, IOrderStub, IOrderItemGuestStub) | Adds assortment position to the guest in existing order. User must have rights to edit orders. |
| AddOrderItemProduct(Decimal, OrderItemCourse, IProduct, IOrderStub, IOrderItemGuestStub) | Adds assortment position with specific OrderItemCourse to the guest in existing order. User must have rights to edit orders. |
| AddOrderItemProduct(Guid, Decimal, IProduct, IOrderStub, IOrderItemGuestStub) | Adds assortment position to the guest in existing order. User must have rights to edit orders. |
| AddOrderItemProduct(Guid, Decimal, OrderItemCourse, IProduct, IOrderStub, IOrderItemGuestStub) | Adds assortment position to the guest in existing order. User must have rights to edit orders. |
| AddPaymentItem | Add new payment item to order. |
| AddPreliminaryPaymentItem | Add new preliminary payment item to order. |
| BindReserveToOrder | Converts exising reserve or banquet without order to banquet with order. |
| ChangeClientAddresses | Changes client addresses. |
| ChangeClientBlacklistInfo | Changes client blacklist info |
| ChangeClientCardNumber | Changes client card number |
| ChangeClientComment | Changes client comment |
| ChangeClientEmails | Changes client emails list |
| ChangeClientIikoBizId | Changes client's account in iiko.biz |
| ChangeClientIikoNetId | Changes client's account in Plazius |
| ChangeClientLinkedCounteragent | Changes client linked counter agent. |
| ChangeClientMainAddressIndex | Changes client main address index |
| ChangeClientName | Changes client name |
| ChangeClientNick | Changes client nickname |
| ChangeClientPhones | Changes client phones list |
| ChangeClientSurname | Changes client surname |
| ChangeDeliveryActualDeliverTime | Change time when delivery was actually delivered. |
| ChangeDeliveryAddress | Changes address of delivery |
| ChangeDeliveryComment | Change delivery comment |
| ChangeDeliveryConfirmTime | Change delivery when delivery was confirmed. |
| ChangeDeliveryCourier | Assign/Change delivery courier. Can use this action only before delivery is to be delivered. |
| ChangeDeliveryDuration | Change duration of delivery processing |
| ChangeDeliveryEmail | Change delivery e-mail |
| ChangeDeliveryExpectedDeliverTime | Change time when client want delivery to be delivered |
| ChangeDeliveryLocation | Changes delivery address location. |
| ChangeDeliveryMarketingSource | Assign/Change delivery marketing source. |
| ChangeDeliveryOperator | Assign/Change delivery operator. |
| ChangeDeliveryOrderPredictedCookingCompleteTime | Change predicted time when delivery order was cooking completed. Can change property only for Unconfirmed, New or Waiting delivery. |
| ChangeDeliveryPersonsCount | Changes persons count for a delivery |
| ChangeDeliveryPhone | Changes delivery phone |
| ChangeDeliveryPredictedDeliveryTime | Change predicted time when delivery was delivered. Can change property only for Unconfirmed, New or Waiting delivery. |
| ChangeDeliveryProblemComment | Change delivery problem comment |
| ChangeDeliveryProblemStatus | Change delivery problem status |
| ChangeDeliverySplitBetweenPersons | Changes delivery property if order should be split between persons |
| ChangeEstimatedOrderGuestsCount | Changes estimated order guests count. Use this method to set estimated guests count when guests collection doesn't reflect actual state of affairs. |
| ChangeOrderItemComment | Changes product order item's comment. |
| ChangeOrderItemModifierAmount | Changes the amount of the order item modifier. User must have rights to edit orders. |
| ChangeOrderItemProductAmount | Changes the amount of the assortment position in existing order. User must have rights to edit orders. |
| ChangeOrderItemProductCourse | Changes the course of the order item. |
| ChangeOrderItemWaiter | Changes product order item's waiter. |
| 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. |
| ChangePaymentItemSum | Changes sum of existing payment item. |
| ChangePreliminaryPaymentItemSum | Changes sum of existing preliminary payment item |
| 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 | 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 |
| CreateBanquet(DateTime, IClientStub, IOrderStub) | 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, IClientStub, ListITable) | 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. After invoke of this action you need set necessary properties such as Name and also Phones or CardNumber. The client should at least have one phone number or number of discount cards. |
| CreateDelivery | Creates new delivery. Specify address for courier-service; leave it null for self-service. |
| CreateDeliveryOrder(IOrderType) | Creates new delivery order on default table (depending on select iikoFront mode). User must have rights to edit deliveries. DeliveryOrder must be linked with Delivery (use CreateDelivery(Guid, NullableInt32, DateTime, String, AddressDto, String, TimeSpan, DateTime, IDeliveryOrderStub, IClientStub, IUser)). |
| CreateDeliveryOrder(Guid, IOrderType) | Creates new delivery order on default table (depending on select iikoFront mode). User must have rights to edit deliveries. DeliveryOrder must be linked with Delivery (use CreateDelivery(Guid, NullableInt32, DateTime, String, AddressDto, String, TimeSpan, DateTime, IDeliveryOrderStub, IClientStub, IUser)). |
| 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 to existing order. User must have rights to work with discounts. |
| DeleteExternalPaymentItem | Delete existing external payment item from order. |
| DeleteOrderGuest | Deletes guest without any products from order. |
| DeleteOrderItemComment | Deletes product order item's comment. |
| DeleteOrderItemModifier | Deletes order item modifier from order item that represents the assortment position. User must have rights to edit orders. |
| DeleteOrderItemProduct | Deletes order item from order 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. |
| DeletePrintedOrderItemModifier | Deletes order item modifier that is already printed. User must have rights to edit orders. |
| DeletePrintedOrderItemProduct | Deletes order item that is already printed. User must have rights to edit orders. |
| GroupOrderItemProducts | 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. |
| MoveOrderItemProduct | Moves product item between guests of the same order. |
| MoveOrderItemProductToAnotherOrder | Moves product item between orders. |
| 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. |
| ServeOrderItemProduct | Mark order item product as served. |
| SetDeliveryConfirmed | Change delivery status to confirmed. |
| SetDeliveryCustomerAuthorizedInIikoBiz | Changes whether delivery customer 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. |
| SetDeliveryCustomerAuthorizedInIikoNet | Changes whether delivery customer is already authorized in Plazius. WARNING: use with caution! Illegal value can lead to unsuccessful Plazius operations. Do NOT set this property to 'true' if you are not sure that all authorization properties are correct and customer is registered in Plazius; that will cause Plazius payment failure. |
| SetDeliveryDelivered | Change delivery status to delivered. |
| SetDeliveryUnconfirmed | Change delivery status to unconfirmed. |
| SetDeliveryUndelivered | Change delivery status to OnWay from status delivered. |
| SetOrderType | Sets order type for existing order. |
| StartBanquet | Transits banquet to the started status. |
| UngroupOrderItemProducts | Separates the order item products from mix group so that they will be cooked independently. |
| UnserveOrderItemProduct | Mark order item product as unserved. |
Extension Methods| Name | Description | |
|---|---|---|
 | ChangeReserveTable | Changes reserving table. (Defined by IEditSessionExtensions.) |
| 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 IEditSessionExtensions.) |
| CreateOrder | Creates new order on specified table. User must have rights to create orders. (Defined by IEditSessionExtensions.) |
| 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 IEditSessionExtensions.) |
See Also