Flipdish

Welcome to the Flipdish developer hub. You'll find comprehensive guides and documentation to help you start working with Flipdish as quickly as possible, as well as support if you get stuck. Let's jump right in!

> POS integration quick start guide
> Driver dispatch integration quick start guide

If you need assistance, please email us at [email protected]

Properties

NameTypeDescription
StoreStoreSummaryStore summary
CustomerCustomerSummaryCustomer summary
VoucherVoucherSummaryVoucher summary
FeesFeeSummaryFee summary
OrderItemsOrderItem[]Ordered items
DeliveryLocationDeliveryLocationDelivery location for delivery orders
CustomerLocationCoordinatesCustomer location
OrderIdintegerOrder identifier
DeliveryTypestringDelivery type
PickupLocationTypestringPickup location type
TipAmountnumberTip amount
DeliveryAmountnumberDelivery amount
OrderItemsAmountnumberOrdered items amount
AmountnumberThis 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.
ProcessingFeenumberThis 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.
PaymentAccountTypestringPayment account type
PaymentAccountDescriptionstringPayment account description (like Visa ****2371 or Apple Pay. or Cash)
OrderStatestringOrder state
IsPreOrderbooleanIs pre-order
PlacedTimestringOrder placed time
RequestedForTimestringOrder requested for
ChefNotestringChef note
AppTypestringUsed app type
UserRatingintegerUser rating

Updated less than a minute ago

Order


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.