Order.md

Flipdish.Model.Order

Properties

Name	Type	Description	Notes
Store	StoreSummary	Store summary	[optional]
Customer	CustomerSummary	Customer summary	[optional]
Voucher	OrderVoucherSummary	Voucher summary	[optional]
Fees	FeeSummary	Fee summary	[optional]
OrderItems	List<OrderItem>	Ordered items	[optional]
DeliveryLocation	DeliveryLocation	Delivery location for delivery orders	[optional]
CustomerLocation	Coordinates	Customer location	[optional]
MaskedPhoneNumber	MaskedPhoneNumber	Represents customers masked phone number	[optional]
DropOffLocationId	int?	Represents table service drop off location	[optional]
DropOffLocation	string	Represents table service drop off location	[optional]
AcceptedFor	DateTime?	Time store has accepted the order for	[optional]
InFraudZone	bool?	Was order made within a fraud zone	[optional]
UnusualHighValueOrder	bool?	Is order of unusually high value	[optional]
RejectedByUserId	int?	Id of user who rejected order, if available	[optional]
ChannelOrderId	string	ChannelOrderId from external channel	[optional]
ChannelOrderDisplayId	string	ChannelOrderDisplayId from external channel	[optional]
Channel	Channel	Channel where the Order comes from	[optional]
OrderDropOffLocation	OrderDropOffLocation	DropOffLocation selected for this order	[optional]
FulfillmentStatus	OrderFulfillmentStatusBase	[BETA - this is a new field in development] Fulfillment status for this order	[optional]
OrderBatchInfo	OrderBatchSummary	OrderBatch information	[optional]
TaxItems	List<TaxItem>	A collection of tax items on the order.	[optional]
CreatedCampaignVoucherId	int?	The id of the campaign voucher that was created from this order	[optional]
OrderId	int?	Order identifier	[optional]
LocalOrderId	string	Local order Id. This is used for displaying a &quot;shorter&quot; order ID for customers (eg. Kiosk orders)	[optional]
DeliveryType	string	Delivery type	[optional]
PickupLocationType	string	Pickup location type	[optional]
TableServiceCatagory	string	Pickup location type	[optional]
TipAmount	double?	Tip amount	[optional]
DeliveryAmount	double?	Delivery amount	[optional]
OrderItemsAmount	double?	Ordered items amount	[optional]
ServiceChargeAmount	double?	Service Charge Amount	[optional]
ServiceChargePercentage	double?	Service Charge Percentage	[optional]
Amount	double?	This is the sum of the OrderItemsAmount, DeliveryAmount, TipAmount and Voucher.Amount (which is usually negative) and OnlineOrderingFee for cash orders. It does not include the OnlineOrderingFee in the case of card orders as this fee is charged by Flipdish directly to the customer.	[optional]
ProcessingFee	double?	This contains the online ordering processing fee. For card payments this is charged directly to the customer and for cash orders it is paid by the customer to the store. It is tax inclusive.	[optional]
PaymentAccountType	string	Payment account type	[optional]
PaymentAccountDescription	string	Payment account description (like Visa ****2371 or Apple Pay. or Cash)	[optional]
OrderState	string	Order state	[optional]
IsPreOrder	bool?	Is pre-order	[optional]
PlacedTime	DateTime?	Order placed time	[optional]
RequestedForTime	DateTime?	Order requested for	[optional]
ChefNote	string	Chef note	[optional]
AppType	string	Used app type	[optional]
UserRating	int?	User rating	[optional]
PaymentStatus	string	Status of the payment	[optional]
RejectionReason	string	Rejection reason. Can have value if the order is rejected.	[optional]
RefundedAmount	double?	Amount refunded to customer.	[optional]
DeliveryTrackingStatus	string	Delivery tracking status	[optional]
DriverId	int?	Assigned driver identifier	[optional]
TotalTax	double?	Total tax applied to order	[optional]
OrderTrackingCode	string	Unique, 6 character long alpha numeric code for tracking.	[optional]
DeliveryFeeAreaId	int?	Delivery area identifier	[optional]
ReceiptCode	string	Code used to view the order's receipt	[optional]
TotalDepositReturnFeeAmount	double?	This contains the total deposit return fee amount for the order.	[optional]

[Back to Model list] [Back to API list] [Back to README]