Click or drag to resize

IDeliveryOrder Interface

Namespace:  Resto.Front.Api.Data.Orders
Assembly:  Resto.Front.Api.V8 (in Resto.Front.Api.V8.dll)
Syntax
C#
public interface IDeliveryOrder : IOrder, 
	ISerializable, IEntity, IVersionedEntity, IOrderStub, IDeliveryOrderStub

The IDeliveryOrder type exposes the following members.

Properties
  NameDescription
Public propertyActualDeliverTime
Time when order was actually delivered to the client
Public propertyAddress
Address where the order will be delivered
Public propertyAppliedDiscounts
The result of applying discount items from Discounts. Discount items that don't affect the order, aren't included into this collection.
(Inherited from IOrder.)
Public propertyBillTime
Gets the bill cheque print time of the current order.
(Inherited from IOrder.)
Public propertyCafeAddress
Restaurant address
Public propertyCancelCause
Cause of cancelling the order
Public propertyCancelComment
Comment to the order cancellation
Public propertyCancelTime
Time when the order was marked as cancelled
Public propertyCashier
Gets the user closed the current order.
(Inherited from IOrder.)
Public propertyChequeAdditionalInfo
Cheque information of the order.
(Inherited from IOrder.)
Public propertyClient
Client that placed the delivery.
Public propertyClientName
Name of client
Public propertyCloseTime
Gets the payment time of the current order.
(Inherited from IOrder.)
Public propertyCombos (Inherited from IOrder.)
Public propertyComment
Client's comment on order
Public propertyConfirmTime
Time when order was confirmed
Public propertyCookingFinishTime
Time when order cooking was finished
Public propertyCookingPriority
Specifies a custom cooking priority. While the application provides built-in prioritization logic for orders based on timing, dish courses, etc., you can override it and enforce custom cooking order based on your external logic. Ideally, all dishes should be cooked timely, but in case of concurrency when kitchen is high-loaded, you have to decide which orders are more important and should be cooked in the first place and which orders are allowed to be delayed. Higher priority values mean that the order, its serve groups and dishes will appear at the kitchen display earlier. Default value is zero. Both positive and negative values are allowed for raising and lowering the priority correspondingly. Orders with the same cooking priority will be sorted using default built-in logic.
(Inherited from IOrder.)
Public propertyCourier
Courier that delivers the order
Public propertyCreateTime
Time when order was created
Public propertyCustomApiData
Custom data about delivery from Api
Public propertyCustomerIds (Inherited from IOrder.)
Public propertyDeliveryCloseTime
Time when delivery order was marked as closed
Public propertyDeliveryId
Identifier of the delivery, don't confuse it with identifier of the delivery order. This property exists for historical reason, avoid using it when possible.
Public propertyDeliveryOperator
User who created the order
Public propertyDeliveryStatus
Status of the delivery
Public propertyDiscounts
Discount items that have been added to the order.
(Inherited from IOrder.)
Public propertyDonations (Inherited from IOrder.)
Public propertyDuration
Public propertyEmail
E-mail of client
Public propertyEstimatedGuestsCount
Gets estimated guests count, that is greater than or equal to added guests count. When single order is used to serve many people and handling each of them as a separate guest may be inconvenient, this property will indicate estimated guests count while guests collection will contain as many guests as needed for waiters.
(Inherited from IOrder.)
Public propertyExpectedDeliverTime
Time when client wants the order to be delivered
Public propertyExpectedDuration
Duration calculated without overridden value on terminal
Public propertyExternalCourierServiceData
External service courier that delivers the order
Public propertyExternalNumber
Optional order number in the external system. This can be used to match the external order to the iiko one. This property contains either null or number of the source order was received from. Specifying origin order number allows to analyse efficiency of external order sources such as different web-sites, mobile applications and so on.
(Inherited from IOrder.)
Public propertyFiscalChequeNumbers
Fiscal cheque numbers.
(Inherited from IOrder.)
Public propertyFullSum
Subtotal, sum of all not deleted order items with included vat, but without excluded vat and discounts.
(Inherited from IOrder.)
Public propertyGroupOrderId
Group order id, if current order is an additional order.
(Inherited from IOrder.)
Public propertyGuests (Inherited from IOrder.)
Public propertyHasProblem
Whether the order is marked as having problem
Public propertyId (Inherited from IEntity.)
Public propertyIikoCard51Info
Specific data for iikoCard51.
(Inherited from IOrder.)
Public propertyIndexInCourierRoute
Index of the order in courier route (zero-based)
Public propertyIsBanquetOrder
Order is for banquet.
(Inherited from IOrder.)
Public propertyIsCourierSelectedManually
Whether courier was selected from UI or automatically
Public propertyIsCustomerAuthorizedInIikoBiz
Indicates whether customer is already authorized in iiko.biz, i.e. his credentials are verified
Public propertyIsFastFoodOrder
Order is FastFood.
(Inherited from IOrder.)
Public propertyIsPrintedBillActual
Whether the order bill was already printed and since then it's considered to be actual. Also means whether the bill will be printed automatically according to settings: if it's not already printed, it will.
Public propertyIsTopCookingPriority
The flag specifies that this order should be cooked out-of-order at kitchen. All orders which have this flag set on will appear above other orders at the kitchen display. Both groups (top priority and non-top priority) will be sorted separately using usual sorting logic (custom cooking priority, then default built-in criterions. Default value is false.
(Inherited from IOrder.)
Public propertyItems (Inherited from IOrder.)
Public propertyLastChangedTerminalId
Id of the terminal (ITerminal) that last changed the order.
(Inherited from IOrder.)
Public propertyLastVerifiedDeliveryRestrictionsHash
Last verified on server delivery restrictions hash
Public propertyLatitude
Latitude of geoposition of the delivery address
Public propertyLongitude
Longitude of geoposition of the delivery address
Public propertyMarketingSource
Advertising Source of the order (for example, some web site, call center)
Public propertyMovedFromDeliveryId
Identifier of the old delivery, from which the current one was created after transferring to a new terminal
Public propertyMovedFromTerminalGroupId
Group identifier of the old delivery, from which the current one was created after transferring to a new terminal
Public propertyMovedToDeliveryId
Identifier of the new delivery created to transfer the old one to a new terminal
Public propertyMovedToTerminalGroupId
Group identifier of the new delivery created to transfer the old one to a new terminal
Public propertyNumber (Inherited from IOrder.)
Public propertyOpenTime (Inherited from IOrder.)
Public propertyOrderType (Inherited from IOrder.)
Public propertyOriginName
Optional marker used to specify order origin. This property contains either null or name of the source order was received from. Specifying origin allows to analyse efficiency of external order sources such as different web-sites, mobile applications and so on.
(Inherited from IOrder.)
Public propertyParentOrderId
The Id of the original order, if the current order is the result of a split.
(Inherited from IOrder.)
Public propertyPaymentDiscounts
The result of applying payment items from Payments processed or fiscalized as discounts.
(Inherited from IOrder.)
Public propertyPayments (Inherited from IOrder.)
Public propertyPhone
Phone of client
Public propertyPredictedCookingCompleteTime
Predicted time when order cooking should be completed
Public propertyPredictedDeliveryTime
Predicted time when order should be delivered
Public propertyPriceCategory
Price category.
(Inherited from IOrder.)
Public propertyPricingTime
Time, which determines the price of products. By default time is taken from items print time.
(Inherited from IOrder.)
Public propertyPrintTime
Time when products were printed
Public propertyProblemComment
Description of the problem. Non-empty ProblemComment doesn't mean delivery is currently has a problem: comment could been filled in earlier, and after that HasProblem flag was unchecked. That means that the order had some problems earlier.
Public propertyProcessedPaymentsSum
Sum of all processed payment items in order.
(Inherited from IOrder.)
Public propertyRemovedItems
List of items which were deleted before printing.
(Inherited from IOrder.)
Public propertyRepeatBillNumber
Number of repeated bills.
(Inherited from IOrder.)
Public propertyReserve
Reserve / banquet related to the order.
(Inherited from IOrder.)
Public propertyResultSum
Total sum to be paid, sum of all not deleted order items with discounts and both included and excluded vat.
(Inherited from IOrder.)
Public propertyRevision
Incremental version of the entity.
(Inherited from IVersionedEntity.)
Public propertySendTime
Time when order was sent to client
Public propertySourceId
Identifier of the delivery that existed before splitting it by multiple cash registers. Depending on settings, a single delivery can be split by multiple cash registers before payment, producing multiple deliveries. At this moment SourceId of all produced deliveries is set to Id of the source delivery. If delivery was not splitted by cash registers, SourceId returns null.
Public propertySplitBetweenPersons
Indicates whether the order should be splitted between persons or not
Public propertyStatus (Inherited from IOrder.)
Public propertyStornedOrderId
Source order's identifier this order copied from during storno operation. null if the order has never storned.
(Inherited from IOrder.)
Public propertyTables (Inherited from IOrder.)
Public propertyTabName
Optional marker used to specify that the order is a tab. This property contains name of the tab if the order is marked as tab, otherwise null.
(Inherited from IOrder.)
Public propertyWaiter (Inherited from IOrder.)
Public propertyWasPrepaid
Whether order was prepaid. Any processed or deleted prepay.
(Inherited from IOrder.)
Public propertyZone
Name of a delivery zone set for the address
Top
Methods
  NameDescription
Public methodGetObjectData
Populates a SerializationInfo with the data needed to serialize the target object.
(Inherited from ISerializable.)
Top
Extension Methods
  NameDescription
Public Extension MethodGetOrderAllExternalData (Defined by OperationArgumentExtensions.)
Public Extension MethodTryGetOrderExternalDataByKey
Returns external data by key. Use [!:AddOrderExternalData] to add the data in order.
(Defined by OperationArgumentExtensions.)
Top
See Also