IEditSession Interface

Namespace: Resto.Front.Api.V5.Editors
Assembly: Resto.Front.Api.V5 (in Resto.Front.Api.V5.dll)

Syntax

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
	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 order.
	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, 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, 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, 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, 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, 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, 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.
	AddPaymentItem	Add new payment item to order.
	AddPreliminaryPaymentItem	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.
	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
	ChangeClientEmails	Changes client emails list
	ChangeClientGender	Change client's gender.
	ChangeClientIikoBizId	Changes client's account in iiko.biz
	ChangeClientIikoNetId	Changes client's account in Plazius
	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
	ChangeClientPhones	Changes client phones list
	ChangeClientReceivesNotifications	Changes whether client receives notification messages
	ChangeClientSurname	Changes client surname
	ChangeComboAmount	Change combo amount.
	ChangeComboPrice	Change combo price.
	ChangeDeliveryActualDeliverTime	Change time when the order was actually delivered.
	ChangeDeliveryAddress	Changes address of delivery
	ChangeDeliveryComment	Change the order comment
	ChangeDeliveryConfirmTime	Change when the order was confirmed.
	ChangeDeliveryCourier	Assign/Change the order courier. Can use this action only before the order is to be delivered.
	ChangeDeliveryDuration	Change duration of delivery processing
	ChangeDeliveryEmail	Change the order e-mail
	ChangeDeliveryExpectedDeliverTime	Change time when client wants the order to be delivered
	ChangeDeliveryLastVerifiedRestrictionsHash	Set last verified restirictions hash from server
	ChangeDeliveryLocation	Changes delivery address location.
	ChangeDeliveryMarketingSource	Assign/change order marketing source.
	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
	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	Change iikoCard5 manual conditions applied for order.
	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.
	ChangeOrderIikoCard5Coupon	Change order iikoCard5 coupon, used in iikoCard5 system..
	ChangeOrderItemComment	Changes product order item's comment.
	ChangeOrderItemWaiter	Changes product order item's waiter.
	ChangeOrderModifierItemAmount(Int32, IOrderStub, IOrderCompoundItemComponentStub, IOrderModifierItemStub)	Changes the amount of the compound component modifier. User must have rights to edit orders.
	ChangeOrderModifierItemAmount(Int32, IOrderStub, IOrderCompoundItemStub, IOrderModifierItemStub)	Changes the amount of the compound item common modifier. User must have rights to edit orders.
	ChangeOrderModifierItemAmount(Int32, IOrderStub, IOrderProductItemStub, IOrderModifierItemStub)	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.
	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
	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, IReadOnlyListITable)	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.
	CreateDeliveryOrder(NullableInt32, DateTime, String, AddressDto, DateTime, IOrderType, IClientStub, IUser, NullableTimeSpan)	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, DateTime, IOrderType, IClientStub, IUser, NullableTimeSpan)	Creates new delivery order. User must have rights to edit delivery orders. Specify address for courier-service; leave it null for self-service.
	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.
	DeleteOrderCombo	Delete order combo item.
	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.
	DeletePrintedOrderItem	Deletes order item 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.
	MoveOrderItemToAnotherGuest	Moves product item between guests of the same order.
	MoveOrderItemToAnotherOrder	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.
	ServeOrderCookingItem	Mark order item product as served.
	SetDeliveryConfirmed	Change delivery status to confirmed.
	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.
	SetDeliveryCustomerAuthorizedInIikoNet	Changes whether the client 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.
	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.

Top

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.)

Top

Reference

Resto.Front.Api.V5.Editors Namespace