IEditSession InterfaceiikoFront Api V3 Documentation

Namespace: Resto.Front.Api.V3.Editors
Assembly: Resto.Front.Api.V3 (in Resto.Front.Api.V3.dll) Version: 4.1.1236.1 (4.1.1236.1)
Syntax

C#
public interface IEditSession

The IEditSession type exposes the following members.

Methods

  NameDescription
Public methodActivateReserve
Closes reserve and creates order on reserved table.
Public methodAddDiscount
Adds simple discount of known type to existing order. User must have rights to work with discounts.
Public methodAddDiscountByCardNumber
Add discount by card number
Public methodAddOrderGuest(String, IOrderStub)
Adds new guest to existing order. User must have rights to edit orders.
Public methodAddOrderGuest(Guid, String, IOrderStub)
Adds new guest with the given ID to existing order. User must have rights to edit orders.
Public methodAddOrderItemModifier(Int32, IProduct, IProductGroup, IOrderStub, IOrderItemProductStub)
Adds order item modifier to the order item in existing order. User must have rights to edit orders.
Public methodAddOrderItemModifier(Guid, Int32, IProduct, IProductGroup, IOrderStub, IOrderItemProductStub)
Adds order item modifier to the order item in existing order. User must have rights to edit orders.
Public methodAddOrderItemProduct(Decimal, IProduct, IOrderStub, IOrderItemGuestStub)
Adds assortment position to the guest in existing order. User must have rights to edit orders.
Public methodAddOrderItemProduct(Decimal, OrderItemCourse, IProduct, IOrderStub, IOrderItemGuestStub)
Adds assortment position with specific OrderItemCourse to the guest in existing order. User must have rights to edit orders.
Public methodAddOrderItemProduct(Guid, Decimal, IProduct, IOrderStub, IOrderItemGuestStub)
Adds assortment position to the guest in existing order. User must have rights to edit orders.
Public methodAddOrderItemProduct(Guid, Decimal, OrderItemCourse, IProduct, IOrderStub, IOrderItemGuestStub)
Adds assortment position to the guest in existing order. User must have rights to edit orders.
Public methodBindReserveToOrder
Converts exising reserve or banquet without order to banquet with order.
Public methodChangeClientAddresses
Changes client addresses.
Public methodChangeClientBlacklistInfo
Changes client blacklist info
Public methodChangeClientCardNumber
Changes client card number
Public methodChangeClientComment
Changes client comment
Public methodChangeClientEmails
Changes client emails list
Public methodChangeClientIikoNetId
Changes client's account in iikoNet
Public methodChangeClientMainAddressIndex
Changes client main address index
Public methodChangeClientName
Changes client name
Public methodChangeClientNick
Changes client nickname
Public methodChangeClientPhones
Changes client phones list
Public methodChangeClientSurname
Changes client surname
Public methodChangeDeliveryActualDeliverTime
Change time when delivery was actually delivered.
Public methodChangeDeliveryAddress
Changes address of delivery
Public methodChangeDeliveryComment
Change delivery comment
Public methodChangeDeliveryConfirmTime
Change delivery when delivery was confirmed.
Public methodChangeDeliveryCourier
Assign/Change delivery courier. Can use this action only before delivery is to be delivered.
Public methodChangeDeliveryDuration
Change duration of delivery processing
Public methodChangeDeliveryEmail
Change delivery e-mail
Public methodChangeDeliveryExpectedDeliverTime
Change time when client want delivery to be delivered
Public methodChangeDeliveryLocation
Change delivery address location.
Public methodChangeDeliveryMarketingSource
Assign/Change delivery marketing source.
Public methodChangeDeliveryOperator
Assign/Change delivery operator.
Public methodChangeDeliveryPersonsCount
Changes persons count for a delivery
Public methodChangeDeliveryPhone
Changes delivery phone
Public methodChangeDeliveryProblemComment
Change delivery problem comment
Public methodChangeDeliveryProblemStatus
Change delivery problem status
Public methodChangeDeliverySplitBetweenPersons
Changes delivery property if order should be split between persons
Public methodChangeEstimatedOrderGuestsCount
Changes estimated order guests count. Use this method to set estimated guests count when guests collection doesn't reflect actual state of affairs.
Public methodChangeOrderItemComment
Changes product order item's comment.
Public methodChangeOrderItemModifierAmount
Changes the amount of the order item modifier. User must have rights to edit orders.
Public methodChangeOrderItemProductAmount
Changes the amount of the assortment position in existing order. User must have rights to edit orders.
Public methodChangeOrderItemProductCourse
Changes the course of the order item.
Public methodChangeOrderOriginName
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.
Public methodChangeReserveComment
Changes reserve comment. Use empty string to clear comment.
Public methodChangeReserveDuration
Changes estimated reserve duration (amount of time betwen visit's start and end). Default reserve duration is 2 hours, banquet duration is 3 hours.
Public methodChangeReserveEstimatedStartTime
Changes estimated reserve start time.
Public methodChangeReserveGuestsCount
Changes estimated guests count for reserve. Default value is 2.
Public methodChangeReserveReminder
Changes reserve reminder flag.
Public methodChangeReserveTable
Changes reserving table.
Public methodChangeStreetName
Changes street's name
Public methodCreateBanquet(DateTime, IClientStub, ITable)
Creates reservation for planned event in future. Table will be marked as reserved to prevent collision with other events at the same time.
Public methodCreateBanquet(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.
Public methodCreateClient(Guid, String, ListPhoneDto)
Creates new client without date created. Date created should be not null for relevant OLAP reports (call CreateClient(Guid, String, ListPhoneDto, DateTime)). After invoke of this action you need set necessary properties such as Name.
Public methodCreateClient(Guid, String, ListPhoneDto, DateTime)
Creates new client. After invoke of this action you need set necessary properties such as Name.
Public methodCreateDelivery
Creates new delivery. Specify address for courier-service; leave it null for self-service.
Public methodCreateDeliveryOrder
Public methodCreateOrder
Creates new order on specified table. User must have rights to create orders.
Public methodCreateReserve
Creates reservation for planned visit in future. Table will be marked as reserved to prevent collision with other guests at the same time.
Public methodCreateStreet(String)
Creates new street.
Public methodCreateStreet(Guid, String, ICity)
Creates new street.
Public methodDeleteDiscount
Removes discount of known type to existing order. User must have rights to work with discounts.
Public methodDeleteExternalPaymentItem
Delete existing external payment item from order.
Public methodDeleteOrderGuest
Deletes guest without any products from order.
Public methodDeleteOrderItemComment
Deletes product order item's comment.
Public methodDeleteOrderItemModifier
Deletes order item modifier from order item that represents the assortment position. User must have rights to edit orders.
Public methodDeleteOrderItemProduct
Deletes order item from order that represents the assortment position. User must have rights to edit orders.
Public methodDeleteOrRestoreStreet
Deletes street
Public methodDeletePaymentItem
Delete existing payment item from order.
Public methodDeletePrintedOrderItemModifier
Deletes order item modifier that is already printed. User must have rights to edit orders.
Public methodDeletePrintedOrderItemProduct
Deletes order item that is already printed. User must have rights to edit orders.
Public methodMoveOrderItemProduct
Moves product item between guests of the same order.
Public methodMoveOrderItemProductToAnotherOrder
Moves product item between orders.
Public methodRecoverCorruptedReserve
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.
Public methodRenameOrderGuest
Renames order's guest.
Public methodReopenReserve
Reopens previously closed or canceled reserve.
Public methodServeOrderItemProduct
Mark order item product as served.
Public methodSetDeliveryConfirmed
Change delivery status to confirmed.
Public methodSetDeliveryDelivered
Change delivery status to delivered.
Public methodSetDeliveryUnconfirmed
Change delivery status to unconfirmed.
Public methodSetDeliveryUndelivered
Change delivery status to OnWay from status delivered.
Public methodSetOrderType
Sets order type for existing order.
Public methodStartBanquet
Transits banquet to the started status.
Public methodUnserveOrderItemProduct
Mark order item product as unserved.
Top
See Also

Reference