--- title: "GET /api/v1.0/{appId}/events/{eventId}" method: GET path: "/api/v1.0/{appId}/events/{eventId}" tags: ["Events"] --- # GET /api/v1.0/{appId}/events/{eventId} `GET /api/v1.0/{appId}/events/{eventId}` ## Path parameters - `eventId` string, uuid, required - `appId` string, required ## Response `200` OK - EventSearchResult - `AppCreatedEvent` AppCreatedEvent[] — App Created Event - `EventName` string — The event name - `Description` string — Description - `AppName` string — App Name - `CountryId` string — Country Id - `User` UserEventInfo — User Event Info - `UserId` integer — User Id - `UserName` string — User Name - `UserPhoneNumber` string — User Phone Number - `UserEmail` string — User Email - `AccountId` string — Salesforce Account Id - `OrgId` string — Organisation Id - `FlipdishEventId` string, uuid — The identitfier of the event - `CreateTime` string, date-time — The time of creation of the event - `Position` integer — Position - `AppId` string — App id - `IpAddress` string — Ip Address - `ActivityId` string — Activity Id - `ActivityType` string — Activity Type - `AppUpdatedEvent` AppUpdatedEvent[] — App Updated Event - `EventName` string — The event name - `Description` string — Description - `Changes` string — A summary of changes made - `AppName` string — App Name - `CountryId` string — Country Id - `User` UserEventInfo — User Event Info - `UserId` integer — User Id - `UserName` string — User Name - `UserPhoneNumber` string — User Phone Number - `UserEmail` string — User Email - `App` App — App - `AppId` string — App Identifier - `HasIosApp` boolean — Has iOS app in Apple App Store. This is readonly. - `IosAppStoreUrl` string — IOS App Store URL - `HasAndroidApp` boolean — Has Android app in Google Play Store. This is readonly. - `AndroidPlayStoreUrl` string — Android Play Store URL - `DisplayDeliveryRestaurantScreen` boolean — Display delivery restaurant screen - `LogoImageUrl` string — Application Logo. - `Languages` Language[] — Languages that have been selected to be available to customers. - `LanguageId` string — ISO 639-1 Language Code - `DisplayOrder` integer — Display Order - `Name` string — Language Name - `Enabled` boolean — Is the language enabled for use. - `AvailableAppLanguages` Language[] — Lists all languages that are supported by Flipdish. - `LanguageId` string — ISO 639-1 Language Code - `DisplayOrder` integer — Display Order - `Name` string — Language Name - `Enabled` boolean — Is the language enabled for use. - `AppAccessLevel` 'None' | 'Owner' | 'StoreOwner' | 'PropertyOwner' | 'ManagedOwner' | 'Integrator' | 'PropertyManager' | 'StoreManager' | 'StoreStaff' | 'StaffMember' | 'StoreReadOnlyAccess' | 'FinanceManger' | 'Onboarding' | 'Support' — App access level for the logged in user - `AppResourceSet` string[] — Constitutes a list of available resources - `Features` string[] — Feature flags. These cannot be set by 3rd parties. - `MapCenter` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `MapNorthEast` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `MapSouthWest` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `GoogleMapsApiKeyWeb` string — Key to be passed with Google Maps requests - `OrgId` string — Org Id - `SmsRestaurantName` string — SMS Restaurant Name - `WebToAppRedirect` 'NoRedirect' | 'RedirectOnce' | 'RedirectAlways' | 'SuggestPwa' | 'ForcePwa' — Web to App Redirect settings - `Name` string — App name. This is used in various places on the Apple App Store, Google Play Store, mobile apps and websites. - `HostName` string — HostName on which the web-ordering system is allowed to be hosted or that a Flipdish website is hosted on. - `MainColor` string — Main color of the web / Android / iOS applications - `KioskPrimaryColour` string — Primary colour used on the Kiosk - `ApplicationCategory` 'Restaurant' | 'Cafe' | 'Convenience' — Application Category - `IsPanaceaEnabled` boolean — Panacea is the term used for websites that are hosted on the my.flipdish.com domain. This value is true when the App's website is hosted on this domain. The alternative to using Panacea websites is to use a custom domain. - `PanaceaVanityUrl` string — In case of IsPanaceaEnabled is true, the app can be accessed via https://my.flipdish.com/{PanaceaVanityUrl} - `CookieConsentPromptEnabled` boolean — Cookie Consent Prompt Enabled - `CountryId` string — Country identifier in ISO 3166-1 alpha-2 format. This code is set automatically based on the locations of the Stores in the App. The App Country is used - to determine how to parse mobile phone numbers that are entered in their local numbering format - to determine if country specific payment methods should be offered - in various fraud checks - `OrgId` string — Organisation Id - `FlipdishEventId` string, uuid — The identitfier of the event - `CreateTime` string, date-time — The time of creation of the event - `Position` integer — Position - `AppId` string — App id - `IpAddress` string — Ip Address - `ActivityId` string — Activity Id - `ActivityType` string — Activity Type - `AnalyticsClientEvent` AnalyticsClientEvent[] — Client Analytics events - `EventName` string — The event name - `EventType` string — Type of the event - `AppType` string — Type of the app the event is coming from - `Metadata` string — JSON Metadata - `UserId` integer, nullable — User Id - `Latitude` number, double, nullable — Latitude of the event - `Longitude` number, double, nullable — Longitude of the event - `FlipdishEventId` string, uuid — The identitfier of the event - `CreateTime` string, date-time — The time of creation of the event - `Position` integer — Position - `AppId` string — App id - `OrgId` string — Org id - `IpAddress` string — Ip Address - `ActivityId` string — Activity Id - `ActivityType` string — Activity Type - `OrderAcceptedEvent` OrderAcceptedEvent[] — Order accepted events - `EventName` string — The event name - `OrgId` string — Organisation Id - `Description` string — Description - `OrderAcceptedTime` string, date-time — Order Accepted Time - `User` UserEventInfo — User Event Info - `UserId` integer — User Id - `UserName` string — User Name - `UserPhoneNumber` string — User Phone Number - `UserEmail` string — User Email - `Order` Order — Order - `Store` StoreSummary — Store summary - `Id` integer — Store identifier - `Name` string — Store name - `MenuId` integer — Stores menu identifier - `MenuPublishId` string, uuid — Stores menu publish GUID - `Metadata` object — Store metadata - `Currency` 'EUR' | 'USD' | 'GBP' | 'CAD' | 'AUD' | 'DJF' | 'ZAR' | 'ETB' | 'AED' | 'BHD' | 'DZD' | 'EGP' | 'IQD' | 'JOD' | 'KWD' | 'LBP' | 'LYD' | 'MAD' | 'OMR' | 'QAR' | 'SAR' | 'SYP' | 'TND' | 'YER' | 'CLP' | 'INR' | 'AZN' | 'RUB' | 'BYN' | 'BGN' | 'NGN' | 'BDT' | 'CNY' | 'BAM' | 'CZK' | 'DKK' | 'CHF' | 'MVR' | 'BTN' | 'XCD' | 'BZD' | 'HKD' | 'IDR' | 'JMD' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'TTD' | 'XDR' | 'ARS' | 'BOB' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PEN' | 'PYG' | 'UYU' | 'VEF' | 'IRR' | 'XOF' | 'CDF' | 'XAF' | 'HTG' | 'ILS' | 'HRK' | 'HUF' | 'AMD' | 'ISK' | 'JPY' | 'GEL' | 'KZT' | 'KHR' | 'KRW' | 'KGS' | 'LAK' | 'MKD' | 'MNT' | 'BND' | 'MMK' | 'NOK' | 'NPR' | 'PKR' | 'PLN' | 'AFN' | 'BRL' | 'MDL' | 'RON' | 'RWF' | 'SEK' | 'LKR' | 'SOS' | 'ALL' | 'RSD' | 'KES' | 'TJS' | 'THB' | 'ERN' | 'TMT' | 'BWP' | 'TRY' | 'UAH' | 'UZS' | 'VND' | 'MOP' | 'TWD' | 'BMD' — Currency which used by the Store - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `StoreTimezone` string — Timezone of store - `StoreIanaTimezone` string — IANA Timezone of store - `StoreGroupId` integer — Store group id of store - `TaxId` string — VAT number or generic Tax ID of the store - `PrettyAddress` string — Address of the store - `CountryCode` string — Country code of the store address (ISO 3166-1 alpha-2) - `PropertyId` string — Property identifier - `Customer` CustomerSummary — Customer summary - `Id` integer — Customer identifier - `Name` string — Customer name - `EmailAddress` string — Customer email address - `PhoneNumberLocalFormat` string — Customer local phone number - `PhoneNumber` string — Customer phone number - `LanguagePreference` string — Preferred language of the consumer - `Voucher` OrderVoucherSummary — Voucher summary - `VoucherId` integer — Voucher ID - `Name` string — Voucher name - `Description` string — Voucher description - `Code` string — Voucher code - `Amount` number, double — Voucher amount - `Type` 'PercentageDiscount' | 'LumpDiscount' | 'AddItem' | 'CreditNote' | 'FreeDelivery' — Voucher type - `SubType` 'None' | 'SignUp' | 'Loyalty' | 'Loyalty25' | 'Retention' | 'SecondaryRetention' | 'Custom' — Voucher sub type - `Fees` FeeSummary — Fee Summary - `FeeAmount` number, double — Fee amount - `PercentageRate` number, double — Percentage rate - `PerTransactionFee` number, double — Per transaction fee - `OrderItems` OrderItem[] — Ordered items - `OrderItemOptions` OrderItemOption[] — Option list - `Metadata` object — Metadata - `MenuItemOptionPublicId` string, uuid — Public id of the Menu Item Option - `MenuItemOptionId` integer — Menu item option identifier - `IsMasterOptionSetItem` boolean — Is master option set item - `Name` string — Name - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `MenuItemOptionDisplayOrder` integer — Menu item option display order - `MenuItemOptionSetDisplayOrder` integer — Menu item option set display order - `DepositReturnFee` number, double, nullable — Deposit return fee - `Metadata` object — Metadata - `MenuItemPublicId` string, uuid — Public id of the Menu Item - `MenuSectionName` string — Menu section name - `MenuSectionDisplayOrder` integer — Menu section display order - `Name` string — Name - `Description` string — Description - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `PriceIncludingOptionSetItems` number, double — Price including option set items - `MenuItemId` integer — Menu item identifier - `MenuItemDisplayOrder` integer — Menu item display order - `IsAvailable` boolean — Is available - `DepositReturnFee` number, double, nullable — Deposit return fee - `DeliveryLocation` DeliveryLocation — Delivery location - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `Building` string — Building - `Street` string — Street - `Town` string — Town - `PostCode` string — Post code - `DeliveryInstructions` string — Delivery instructions - `PrettyAddressString` string — Formatted, pretty address string - `CustomerLocation` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `MaskedPhoneNumber` MaskedPhoneNumber — Represents a masked phone number - `IsEnabled` boolean — Defines if the feature is enabled - `PhoneNumber` string — Defines the phone number to call - `Code` string — Defines the code to enter - `DropOffLocationId` integer, nullable — Represents table service drop off location - `DropOffLocation` string — Represents table service drop off location - `AcceptedFor` string, date-time, nullable — Time store has accepted the order for - `InFraudZone` boolean — Was order made within a fraud zone - `UnusualHighValueOrder` boolean — Is order of unusually high value - `RejectedByUserId` integer, nullable — Id of user who rejected order, if available - `ChannelOrderId` string — ChannelOrderId from external channel - `ChannelOrderDisplayId` string — ChannelOrderDisplayId from external channel - `Channel` Channel — Channel. - `ChannelId` integer — Channel Id - `TranslationKey` string — Channel TranslationKey - `Source` 'Internal' | 'External' — Channel Source - `LogoUri` string — Channel Logo URl - `Available` boolean — Channel is Available or not - `MaintainedExternally` boolean — Channel is Maintained Externally or not - `OrderDropOffLocation` OrderDropOffLocation — OrderDropOffLocation. - `OrderId` integer — OrderId. - `LocationName` string — LocationName. - `LocationAreaName` string — LocationAreaName. - `LocationId` integer — LocationId. - `LocationAreaId` integer — LocationAreaId. - `ExternalLocationId` string — ExternalLocationId. - `FulfillmentStatus` OrderFulfillmentStatusBase — Fulfillment Status Information - `StatusId` string — Fulfillment Status Id - `StatusName` string — Fulfillment Status Name - `Icon` string — Status Icon - `OrderBatchInfo` OrderBatchSummary — Order batch info - `Id` integer — Order batch id - `DisplayCode` string — Order batch 6-sign human readable code - `CreateTime` string, date-time — Batch creation date and time - `IsPublished` boolean — If the batch is already published - `TaxItems` TaxItem[] — A collection of tax items on the order. - `Name` string — The name of the tax item. - `Rate` number, double — The tax rate applied to the item. - `Amount` number, double — The amount of tax applied to the item. - `CreatedCampaignVoucherId` integer, nullable — The id of the campaign voucher that was created from this order - `OrderId` integer — Order identifier - `LocalOrderId` string — Local order Id. This is used for displaying a "shorter" order ID for customers (eg. Kiosk orders) - `DeliveryType` 'Delivery' | 'Pickup' — Delivery type - `PickupLocationType` 'TakeOut' | 'TableService' | 'DineIn' — Pickup location type - `TableServiceCatagory` 'Generic' | 'Villa' | 'House' | 'Room' | 'Area' | 'Table' | 'ParkingBay' | 'Gate' | 'DriveThrough' | 'Team', nullable — Pickup location type - `TipAmount` number, double — Tip amount - `DeliveryAmount` number, double — Delivery amount - `OrderItemsAmount` number, double — Ordered items amount - `ServiceChargeAmount` number, double — Service Charge Amount - `ServiceChargePercentage` number, double — Service Charge Percentage - `Amount` number, 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. - `ProcessingFee` number, 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. - `PaymentAccountType` 'Card' | 'Cash' | 'Ideal' | 'Bancontact' | 'Giropay' | 'Eps' | 'Emv' | 'PayPal' | 'PayGreen' | 'GoogleWalletToken' — Payment account type - `PaymentAccountDescription` string — Payment account description (like Visa ****2371 or Apple Pay. or Cash) - `OrderState` 'Created' | 'PlacedCanBeCancelled' | 'ReadyToProcess' | 'AcceptedByRestaurant' | 'Dispatched' | 'Delivered' | 'Cancelled' | 'ManualReview' | 'RejectedByStore' | 'RejectedByFlipdish' | 'RejectedAutomatically' | 'RejectedAfterBeingAccepted' | 'AcceptedAndRefunded' | 'PendingPayment' — Order state - `IsPreOrder` boolean — Is pre-order - `PlacedTime` string, date-time — Order placed time - `RequestedForTime` string, date-time — Order requested for - `ChefNote` string — Chef note - `AppType` 'Unknown' | 'Ios' | 'Android' | 'Web' | 'Kiosk' | 'Pos' | 'TelephoneCall' | 'Sms' | 'PwaAndroid' | 'PwaIos' | 'Google' — Used app type - `UserRating` integer, nullable — User rating - `PaymentStatus` 'Paid' | 'Unpaid' | 'Refunded' | 'PartiallyRefunded' | 'Disputed' — Status of the payment - `RejectionReason` 'TooBusy' | 'FoodUnavailable' | 'UnableToDeliver' | 'UnknownAddress' | 'UnknownReason' | 'TooSoon' | 'TimeUnavailable' | 'DontDeliverToArea' | 'StoreUncontactable', nullable — Rejection reason. Can have value if the order is rejected. - `RefundedAmount` number, double, nullable — Amount refunded to customer. - `DeliveryTrackingStatus` 'Unassigned' | 'Unaccepted' | 'Accepted' | 'Carrying' | 'OnTheWay' | 'ArrivedAtLocation' | 'Delivered' | 'CannotDeliver', nullable — Delivery tracking status - `DriverId` integer, nullable — Assigned driver identifier - `TotalTax` number, double — Total tax applied to order - `OrderTrackingCode` string — Unique, 6 character long alpha numeric code for tracking. - `DeliveryFeeAreaId` integer, nullable — Delivery area identifier - `ReceiptCode` string — Code used to view the order's receipt - `TotalDepositReturnFeeAmount` number, double — This contains the total deposit return fee amount for the order. - `FlipdishEventId` string, uuid — The identitfier of the event - `CreateTime` string, date-time — The time of creation of the event - `Position` integer — Position - `AppId` string — App id - `IpAddress` string — Ip Address - `ActivityId` string — Activity Id - `ActivityType` string — Activity Type - `OrderDispatchedEvent` OrderDispatchedEvent[] — Order dispatched events - `EventName` string — The event name - `Description` string — Description - `OrderDispatchedTime` string, date-time — Order Rejected Time - `Order` Order — Order - `Store` StoreSummary — Store summary - `Id` integer — Store identifier - `Name` string — Store name - `MenuId` integer — Stores menu identifier - `MenuPublishId` string, uuid — Stores menu publish GUID - `Metadata` object — Store metadata - `Currency` 'EUR' | 'USD' | 'GBP' | 'CAD' | 'AUD' | 'DJF' | 'ZAR' | 'ETB' | 'AED' | 'BHD' | 'DZD' | 'EGP' | 'IQD' | 'JOD' | 'KWD' | 'LBP' | 'LYD' | 'MAD' | 'OMR' | 'QAR' | 'SAR' | 'SYP' | 'TND' | 'YER' | 'CLP' | 'INR' | 'AZN' | 'RUB' | 'BYN' | 'BGN' | 'NGN' | 'BDT' | 'CNY' | 'BAM' | 'CZK' | 'DKK' | 'CHF' | 'MVR' | 'BTN' | 'XCD' | 'BZD' | 'HKD' | 'IDR' | 'JMD' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'TTD' | 'XDR' | 'ARS' | 'BOB' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PEN' | 'PYG' | 'UYU' | 'VEF' | 'IRR' | 'XOF' | 'CDF' | 'XAF' | 'HTG' | 'ILS' | 'HRK' | 'HUF' | 'AMD' | 'ISK' | 'JPY' | 'GEL' | 'KZT' | 'KHR' | 'KRW' | 'KGS' | 'LAK' | 'MKD' | 'MNT' | 'BND' | 'MMK' | 'NOK' | 'NPR' | 'PKR' | 'PLN' | 'AFN' | 'BRL' | 'MDL' | 'RON' | 'RWF' | 'SEK' | 'LKR' | 'SOS' | 'ALL' | 'RSD' | 'KES' | 'TJS' | 'THB' | 'ERN' | 'TMT' | 'BWP' | 'TRY' | 'UAH' | 'UZS' | 'VND' | 'MOP' | 'TWD' | 'BMD' — Currency which used by the Store - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `StoreTimezone` string — Timezone of store - `StoreIanaTimezone` string — IANA Timezone of store - `StoreGroupId` integer — Store group id of store - `TaxId` string — VAT number or generic Tax ID of the store - `PrettyAddress` string — Address of the store - `CountryCode` string — Country code of the store address (ISO 3166-1 alpha-2) - `PropertyId` string — Property identifier - `Customer` CustomerSummary — Customer summary - `Id` integer — Customer identifier - `Name` string — Customer name - `EmailAddress` string — Customer email address - `PhoneNumberLocalFormat` string — Customer local phone number - `PhoneNumber` string — Customer phone number - `LanguagePreference` string — Preferred language of the consumer - `Voucher` OrderVoucherSummary — Voucher summary - `VoucherId` integer — Voucher ID - `Name` string — Voucher name - `Description` string — Voucher description - `Code` string — Voucher code - `Amount` number, double — Voucher amount - `Type` 'PercentageDiscount' | 'LumpDiscount' | 'AddItem' | 'CreditNote' | 'FreeDelivery' — Voucher type - `SubType` 'None' | 'SignUp' | 'Loyalty' | 'Loyalty25' | 'Retention' | 'SecondaryRetention' | 'Custom' — Voucher sub type - `Fees` FeeSummary — Fee Summary - `FeeAmount` number, double — Fee amount - `PercentageRate` number, double — Percentage rate - `PerTransactionFee` number, double — Per transaction fee - `OrderItems` OrderItem[] — Ordered items - `OrderItemOptions` OrderItemOption[] — Option list - `Metadata` object — Metadata - `MenuItemOptionPublicId` string, uuid — Public id of the Menu Item Option - `MenuItemOptionId` integer — Menu item option identifier - `IsMasterOptionSetItem` boolean — Is master option set item - `Name` string — Name - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `MenuItemOptionDisplayOrder` integer — Menu item option display order - `MenuItemOptionSetDisplayOrder` integer — Menu item option set display order - `DepositReturnFee` number, double, nullable — Deposit return fee - `Metadata` object — Metadata - `MenuItemPublicId` string, uuid — Public id of the Menu Item - `MenuSectionName` string — Menu section name - `MenuSectionDisplayOrder` integer — Menu section display order - `Name` string — Name - `Description` string — Description - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `PriceIncludingOptionSetItems` number, double — Price including option set items - `MenuItemId` integer — Menu item identifier - `MenuItemDisplayOrder` integer — Menu item display order - `IsAvailable` boolean — Is available - `DepositReturnFee` number, double, nullable — Deposit return fee - `DeliveryLocation` DeliveryLocation — Delivery location - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `Building` string — Building - `Street` string — Street - `Town` string — Town - `PostCode` string — Post code - `DeliveryInstructions` string — Delivery instructions - `PrettyAddressString` string — Formatted, pretty address string - `CustomerLocation` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `MaskedPhoneNumber` MaskedPhoneNumber — Represents a masked phone number - `IsEnabled` boolean — Defines if the feature is enabled - `PhoneNumber` string — Defines the phone number to call - `Code` string — Defines the code to enter - `DropOffLocationId` integer, nullable — Represents table service drop off location - `DropOffLocation` string — Represents table service drop off location - `AcceptedFor` string, date-time, nullable — Time store has accepted the order for - `InFraudZone` boolean — Was order made within a fraud zone - `UnusualHighValueOrder` boolean — Is order of unusually high value - `RejectedByUserId` integer, nullable — Id of user who rejected order, if available - `ChannelOrderId` string — ChannelOrderId from external channel - `ChannelOrderDisplayId` string — ChannelOrderDisplayId from external channel - `Channel` Channel — Channel. - `ChannelId` integer — Channel Id - `TranslationKey` string — Channel TranslationKey - `Source` 'Internal' | 'External' — Channel Source - `LogoUri` string — Channel Logo URl - `Available` boolean — Channel is Available or not - `MaintainedExternally` boolean — Channel is Maintained Externally or not - `OrderDropOffLocation` OrderDropOffLocation — OrderDropOffLocation. - `OrderId` integer — OrderId. - `LocationName` string — LocationName. - `LocationAreaName` string — LocationAreaName. - `LocationId` integer — LocationId. - `LocationAreaId` integer — LocationAreaId. - `ExternalLocationId` string — ExternalLocationId. - `FulfillmentStatus` OrderFulfillmentStatusBase — Fulfillment Status Information - `StatusId` string — Fulfillment Status Id - `StatusName` string — Fulfillment Status Name - `Icon` string — Status Icon - `OrderBatchInfo` OrderBatchSummary — Order batch info - `Id` integer — Order batch id - `DisplayCode` string — Order batch 6-sign human readable code - `CreateTime` string, date-time — Batch creation date and time - `IsPublished` boolean — If the batch is already published - `TaxItems` TaxItem[] — A collection of tax items on the order. - `Name` string — The name of the tax item. - `Rate` number, double — The tax rate applied to the item. - `Amount` number, double — The amount of tax applied to the item. - `CreatedCampaignVoucherId` integer, nullable — The id of the campaign voucher that was created from this order - `OrderId` integer — Order identifier - `LocalOrderId` string — Local order Id. This is used for displaying a "shorter" order ID for customers (eg. Kiosk orders) - `DeliveryType` 'Delivery' | 'Pickup' — Delivery type - `PickupLocationType` 'TakeOut' | 'TableService' | 'DineIn' — Pickup location type - `TableServiceCatagory` 'Generic' | 'Villa' | 'House' | 'Room' | 'Area' | 'Table' | 'ParkingBay' | 'Gate' | 'DriveThrough' | 'Team', nullable — Pickup location type - `TipAmount` number, double — Tip amount - `DeliveryAmount` number, double — Delivery amount - `OrderItemsAmount` number, double — Ordered items amount - `ServiceChargeAmount` number, double — Service Charge Amount - `ServiceChargePercentage` number, double — Service Charge Percentage - `Amount` number, 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. - `ProcessingFee` number, 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. - `PaymentAccountType` 'Card' | 'Cash' | 'Ideal' | 'Bancontact' | 'Giropay' | 'Eps' | 'Emv' | 'PayPal' | 'PayGreen' | 'GoogleWalletToken' — Payment account type - `PaymentAccountDescription` string — Payment account description (like Visa ****2371 or Apple Pay. or Cash) - `OrderState` 'Created' | 'PlacedCanBeCancelled' | 'ReadyToProcess' | 'AcceptedByRestaurant' | 'Dispatched' | 'Delivered' | 'Cancelled' | 'ManualReview' | 'RejectedByStore' | 'RejectedByFlipdish' | 'RejectedAutomatically' | 'RejectedAfterBeingAccepted' | 'AcceptedAndRefunded' | 'PendingPayment' — Order state - `IsPreOrder` boolean — Is pre-order - `PlacedTime` string, date-time — Order placed time - `RequestedForTime` string, date-time — Order requested for - `ChefNote` string — Chef note - `AppType` 'Unknown' | 'Ios' | 'Android' | 'Web' | 'Kiosk' | 'Pos' | 'TelephoneCall' | 'Sms' | 'PwaAndroid' | 'PwaIos' | 'Google' — Used app type - `UserRating` integer, nullable — User rating - `PaymentStatus` 'Paid' | 'Unpaid' | 'Refunded' | 'PartiallyRefunded' | 'Disputed' — Status of the payment - `RejectionReason` 'TooBusy' | 'FoodUnavailable' | 'UnableToDeliver' | 'UnknownAddress' | 'UnknownReason' | 'TooSoon' | 'TimeUnavailable' | 'DontDeliverToArea' | 'StoreUncontactable', nullable — Rejection reason. Can have value if the order is rejected. - `RefundedAmount` number, double, nullable — Amount refunded to customer. - `DeliveryTrackingStatus` 'Unassigned' | 'Unaccepted' | 'Accepted' | 'Carrying' | 'OnTheWay' | 'ArrivedAtLocation' | 'Delivered' | 'CannotDeliver', nullable — Delivery tracking status - `DriverId` integer, nullable — Assigned driver identifier - `TotalTax` number, double — Total tax applied to order - `OrderTrackingCode` string — Unique, 6 character long alpha numeric code for tracking. - `DeliveryFeeAreaId` integer, nullable — Delivery area identifier - `ReceiptCode` string — Code used to view the order's receipt - `TotalDepositReturnFeeAmount` number, double — This contains the total deposit return fee amount for the order. - `FlipdishEventId` string, uuid — The identitfier of the event - `CreateTime` string, date-time — The time of creation of the event - `Position` integer — Position - `AppId` string — App id - `OrgId` string — Org id - `IpAddress` string — Ip Address - `ActivityId` string — Activity Id - `ActivityType` string — Activity Type - `OrderCustomerTrackingCreatedEvent` OrderCustomerTrackingCreatedEvent[] — Order delivery tracking created events - `EventName` string — The event name - `Description` string — Description - `Order` CustomerDeliveryTrackingOrder — Defines the order data required for customer driver tracking - `OrderId` integer — Order Id - `Address` string — Pretified address string in country format - `DeliveryNotes` string — Delivery Notes - `StorePhoneNumber` string — Phone number of the store - `AppIconUrl` string — App Icon of the store - `OrderTrackingCode` string — Order Tracking Code - `PaymentMethodDescription` string — Payment method description i.e Cash/Card/iDeal/Paypal - `LastFourDigits` string — Last 4 digits of the card if applicable otherwise null - `OrderLines` CustomerDeliveryTrackingOrderLine[] — Order lines of the order - `ItemName` string — Item name from the order - `SelectedOptions` string[] — Selected option names - `TotalAmount` number, double — Total amount for the order including tax - `Currency` 'EUR' | 'USD' | 'GBP' | 'CAD' | 'AUD' | 'DJF' | 'ZAR' | 'ETB' | 'AED' | 'BHD' | 'DZD' | 'EGP' | 'IQD' | 'JOD' | 'KWD' | 'LBP' | 'LYD' | 'MAD' | 'OMR' | 'QAR' | 'SAR' | 'SYP' | 'TND' | 'YER' | 'CLP' | 'INR' | 'AZN' | 'RUB' | 'BYN' | 'BGN' | 'NGN' | 'BDT' | 'CNY' | 'BAM' | 'CZK' | 'DKK' | 'CHF' | 'MVR' | 'BTN' | 'XCD' | 'BZD' | 'HKD' | 'IDR' | 'JMD' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'TTD' | 'XDR' | 'ARS' | 'BOB' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PEN' | 'PYG' | 'UYU' | 'VEF' | 'IRR' | 'XOF' | 'CDF' | 'XAF' | 'HTG' | 'ILS' | 'HRK' | 'HUF' | 'AMD' | 'ISK' | 'JPY' | 'GEL' | 'KZT' | 'KHR' | 'KRW' | 'KGS' | 'LAK' | 'MKD' | 'MNT' | 'BND' | 'MMK' | 'NOK' | 'NPR' | 'PKR' | 'PLN' | 'AFN' | 'BRL' | 'MDL' | 'RON' | 'RWF' | 'SEK' | 'LKR' | 'SOS' | 'ALL' | 'RSD' | 'KES' | 'TJS' | 'THB' | 'ERN' | 'TMT' | 'BWP' | 'TRY' | 'UAH' | 'UZS' | 'VND' | 'MOP' | 'TWD' | 'BMD' — Currency - `Latitude` number, double — Customer Location Latitude - `Longitude` number, double — Customer Location Longitude - `Placed` string, date-time — Order placed time - `RequestedFor` string, date-time — Order requested for - `DriverId` integer, nullable — Driver Id - `DriverName` string — Driver Name - `DriverImage` string — Driver Image - `EstimatedMinutesForDelivery` integer - `FlipdishEventId` string, uuid — The identitfier of the event - `CreateTime` string, date-time — The time of creation of the event - `Position` integer — Position - `AppId` string — App id - `OrgId` string — Org id - `IpAddress` string — Ip Address - `ActivityId` string — Activity Id - `ActivityType` string — Activity Type - `OrderDeliveryTrackingStatusUpdatedEvent` OrderDeliveryTrackingStatusUpdatedEvent[] — Order delivery tracking updated events - `EventName` string — The event name - `Description` string — Description - `Order` Order — Order - `Store` StoreSummary — Store summary - `Id` integer — Store identifier - `Name` string — Store name - `MenuId` integer — Stores menu identifier - `MenuPublishId` string, uuid — Stores menu publish GUID - `Metadata` object — Store metadata - `Currency` 'EUR' | 'USD' | 'GBP' | 'CAD' | 'AUD' | 'DJF' | 'ZAR' | 'ETB' | 'AED' | 'BHD' | 'DZD' | 'EGP' | 'IQD' | 'JOD' | 'KWD' | 'LBP' | 'LYD' | 'MAD' | 'OMR' | 'QAR' | 'SAR' | 'SYP' | 'TND' | 'YER' | 'CLP' | 'INR' | 'AZN' | 'RUB' | 'BYN' | 'BGN' | 'NGN' | 'BDT' | 'CNY' | 'BAM' | 'CZK' | 'DKK' | 'CHF' | 'MVR' | 'BTN' | 'XCD' | 'BZD' | 'HKD' | 'IDR' | 'JMD' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'TTD' | 'XDR' | 'ARS' | 'BOB' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PEN' | 'PYG' | 'UYU' | 'VEF' | 'IRR' | 'XOF' | 'CDF' | 'XAF' | 'HTG' | 'ILS' | 'HRK' | 'HUF' | 'AMD' | 'ISK' | 'JPY' | 'GEL' | 'KZT' | 'KHR' | 'KRW' | 'KGS' | 'LAK' | 'MKD' | 'MNT' | 'BND' | 'MMK' | 'NOK' | 'NPR' | 'PKR' | 'PLN' | 'AFN' | 'BRL' | 'MDL' | 'RON' | 'RWF' | 'SEK' | 'LKR' | 'SOS' | 'ALL' | 'RSD' | 'KES' | 'TJS' | 'THB' | 'ERN' | 'TMT' | 'BWP' | 'TRY' | 'UAH' | 'UZS' | 'VND' | 'MOP' | 'TWD' | 'BMD' — Currency which used by the Store - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `StoreTimezone` string — Timezone of store - `StoreIanaTimezone` string — IANA Timezone of store - `StoreGroupId` integer — Store group id of store - `TaxId` string — VAT number or generic Tax ID of the store - `PrettyAddress` string — Address of the store - `CountryCode` string — Country code of the store address (ISO 3166-1 alpha-2) - `PropertyId` string — Property identifier - `Customer` CustomerSummary — Customer summary - `Id` integer — Customer identifier - `Name` string — Customer name - `EmailAddress` string — Customer email address - `PhoneNumberLocalFormat` string — Customer local phone number - `PhoneNumber` string — Customer phone number - `LanguagePreference` string — Preferred language of the consumer - `Voucher` OrderVoucherSummary — Voucher summary - `VoucherId` integer — Voucher ID - `Name` string — Voucher name - `Description` string — Voucher description - `Code` string — Voucher code - `Amount` number, double — Voucher amount - `Type` 'PercentageDiscount' | 'LumpDiscount' | 'AddItem' | 'CreditNote' | 'FreeDelivery' — Voucher type - `SubType` 'None' | 'SignUp' | 'Loyalty' | 'Loyalty25' | 'Retention' | 'SecondaryRetention' | 'Custom' — Voucher sub type - `Fees` FeeSummary — Fee Summary - `FeeAmount` number, double — Fee amount - `PercentageRate` number, double — Percentage rate - `PerTransactionFee` number, double — Per transaction fee - `OrderItems` OrderItem[] — Ordered items - `OrderItemOptions` OrderItemOption[] — Option list - `Metadata` object — Metadata - `MenuItemOptionPublicId` string, uuid — Public id of the Menu Item Option - `MenuItemOptionId` integer — Menu item option identifier - `IsMasterOptionSetItem` boolean — Is master option set item - `Name` string — Name - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `MenuItemOptionDisplayOrder` integer — Menu item option display order - `MenuItemOptionSetDisplayOrder` integer — Menu item option set display order - `DepositReturnFee` number, double, nullable — Deposit return fee - `Metadata` object — Metadata - `MenuItemPublicId` string, uuid — Public id of the Menu Item - `MenuSectionName` string — Menu section name - `MenuSectionDisplayOrder` integer — Menu section display order - `Name` string — Name - `Description` string — Description - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `PriceIncludingOptionSetItems` number, double — Price including option set items - `MenuItemId` integer — Menu item identifier - `MenuItemDisplayOrder` integer — Menu item display order - `IsAvailable` boolean — Is available - `DepositReturnFee` number, double, nullable — Deposit return fee - `DeliveryLocation` DeliveryLocation — Delivery location - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `Building` string — Building - `Street` string — Street - `Town` string — Town - `PostCode` string — Post code - `DeliveryInstructions` string — Delivery instructions - `PrettyAddressString` string — Formatted, pretty address string - `CustomerLocation` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `MaskedPhoneNumber` MaskedPhoneNumber — Represents a masked phone number - `IsEnabled` boolean — Defines if the feature is enabled - `PhoneNumber` string — Defines the phone number to call - `Code` string — Defines the code to enter - `DropOffLocationId` integer, nullable — Represents table service drop off location - `DropOffLocation` string — Represents table service drop off location - `AcceptedFor` string, date-time, nullable — Time store has accepted the order for - `InFraudZone` boolean — Was order made within a fraud zone - `UnusualHighValueOrder` boolean — Is order of unusually high value - `RejectedByUserId` integer, nullable — Id of user who rejected order, if available - `ChannelOrderId` string — ChannelOrderId from external channel - `ChannelOrderDisplayId` string — ChannelOrderDisplayId from external channel - `Channel` Channel — Channel. - `ChannelId` integer — Channel Id - `TranslationKey` string — Channel TranslationKey - `Source` 'Internal' | 'External' — Channel Source - `LogoUri` string — Channel Logo URl - `Available` boolean — Channel is Available or not - `MaintainedExternally` boolean — Channel is Maintained Externally or not - `OrderDropOffLocation` OrderDropOffLocation — OrderDropOffLocation. - `OrderId` integer — OrderId. - `LocationName` string — LocationName. - `LocationAreaName` string — LocationAreaName. - `LocationId` integer — LocationId. - `LocationAreaId` integer — LocationAreaId. - `ExternalLocationId` string — ExternalLocationId. - `FulfillmentStatus` OrderFulfillmentStatusBase — Fulfillment Status Information - `StatusId` string — Fulfillment Status Id - `StatusName` string — Fulfillment Status Name - `Icon` string — Status Icon - `OrderBatchInfo` OrderBatchSummary — Order batch info - `Id` integer — Order batch id - `DisplayCode` string — Order batch 6-sign human readable code - `CreateTime` string, date-time — Batch creation date and time - `IsPublished` boolean — If the batch is already published - `TaxItems` TaxItem[] — A collection of tax items on the order. - `Name` string — The name of the tax item. - `Rate` number, double — The tax rate applied to the item. - `Amount` number, double — The amount of tax applied to the item. - `CreatedCampaignVoucherId` integer, nullable — The id of the campaign voucher that was created from this order - `OrderId` integer — Order identifier - `LocalOrderId` string — Local order Id. This is used for displaying a "shorter" order ID for customers (eg. Kiosk orders) - `DeliveryType` 'Delivery' | 'Pickup' — Delivery type - `PickupLocationType` 'TakeOut' | 'TableService' | 'DineIn' — Pickup location type - `TableServiceCatagory` 'Generic' | 'Villa' | 'House' | 'Room' | 'Area' | 'Table' | 'ParkingBay' | 'Gate' | 'DriveThrough' | 'Team', nullable — Pickup location type - `TipAmount` number, double — Tip amount - `DeliveryAmount` number, double — Delivery amount - `OrderItemsAmount` number, double — Ordered items amount - `ServiceChargeAmount` number, double — Service Charge Amount - `ServiceChargePercentage` number, double — Service Charge Percentage - `Amount` number, 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. - `ProcessingFee` number, 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. - `PaymentAccountType` 'Card' | 'Cash' | 'Ideal' | 'Bancontact' | 'Giropay' | 'Eps' | 'Emv' | 'PayPal' | 'PayGreen' | 'GoogleWalletToken' — Payment account type - `PaymentAccountDescription` string — Payment account description (like Visa ****2371 or Apple Pay. or Cash) - `OrderState` 'Created' | 'PlacedCanBeCancelled' | 'ReadyToProcess' | 'AcceptedByRestaurant' | 'Dispatched' | 'Delivered' | 'Cancelled' | 'ManualReview' | 'RejectedByStore' | 'RejectedByFlipdish' | 'RejectedAutomatically' | 'RejectedAfterBeingAccepted' | 'AcceptedAndRefunded' | 'PendingPayment' — Order state - `IsPreOrder` boolean — Is pre-order - `PlacedTime` string, date-time — Order placed time - `RequestedForTime` string, date-time — Order requested for - `ChefNote` string — Chef note - `AppType` 'Unknown' | 'Ios' | 'Android' | 'Web' | 'Kiosk' | 'Pos' | 'TelephoneCall' | 'Sms' | 'PwaAndroid' | 'PwaIos' | 'Google' — Used app type - `UserRating` integer, nullable — User rating - `PaymentStatus` 'Paid' | 'Unpaid' | 'Refunded' | 'PartiallyRefunded' | 'Disputed' — Status of the payment - `RejectionReason` 'TooBusy' | 'FoodUnavailable' | 'UnableToDeliver' | 'UnknownAddress' | 'UnknownReason' | 'TooSoon' | 'TimeUnavailable' | 'DontDeliverToArea' | 'StoreUncontactable', nullable — Rejection reason. Can have value if the order is rejected. - `RefundedAmount` number, double, nullable — Amount refunded to customer. - `DeliveryTrackingStatus` 'Unassigned' | 'Unaccepted' | 'Accepted' | 'Carrying' | 'OnTheWay' | 'ArrivedAtLocation' | 'Delivered' | 'CannotDeliver', nullable — Delivery tracking status - `DriverId` integer, nullable — Assigned driver identifier - `TotalTax` number, double — Total tax applied to order - `OrderTrackingCode` string — Unique, 6 character long alpha numeric code for tracking. - `DeliveryFeeAreaId` integer, nullable — Delivery area identifier - `ReceiptCode` string — Code used to view the order's receipt - `TotalDepositReturnFeeAmount` number, double — This contains the total deposit return fee amount for the order. - `DeliveryIntegrationName` string — Delivery integration name - `DeliveryErrorMessage` string — Delivery error message (optional) - `FlipdishEventId` string, uuid — The identitfier of the event - `CreateTime` string, date-time — The time of creation of the event - `Position` integer — Position - `AppId` string — App id - `OrgId` string — Org id - `IpAddress` string — Ip Address - `ActivityId` string — Activity Id - `ActivityType` string — Activity Type - `OrderBatchPublishedEvent` OrderBatchPublishedEvent[] — Order Batch published event - `EventName` string — The event name - `OrderBatchId` integer — Order Batch Id - `StoreId` integer — Store id the order batch belogs to - `OrderIds` integer[] — Orders' ids on the batch - `FlipdishEventId` string, uuid — The identitfier of the event - `CreateTime` string, date-time — The time of creation of the event - `Position` integer — Position - `AppId` string — App id - `OrgId` string — Org id - `IpAddress` string — Ip Address - `ActivityId` string — Activity Id - `ActivityType` string — Activity Type - `OrderCreatedEvent` OrderCreatedEvent[] — Order created events - `EventName` string — The event name - `Description` string — Description - `OrderCreatedTime` string, date-time — Order Created Time - `Order` Order — Order - `Store` StoreSummary — Store summary - `Id` integer — Store identifier - `Name` string — Store name - `MenuId` integer — Stores menu identifier - `MenuPublishId` string, uuid — Stores menu publish GUID - `Metadata` object — Store metadata - `Currency` 'EUR' | 'USD' | 'GBP' | 'CAD' | 'AUD' | 'DJF' | 'ZAR' | 'ETB' | 'AED' | 'BHD' | 'DZD' | 'EGP' | 'IQD' | 'JOD' | 'KWD' | 'LBP' | 'LYD' | 'MAD' | 'OMR' | 'QAR' | 'SAR' | 'SYP' | 'TND' | 'YER' | 'CLP' | 'INR' | 'AZN' | 'RUB' | 'BYN' | 'BGN' | 'NGN' | 'BDT' | 'CNY' | 'BAM' | 'CZK' | 'DKK' | 'CHF' | 'MVR' | 'BTN' | 'XCD' | 'BZD' | 'HKD' | 'IDR' | 'JMD' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'TTD' | 'XDR' | 'ARS' | 'BOB' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PEN' | 'PYG' | 'UYU' | 'VEF' | 'IRR' | 'XOF' | 'CDF' | 'XAF' | 'HTG' | 'ILS' | 'HRK' | 'HUF' | 'AMD' | 'ISK' | 'JPY' | 'GEL' | 'KZT' | 'KHR' | 'KRW' | 'KGS' | 'LAK' | 'MKD' | 'MNT' | 'BND' | 'MMK' | 'NOK' | 'NPR' | 'PKR' | 'PLN' | 'AFN' | 'BRL' | 'MDL' | 'RON' | 'RWF' | 'SEK' | 'LKR' | 'SOS' | 'ALL' | 'RSD' | 'KES' | 'TJS' | 'THB' | 'ERN' | 'TMT' | 'BWP' | 'TRY' | 'UAH' | 'UZS' | 'VND' | 'MOP' | 'TWD' | 'BMD' — Currency which used by the Store - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `StoreTimezone` string — Timezone of store - `StoreIanaTimezone` string — IANA Timezone of store - `StoreGroupId` integer — Store group id of store - `TaxId` string — VAT number or generic Tax ID of the store - `PrettyAddress` string — Address of the store - `CountryCode` string — Country code of the store address (ISO 3166-1 alpha-2) - `PropertyId` string — Property identifier - `Customer` CustomerSummary — Customer summary - `Id` integer — Customer identifier - `Name` string — Customer name - `EmailAddress` string — Customer email address - `PhoneNumberLocalFormat` string — Customer local phone number - `PhoneNumber` string — Customer phone number - `LanguagePreference` string — Preferred language of the consumer - `Voucher` OrderVoucherSummary — Voucher summary - `VoucherId` integer — Voucher ID - `Name` string — Voucher name - `Description` string — Voucher description - `Code` string — Voucher code - `Amount` number, double — Voucher amount - `Type` 'PercentageDiscount' | 'LumpDiscount' | 'AddItem' | 'CreditNote' | 'FreeDelivery' — Voucher type - `SubType` 'None' | 'SignUp' | 'Loyalty' | 'Loyalty25' | 'Retention' | 'SecondaryRetention' | 'Custom' — Voucher sub type - `Fees` FeeSummary — Fee Summary - `FeeAmount` number, double — Fee amount - `PercentageRate` number, double — Percentage rate - `PerTransactionFee` number, double — Per transaction fee - `OrderItems` OrderItem[] — Ordered items - `OrderItemOptions` OrderItemOption[] — Option list - `Metadata` object — Metadata - `MenuItemOptionPublicId` string, uuid — Public id of the Menu Item Option - `MenuItemOptionId` integer — Menu item option identifier - `IsMasterOptionSetItem` boolean — Is master option set item - `Name` string — Name - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `MenuItemOptionDisplayOrder` integer — Menu item option display order - `MenuItemOptionSetDisplayOrder` integer — Menu item option set display order - `DepositReturnFee` number, double, nullable — Deposit return fee - `Metadata` object — Metadata - `MenuItemPublicId` string, uuid — Public id of the Menu Item - `MenuSectionName` string — Menu section name - `MenuSectionDisplayOrder` integer — Menu section display order - `Name` string — Name - `Description` string — Description - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `PriceIncludingOptionSetItems` number, double — Price including option set items - `MenuItemId` integer — Menu item identifier - `MenuItemDisplayOrder` integer — Menu item display order - `IsAvailable` boolean — Is available - `DepositReturnFee` number, double, nullable — Deposit return fee - `DeliveryLocation` DeliveryLocation — Delivery location - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `Building` string — Building - `Street` string — Street - `Town` string — Town - `PostCode` string — Post code - `DeliveryInstructions` string — Delivery instructions - `PrettyAddressString` string — Formatted, pretty address string - `CustomerLocation` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `MaskedPhoneNumber` MaskedPhoneNumber — Represents a masked phone number - `IsEnabled` boolean — Defines if the feature is enabled - `PhoneNumber` string — Defines the phone number to call - `Code` string — Defines the code to enter - `DropOffLocationId` integer, nullable — Represents table service drop off location - `DropOffLocation` string — Represents table service drop off location - `AcceptedFor` string, date-time, nullable — Time store has accepted the order for - `InFraudZone` boolean — Was order made within a fraud zone - `UnusualHighValueOrder` boolean — Is order of unusually high value - `RejectedByUserId` integer, nullable — Id of user who rejected order, if available - `ChannelOrderId` string — ChannelOrderId from external channel - `ChannelOrderDisplayId` string — ChannelOrderDisplayId from external channel - `Channel` Channel — Channel. - `ChannelId` integer — Channel Id - `TranslationKey` string — Channel TranslationKey - `Source` 'Internal' | 'External' — Channel Source - `LogoUri` string — Channel Logo URl - `Available` boolean — Channel is Available or not - `MaintainedExternally` boolean — Channel is Maintained Externally or not - `OrderDropOffLocation` OrderDropOffLocation — OrderDropOffLocation. - `OrderId` integer — OrderId. - `LocationName` string — LocationName. - `LocationAreaName` string — LocationAreaName. - `LocationId` integer — LocationId. - `LocationAreaId` integer — LocationAreaId. - `ExternalLocationId` string — ExternalLocationId. - `FulfillmentStatus` OrderFulfillmentStatusBase — Fulfillment Status Information - `StatusId` string — Fulfillment Status Id - `StatusName` string — Fulfillment Status Name - `Icon` string — Status Icon - `OrderBatchInfo` OrderBatchSummary — Order batch info - `Id` integer — Order batch id - `DisplayCode` string — Order batch 6-sign human readable code - `CreateTime` string, date-time — Batch creation date and time - `IsPublished` boolean — If the batch is already published - `TaxItems` TaxItem[] — A collection of tax items on the order. - `Name` string — The name of the tax item. - `Rate` number, double — The tax rate applied to the item. - `Amount` number, double — The amount of tax applied to the item. - `CreatedCampaignVoucherId` integer, nullable — The id of the campaign voucher that was created from this order - `OrderId` integer — Order identifier - `LocalOrderId` string — Local order Id. This is used for displaying a "shorter" order ID for customers (eg. Kiosk orders) - `DeliveryType` 'Delivery' | 'Pickup' — Delivery type - `PickupLocationType` 'TakeOut' | 'TableService' | 'DineIn' — Pickup location type - `TableServiceCatagory` 'Generic' | 'Villa' | 'House' | 'Room' | 'Area' | 'Table' | 'ParkingBay' | 'Gate' | 'DriveThrough' | 'Team', nullable — Pickup location type - `TipAmount` number, double — Tip amount - `DeliveryAmount` number, double — Delivery amount - `OrderItemsAmount` number, double — Ordered items amount - `ServiceChargeAmount` number, double — Service Charge Amount - `ServiceChargePercentage` number, double — Service Charge Percentage - `Amount` number, 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. - `ProcessingFee` number, 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. - `PaymentAccountType` 'Card' | 'Cash' | 'Ideal' | 'Bancontact' | 'Giropay' | 'Eps' | 'Emv' | 'PayPal' | 'PayGreen' | 'GoogleWalletToken' — Payment account type - `PaymentAccountDescription` string — Payment account description (like Visa ****2371 or Apple Pay. or Cash) - `OrderState` 'Created' | 'PlacedCanBeCancelled' | 'ReadyToProcess' | 'AcceptedByRestaurant' | 'Dispatched' | 'Delivered' | 'Cancelled' | 'ManualReview' | 'RejectedByStore' | 'RejectedByFlipdish' | 'RejectedAutomatically' | 'RejectedAfterBeingAccepted' | 'AcceptedAndRefunded' | 'PendingPayment' — Order state - `IsPreOrder` boolean — Is pre-order - `PlacedTime` string, date-time — Order placed time - `RequestedForTime` string, date-time — Order requested for - `ChefNote` string — Chef note - `AppType` 'Unknown' | 'Ios' | 'Android' | 'Web' | 'Kiosk' | 'Pos' | 'TelephoneCall' | 'Sms' | 'PwaAndroid' | 'PwaIos' | 'Google' — Used app type - `UserRating` integer, nullable — User rating - `PaymentStatus` 'Paid' | 'Unpaid' | 'Refunded' | 'PartiallyRefunded' | 'Disputed' — Status of the payment - `RejectionReason` 'TooBusy' | 'FoodUnavailable' | 'UnableToDeliver' | 'UnknownAddress' | 'UnknownReason' | 'TooSoon' | 'TimeUnavailable' | 'DontDeliverToArea' | 'StoreUncontactable', nullable — Rejection reason. Can have value if the order is rejected. - `RefundedAmount` number, double, nullable — Amount refunded to customer. - `DeliveryTrackingStatus` 'Unassigned' | 'Unaccepted' | 'Accepted' | 'Carrying' | 'OnTheWay' | 'ArrivedAtLocation' | 'Delivered' | 'CannotDeliver', nullable — Delivery tracking status - `DriverId` integer, nullable — Assigned driver identifier - `TotalTax` number, double — Total tax applied to order - `OrderTrackingCode` string — Unique, 6 character long alpha numeric code for tracking. - `DeliveryFeeAreaId` integer, nullable — Delivery area identifier - `ReceiptCode` string — Code used to view the order's receipt - `TotalDepositReturnFeeAmount` number, double — This contains the total deposit return fee amount for the order. - `FlipdishEventId` string, uuid — The identitfier of the event - `CreateTime` string, date-time — The time of creation of the event - `Position` integer — Position - `AppId` string — App id - `OrgId` string — Org id - `IpAddress` string — Ip Address - `ActivityId` string — Activity Id - `ActivityType` string — Activity Type - `OrderRatingUpdatedEvent` OrderRatingUpdatedEvent[] — Order rating updated events - `EventName` string — The event name - `Rating` integer, nullable — New User Rating - `Description` string — Description - `Order` Order — Order - `Store` StoreSummary — Store summary - `Id` integer — Store identifier - `Name` string — Store name - `MenuId` integer — Stores menu identifier - `MenuPublishId` string, uuid — Stores menu publish GUID - `Metadata` object — Store metadata - `Currency` 'EUR' | 'USD' | 'GBP' | 'CAD' | 'AUD' | 'DJF' | 'ZAR' | 'ETB' | 'AED' | 'BHD' | 'DZD' | 'EGP' | 'IQD' | 'JOD' | 'KWD' | 'LBP' | 'LYD' | 'MAD' | 'OMR' | 'QAR' | 'SAR' | 'SYP' | 'TND' | 'YER' | 'CLP' | 'INR' | 'AZN' | 'RUB' | 'BYN' | 'BGN' | 'NGN' | 'BDT' | 'CNY' | 'BAM' | 'CZK' | 'DKK' | 'CHF' | 'MVR' | 'BTN' | 'XCD' | 'BZD' | 'HKD' | 'IDR' | 'JMD' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'TTD' | 'XDR' | 'ARS' | 'BOB' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PEN' | 'PYG' | 'UYU' | 'VEF' | 'IRR' | 'XOF' | 'CDF' | 'XAF' | 'HTG' | 'ILS' | 'HRK' | 'HUF' | 'AMD' | 'ISK' | 'JPY' | 'GEL' | 'KZT' | 'KHR' | 'KRW' | 'KGS' | 'LAK' | 'MKD' | 'MNT' | 'BND' | 'MMK' | 'NOK' | 'NPR' | 'PKR' | 'PLN' | 'AFN' | 'BRL' | 'MDL' | 'RON' | 'RWF' | 'SEK' | 'LKR' | 'SOS' | 'ALL' | 'RSD' | 'KES' | 'TJS' | 'THB' | 'ERN' | 'TMT' | 'BWP' | 'TRY' | 'UAH' | 'UZS' | 'VND' | 'MOP' | 'TWD' | 'BMD' — Currency which used by the Store - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `StoreTimezone` string — Timezone of store - `StoreIanaTimezone` string — IANA Timezone of store - `StoreGroupId` integer — Store group id of store - `TaxId` string — VAT number or generic Tax ID of the store - `PrettyAddress` string — Address of the store - `CountryCode` string — Country code of the store address (ISO 3166-1 alpha-2) - `PropertyId` string — Property identifier - `Customer` CustomerSummary — Customer summary - `Id` integer — Customer identifier - `Name` string — Customer name - `EmailAddress` string — Customer email address - `PhoneNumberLocalFormat` string — Customer local phone number - `PhoneNumber` string — Customer phone number - `LanguagePreference` string — Preferred language of the consumer - `Voucher` OrderVoucherSummary — Voucher summary - `VoucherId` integer — Voucher ID - `Name` string — Voucher name - `Description` string — Voucher description - `Code` string — Voucher code - `Amount` number, double — Voucher amount - `Type` 'PercentageDiscount' | 'LumpDiscount' | 'AddItem' | 'CreditNote' | 'FreeDelivery' — Voucher type - `SubType` 'None' | 'SignUp' | 'Loyalty' | 'Loyalty25' | 'Retention' | 'SecondaryRetention' | 'Custom' — Voucher sub type - `Fees` FeeSummary — Fee Summary - `FeeAmount` number, double — Fee amount - `PercentageRate` number, double — Percentage rate - `PerTransactionFee` number, double — Per transaction fee - `OrderItems` OrderItem[] — Ordered items - `OrderItemOptions` OrderItemOption[] — Option list - `Metadata` object — Metadata - `MenuItemOptionPublicId` string, uuid — Public id of the Menu Item Option - `MenuItemOptionId` integer — Menu item option identifier - `IsMasterOptionSetItem` boolean — Is master option set item - `Name` string — Name - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `MenuItemOptionDisplayOrder` integer — Menu item option display order - `MenuItemOptionSetDisplayOrder` integer — Menu item option set display order - `DepositReturnFee` number, double, nullable — Deposit return fee - `Metadata` object — Metadata - `MenuItemPublicId` string, uuid — Public id of the Menu Item - `MenuSectionName` string — Menu section name - `MenuSectionDisplayOrder` integer — Menu section display order - `Name` string — Name - `Description` string — Description - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `PriceIncludingOptionSetItems` number, double — Price including option set items - `MenuItemId` integer — Menu item identifier - `MenuItemDisplayOrder` integer — Menu item display order - `IsAvailable` boolean — Is available - `DepositReturnFee` number, double, nullable — Deposit return fee - `DeliveryLocation` DeliveryLocation — Delivery location - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `Building` string — Building - `Street` string — Street - `Town` string — Town - `PostCode` string — Post code - `DeliveryInstructions` string — Delivery instructions - `PrettyAddressString` string — Formatted, pretty address string - `CustomerLocation` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `MaskedPhoneNumber` MaskedPhoneNumber — Represents a masked phone number - `IsEnabled` boolean — Defines if the feature is enabled - `PhoneNumber` string — Defines the phone number to call - `Code` string — Defines the code to enter - `DropOffLocationId` integer, nullable — Represents table service drop off location - `DropOffLocation` string — Represents table service drop off location - `AcceptedFor` string, date-time, nullable — Time store has accepted the order for - `InFraudZone` boolean — Was order made within a fraud zone - `UnusualHighValueOrder` boolean — Is order of unusually high value - `RejectedByUserId` integer, nullable — Id of user who rejected order, if available - `ChannelOrderId` string — ChannelOrderId from external channel - `ChannelOrderDisplayId` string — ChannelOrderDisplayId from external channel - `Channel` Channel — Channel. - `ChannelId` integer — Channel Id - `TranslationKey` string — Channel TranslationKey - `Source` 'Internal' | 'External' — Channel Source - `LogoUri` string — Channel Logo URl - `Available` boolean — Channel is Available or not - `MaintainedExternally` boolean — Channel is Maintained Externally or not - `OrderDropOffLocation` OrderDropOffLocation — OrderDropOffLocation. - `OrderId` integer — OrderId. - `LocationName` string — LocationName. - `LocationAreaName` string — LocationAreaName. - `LocationId` integer — LocationId. - `LocationAreaId` integer — LocationAreaId. - `ExternalLocationId` string — ExternalLocationId. - `FulfillmentStatus` OrderFulfillmentStatusBase — Fulfillment Status Information - `StatusId` string — Fulfillment Status Id - `StatusName` string — Fulfillment Status Name - `Icon` string — Status Icon - `OrderBatchInfo` OrderBatchSummary — Order batch info - `Id` integer — Order batch id - `DisplayCode` string — Order batch 6-sign human readable code - `CreateTime` string, date-time — Batch creation date and time - `IsPublished` boolean — If the batch is already published - `TaxItems` TaxItem[] — A collection of tax items on the order. - `Name` string — The name of the tax item. - `Rate` number, double — The tax rate applied to the item. - `Amount` number, double — The amount of tax applied to the item. - `CreatedCampaignVoucherId` integer, nullable — The id of the campaign voucher that was created from this order - `OrderId` integer — Order identifier - `LocalOrderId` string — Local order Id. This is used for displaying a "shorter" order ID for customers (eg. Kiosk orders) - `DeliveryType` 'Delivery' | 'Pickup' — Delivery type - `PickupLocationType` 'TakeOut' | 'TableService' | 'DineIn' — Pickup location type - `TableServiceCatagory` 'Generic' | 'Villa' | 'House' | 'Room' | 'Area' | 'Table' | 'ParkingBay' | 'Gate' | 'DriveThrough' | 'Team', nullable — Pickup location type - `TipAmount` number, double — Tip amount - `DeliveryAmount` number, double — Delivery amount - `OrderItemsAmount` number, double — Ordered items amount - `ServiceChargeAmount` number, double — Service Charge Amount - `ServiceChargePercentage` number, double — Service Charge Percentage - `Amount` number, 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. - `ProcessingFee` number, 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. - `PaymentAccountType` 'Card' | 'Cash' | 'Ideal' | 'Bancontact' | 'Giropay' | 'Eps' | 'Emv' | 'PayPal' | 'PayGreen' | 'GoogleWalletToken' — Payment account type - `PaymentAccountDescription` string — Payment account description (like Visa ****2371 or Apple Pay. or Cash) - `OrderState` 'Created' | 'PlacedCanBeCancelled' | 'ReadyToProcess' | 'AcceptedByRestaurant' | 'Dispatched' | 'Delivered' | 'Cancelled' | 'ManualReview' | 'RejectedByStore' | 'RejectedByFlipdish' | 'RejectedAutomatically' | 'RejectedAfterBeingAccepted' | 'AcceptedAndRefunded' | 'PendingPayment' — Order state - `IsPreOrder` boolean — Is pre-order - `PlacedTime` string, date-time — Order placed time - `RequestedForTime` string, date-time — Order requested for - `ChefNote` string — Chef note - `AppType` 'Unknown' | 'Ios' | 'Android' | 'Web' | 'Kiosk' | 'Pos' | 'TelephoneCall' | 'Sms' | 'PwaAndroid' | 'PwaIos' | 'Google' — Used app type - `UserRating` integer, nullable — User rating - `PaymentStatus` 'Paid' | 'Unpaid' | 'Refunded' | 'PartiallyRefunded' | 'Disputed' — Status of the payment - `RejectionReason` 'TooBusy' | 'FoodUnavailable' | 'UnableToDeliver' | 'UnknownAddress' | 'UnknownReason' | 'TooSoon' | 'TimeUnavailable' | 'DontDeliverToArea' | 'StoreUncontactable', nullable — Rejection reason. Can have value if the order is rejected. - `RefundedAmount` number, double, nullable — Amount refunded to customer. - `DeliveryTrackingStatus` 'Unassigned' | 'Unaccepted' | 'Accepted' | 'Carrying' | 'OnTheWay' | 'ArrivedAtLocation' | 'Delivered' | 'CannotDeliver', nullable — Delivery tracking status - `DriverId` integer, nullable — Assigned driver identifier - `TotalTax` number, double — Total tax applied to order - `OrderTrackingCode` string — Unique, 6 character long alpha numeric code for tracking. - `DeliveryFeeAreaId` integer, nullable — Delivery area identifier - `ReceiptCode` string — Code used to view the order's receipt - `TotalDepositReturnFeeAmount` number, double — This contains the total deposit return fee amount for the order. - `FlipdishEventId` string, uuid — The identitfier of the event - `CreateTime` string, date-time — The time of creation of the event - `Position` integer — Position - `AppId` string — App id - `OrgId` string — Org id - `IpAddress` string — Ip Address - `ActivityId` string — Activity Id - `ActivityType` string — Activity Type - `OrderRefundedEvent` OrderRefundedEvent[] — Order refunded events - `EventName` string — The event name - `RefundedAmount` number, double — The amount refunded - `Description` string — Description - `User` UserEventInfo — User Event Info - `UserId` integer — User Id - `UserName` string — User Name - `UserPhoneNumber` string — User Phone Number - `UserEmail` string — User Email - `Order` Order — Order - `Store` StoreSummary — Store summary - `Id` integer — Store identifier - `Name` string — Store name - `MenuId` integer — Stores menu identifier - `MenuPublishId` string, uuid — Stores menu publish GUID - `Metadata` object — Store metadata - `Currency` 'EUR' | 'USD' | 'GBP' | 'CAD' | 'AUD' | 'DJF' | 'ZAR' | 'ETB' | 'AED' | 'BHD' | 'DZD' | 'EGP' | 'IQD' | 'JOD' | 'KWD' | 'LBP' | 'LYD' | 'MAD' | 'OMR' | 'QAR' | 'SAR' | 'SYP' | 'TND' | 'YER' | 'CLP' | 'INR' | 'AZN' | 'RUB' | 'BYN' | 'BGN' | 'NGN' | 'BDT' | 'CNY' | 'BAM' | 'CZK' | 'DKK' | 'CHF' | 'MVR' | 'BTN' | 'XCD' | 'BZD' | 'HKD' | 'IDR' | 'JMD' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'TTD' | 'XDR' | 'ARS' | 'BOB' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PEN' | 'PYG' | 'UYU' | 'VEF' | 'IRR' | 'XOF' | 'CDF' | 'XAF' | 'HTG' | 'ILS' | 'HRK' | 'HUF' | 'AMD' | 'ISK' | 'JPY' | 'GEL' | 'KZT' | 'KHR' | 'KRW' | 'KGS' | 'LAK' | 'MKD' | 'MNT' | 'BND' | 'MMK' | 'NOK' | 'NPR' | 'PKR' | 'PLN' | 'AFN' | 'BRL' | 'MDL' | 'RON' | 'RWF' | 'SEK' | 'LKR' | 'SOS' | 'ALL' | 'RSD' | 'KES' | 'TJS' | 'THB' | 'ERN' | 'TMT' | 'BWP' | 'TRY' | 'UAH' | 'UZS' | 'VND' | 'MOP' | 'TWD' | 'BMD' — Currency which used by the Store - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `StoreTimezone` string — Timezone of store - `StoreIanaTimezone` string — IANA Timezone of store - `StoreGroupId` integer — Store group id of store - `TaxId` string — VAT number or generic Tax ID of the store - `PrettyAddress` string — Address of the store - `CountryCode` string — Country code of the store address (ISO 3166-1 alpha-2) - `PropertyId` string — Property identifier - `Customer` CustomerSummary — Customer summary - `Id` integer — Customer identifier - `Name` string — Customer name - `EmailAddress` string — Customer email address - `PhoneNumberLocalFormat` string — Customer local phone number - `PhoneNumber` string — Customer phone number - `LanguagePreference` string — Preferred language of the consumer - `Voucher` OrderVoucherSummary — Voucher summary - `VoucherId` integer — Voucher ID - `Name` string — Voucher name - `Description` string — Voucher description - `Code` string — Voucher code - `Amount` number, double — Voucher amount - `Type` 'PercentageDiscount' | 'LumpDiscount' | 'AddItem' | 'CreditNote' | 'FreeDelivery' — Voucher type - `SubType` 'None' | 'SignUp' | 'Loyalty' | 'Loyalty25' | 'Retention' | 'SecondaryRetention' | 'Custom' — Voucher sub type - `Fees` FeeSummary — Fee Summary - `FeeAmount` number, double — Fee amount - `PercentageRate` number, double — Percentage rate - `PerTransactionFee` number, double — Per transaction fee - `OrderItems` OrderItem[] — Ordered items - `OrderItemOptions` OrderItemOption[] — Option list - `Metadata` object — Metadata - `MenuItemOptionPublicId` string, uuid — Public id of the Menu Item Option - `MenuItemOptionId` integer — Menu item option identifier - `IsMasterOptionSetItem` boolean — Is master option set item - `Name` string — Name - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `MenuItemOptionDisplayOrder` integer — Menu item option display order - `MenuItemOptionSetDisplayOrder` integer — Menu item option set display order - `DepositReturnFee` number, double, nullable — Deposit return fee - `Metadata` object — Metadata - `MenuItemPublicId` string, uuid — Public id of the Menu Item - `MenuSectionName` string — Menu section name - `MenuSectionDisplayOrder` integer — Menu section display order - `Name` string — Name - `Description` string — Description - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `PriceIncludingOptionSetItems` number, double — Price including option set items - `MenuItemId` integer — Menu item identifier - `MenuItemDisplayOrder` integer — Menu item display order - `IsAvailable` boolean — Is available - `DepositReturnFee` number, double, nullable — Deposit return fee - `DeliveryLocation` DeliveryLocation — Delivery location - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `Building` string — Building - `Street` string — Street - `Town` string — Town - `PostCode` string — Post code - `DeliveryInstructions` string — Delivery instructions - `PrettyAddressString` string — Formatted, pretty address string - `CustomerLocation` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `MaskedPhoneNumber` MaskedPhoneNumber — Represents a masked phone number - `IsEnabled` boolean — Defines if the feature is enabled - `PhoneNumber` string — Defines the phone number to call - `Code` string — Defines the code to enter - `DropOffLocationId` integer, nullable — Represents table service drop off location - `DropOffLocation` string — Represents table service drop off location - `AcceptedFor` string, date-time, nullable — Time store has accepted the order for - `InFraudZone` boolean — Was order made within a fraud zone - `UnusualHighValueOrder` boolean — Is order of unusually high value - `RejectedByUserId` integer, nullable — Id of user who rejected order, if available - `ChannelOrderId` string — ChannelOrderId from external channel - `ChannelOrderDisplayId` string — ChannelOrderDisplayId from external channel - `Channel` Channel — Channel. - `ChannelId` integer — Channel Id - `TranslationKey` string — Channel TranslationKey - `Source` 'Internal' | 'External' — Channel Source - `LogoUri` string — Channel Logo URl - `Available` boolean — Channel is Available or not - `MaintainedExternally` boolean — Channel is Maintained Externally or not - `OrderDropOffLocation` OrderDropOffLocation — OrderDropOffLocation. - `OrderId` integer — OrderId. - `LocationName` string — LocationName. - `LocationAreaName` string — LocationAreaName. - `LocationId` integer — LocationId. - `LocationAreaId` integer — LocationAreaId. - `ExternalLocationId` string — ExternalLocationId. - `FulfillmentStatus` OrderFulfillmentStatusBase — Fulfillment Status Information - `StatusId` string — Fulfillment Status Id - `StatusName` string — Fulfillment Status Name - `Icon` string — Status Icon - `OrderBatchInfo` OrderBatchSummary — Order batch info - `Id` integer — Order batch id - `DisplayCode` string — Order batch 6-sign human readable code - `CreateTime` string, date-time — Batch creation date and time - `IsPublished` boolean — If the batch is already published - `TaxItems` TaxItem[] — A collection of tax items on the order. - `Name` string — The name of the tax item. - `Rate` number, double — The tax rate applied to the item. - `Amount` number, double — The amount of tax applied to the item. - `CreatedCampaignVoucherId` integer, nullable — The id of the campaign voucher that was created from this order - `OrderId` integer — Order identifier - `LocalOrderId` string — Local order Id. This is used for displaying a "shorter" order ID for customers (eg. Kiosk orders) - `DeliveryType` 'Delivery' | 'Pickup' — Delivery type - `PickupLocationType` 'TakeOut' | 'TableService' | 'DineIn' — Pickup location type - `TableServiceCatagory` 'Generic' | 'Villa' | 'House' | 'Room' | 'Area' | 'Table' | 'ParkingBay' | 'Gate' | 'DriveThrough' | 'Team', nullable — Pickup location type - `TipAmount` number, double — Tip amount - `DeliveryAmount` number, double — Delivery amount - `OrderItemsAmount` number, double — Ordered items amount - `ServiceChargeAmount` number, double — Service Charge Amount - `ServiceChargePercentage` number, double — Service Charge Percentage - `Amount` number, 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. - `ProcessingFee` number, 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. - `PaymentAccountType` 'Card' | 'Cash' | 'Ideal' | 'Bancontact' | 'Giropay' | 'Eps' | 'Emv' | 'PayPal' | 'PayGreen' | 'GoogleWalletToken' — Payment account type - `PaymentAccountDescription` string — Payment account description (like Visa ****2371 or Apple Pay. or Cash) - `OrderState` 'Created' | 'PlacedCanBeCancelled' | 'ReadyToProcess' | 'AcceptedByRestaurant' | 'Dispatched' | 'Delivered' | 'Cancelled' | 'ManualReview' | 'RejectedByStore' | 'RejectedByFlipdish' | 'RejectedAutomatically' | 'RejectedAfterBeingAccepted' | 'AcceptedAndRefunded' | 'PendingPayment' — Order state - `IsPreOrder` boolean — Is pre-order - `PlacedTime` string, date-time — Order placed time - `RequestedForTime` string, date-time — Order requested for - `ChefNote` string — Chef note - `AppType` 'Unknown' | 'Ios' | 'Android' | 'Web' | 'Kiosk' | 'Pos' | 'TelephoneCall' | 'Sms' | 'PwaAndroid' | 'PwaIos' | 'Google' — Used app type - `UserRating` integer, nullable — User rating - `PaymentStatus` 'Paid' | 'Unpaid' | 'Refunded' | 'PartiallyRefunded' | 'Disputed' — Status of the payment - `RejectionReason` 'TooBusy' | 'FoodUnavailable' | 'UnableToDeliver' | 'UnknownAddress' | 'UnknownReason' | 'TooSoon' | 'TimeUnavailable' | 'DontDeliverToArea' | 'StoreUncontactable', nullable — Rejection reason. Can have value if the order is rejected. - `RefundedAmount` number, double, nullable — Amount refunded to customer. - `DeliveryTrackingStatus` 'Unassigned' | 'Unaccepted' | 'Accepted' | 'Carrying' | 'OnTheWay' | 'ArrivedAtLocation' | 'Delivered' | 'CannotDeliver', nullable — Delivery tracking status - `DriverId` integer, nullable — Assigned driver identifier - `TotalTax` number, double — Total tax applied to order - `OrderTrackingCode` string — Unique, 6 character long alpha numeric code for tracking. - `DeliveryFeeAreaId` integer, nullable — Delivery area identifier - `ReceiptCode` string — Code used to view the order's receipt - `TotalDepositReturnFeeAmount` number, double — This contains the total deposit return fee amount for the order. - `FlipdishEventId` string, uuid — The identitfier of the event - `CreateTime` string, date-time — The time of creation of the event - `Position` integer — Position - `AppId` string — App id - `OrgId` string — Org id - `IpAddress` string — Ip Address - `ActivityId` string — Activity Id - `ActivityType` string — Activity Type - `OrderRejectedEvent` OrderRejectedEvent[] — Order rejected events - `EventName` string — The event name - `Description` string — Description - `OrderRejectedTime` string, date-time — Order Rejected Time - `Reason` string — Reason for Rejection - `User` UserEventInfo — User Event Info - `UserId` integer — User Id - `UserName` string — User Name - `UserPhoneNumber` string — User Phone Number - `UserEmail` string — User Email - `Order` Order — Order - `Store` StoreSummary — Store summary - `Id` integer — Store identifier - `Name` string — Store name - `MenuId` integer — Stores menu identifier - `MenuPublishId` string, uuid — Stores menu publish GUID - `Metadata` object — Store metadata - `Currency` 'EUR' | 'USD' | 'GBP' | 'CAD' | 'AUD' | 'DJF' | 'ZAR' | 'ETB' | 'AED' | 'BHD' | 'DZD' | 'EGP' | 'IQD' | 'JOD' | 'KWD' | 'LBP' | 'LYD' | 'MAD' | 'OMR' | 'QAR' | 'SAR' | 'SYP' | 'TND' | 'YER' | 'CLP' | 'INR' | 'AZN' | 'RUB' | 'BYN' | 'BGN' | 'NGN' | 'BDT' | 'CNY' | 'BAM' | 'CZK' | 'DKK' | 'CHF' | 'MVR' | 'BTN' | 'XCD' | 'BZD' | 'HKD' | 'IDR' | 'JMD' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'TTD' | 'XDR' | 'ARS' | 'BOB' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PEN' | 'PYG' | 'UYU' | 'VEF' | 'IRR' | 'XOF' | 'CDF' | 'XAF' | 'HTG' | 'ILS' | 'HRK' | 'HUF' | 'AMD' | 'ISK' | 'JPY' | 'GEL' | 'KZT' | 'KHR' | 'KRW' | 'KGS' | 'LAK' | 'MKD' | 'MNT' | 'BND' | 'MMK' | 'NOK' | 'NPR' | 'PKR' | 'PLN' | 'AFN' | 'BRL' | 'MDL' | 'RON' | 'RWF' | 'SEK' | 'LKR' | 'SOS' | 'ALL' | 'RSD' | 'KES' | 'TJS' | 'THB' | 'ERN' | 'TMT' | 'BWP' | 'TRY' | 'UAH' | 'UZS' | 'VND' | 'MOP' | 'TWD' | 'BMD' — Currency which used by the Store - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `StoreTimezone` string — Timezone of store - `StoreIanaTimezone` string — IANA Timezone of store - `StoreGroupId` integer — Store group id of store - `TaxId` string — VAT number or generic Tax ID of the store - `PrettyAddress` string — Address of the store - `CountryCode` string — Country code of the store address (ISO 3166-1 alpha-2) - `PropertyId` string — Property identifier - `Customer` CustomerSummary — Customer summary - `Id` integer — Customer identifier - `Name` string — Customer name - `EmailAddress` string — Customer email address - `PhoneNumberLocalFormat` string — Customer local phone number - `PhoneNumber` string — Customer phone number - `LanguagePreference` string — Preferred language of the consumer - `Voucher` OrderVoucherSummary — Voucher summary - `VoucherId` integer — Voucher ID - `Name` string — Voucher name - `Description` string — Voucher description - `Code` string — Voucher code - `Amount` number, double — Voucher amount - `Type` 'PercentageDiscount' | 'LumpDiscount' | 'AddItem' | 'CreditNote' | 'FreeDelivery' — Voucher type - `SubType` 'None' | 'SignUp' | 'Loyalty' | 'Loyalty25' | 'Retention' | 'SecondaryRetention' | 'Custom' — Voucher sub type - `Fees` FeeSummary — Fee Summary - `FeeAmount` number, double — Fee amount - `PercentageRate` number, double — Percentage rate - `PerTransactionFee` number, double — Per transaction fee - `OrderItems` OrderItem[] — Ordered items - `OrderItemOptions` OrderItemOption[] — Option list - `Metadata` object — Metadata - `MenuItemOptionPublicId` string, uuid — Public id of the Menu Item Option - `MenuItemOptionId` integer — Menu item option identifier - `IsMasterOptionSetItem` boolean — Is master option set item - `Name` string — Name - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `MenuItemOptionDisplayOrder` integer — Menu item option display order - `MenuItemOptionSetDisplayOrder` integer — Menu item option set display order - `DepositReturnFee` number, double, nullable — Deposit return fee - `Metadata` object — Metadata - `MenuItemPublicId` string, uuid — Public id of the Menu Item - `MenuSectionName` string — Menu section name - `MenuSectionDisplayOrder` integer — Menu section display order - `Name` string — Name - `Description` string — Description - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `PriceIncludingOptionSetItems` number, double — Price including option set items - `MenuItemId` integer — Menu item identifier - `MenuItemDisplayOrder` integer — Menu item display order - `IsAvailable` boolean — Is available - `DepositReturnFee` number, double, nullable — Deposit return fee - `DeliveryLocation` DeliveryLocation — Delivery location - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `Building` string — Building - `Street` string — Street - `Town` string — Town - `PostCode` string — Post code - `DeliveryInstructions` string — Delivery instructions - `PrettyAddressString` string — Formatted, pretty address string - `CustomerLocation` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `MaskedPhoneNumber` MaskedPhoneNumber — Represents a masked phone number - `IsEnabled` boolean — Defines if the feature is enabled - `PhoneNumber` string — Defines the phone number to call - `Code` string — Defines the code to enter - `DropOffLocationId` integer, nullable — Represents table service drop off location - `DropOffLocation` string — Represents table service drop off location - `AcceptedFor` string, date-time, nullable — Time store has accepted the order for - `InFraudZone` boolean — Was order made within a fraud zone - `UnusualHighValueOrder` boolean — Is order of unusually high value - `RejectedByUserId` integer, nullable — Id of user who rejected order, if available - `ChannelOrderId` string — ChannelOrderId from external channel - `ChannelOrderDisplayId` string — ChannelOrderDisplayId from external channel - `Channel` Channel — Channel. - `ChannelId` integer — Channel Id - `TranslationKey` string — Channel TranslationKey - `Source` 'Internal' | 'External' — Channel Source - `LogoUri` string — Channel Logo URl - `Available` boolean — Channel is Available or not - `MaintainedExternally` boolean — Channel is Maintained Externally or not - `OrderDropOffLocation` OrderDropOffLocation — OrderDropOffLocation. - `OrderId` integer — OrderId. - `LocationName` string — LocationName. - `LocationAreaName` string — LocationAreaName. - `LocationId` integer — LocationId. - `LocationAreaId` integer — LocationAreaId. - `ExternalLocationId` string — ExternalLocationId. - `FulfillmentStatus` OrderFulfillmentStatusBase — Fulfillment Status Information - `StatusId` string — Fulfillment Status Id - `StatusName` string — Fulfillment Status Name - `Icon` string — Status Icon - `OrderBatchInfo` OrderBatchSummary — Order batch info - `Id` integer — Order batch id - `DisplayCode` string — Order batch 6-sign human readable code - `CreateTime` string, date-time — Batch creation date and time - `IsPublished` boolean — If the batch is already published - `TaxItems` TaxItem[] — A collection of tax items on the order. - `Name` string — The name of the tax item. - `Rate` number, double — The tax rate applied to the item. - `Amount` number, double — The amount of tax applied to the item. - `CreatedCampaignVoucherId` integer, nullable — The id of the campaign voucher that was created from this order - `OrderId` integer — Order identifier - `LocalOrderId` string — Local order Id. This is used for displaying a "shorter" order ID for customers (eg. Kiosk orders) - `DeliveryType` 'Delivery' | 'Pickup' — Delivery type - `PickupLocationType` 'TakeOut' | 'TableService' | 'DineIn' — Pickup location type - `TableServiceCatagory` 'Generic' | 'Villa' | 'House' | 'Room' | 'Area' | 'Table' | 'ParkingBay' | 'Gate' | 'DriveThrough' | 'Team', nullable — Pickup location type - `TipAmount` number, double — Tip amount - `DeliveryAmount` number, double — Delivery amount - `OrderItemsAmount` number, double — Ordered items amount - `ServiceChargeAmount` number, double — Service Charge Amount - `ServiceChargePercentage` number, double — Service Charge Percentage - `Amount` number, 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. - `ProcessingFee` number, 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. - `PaymentAccountType` 'Card' | 'Cash' | 'Ideal' | 'Bancontact' | 'Giropay' | 'Eps' | 'Emv' | 'PayPal' | 'PayGreen' | 'GoogleWalletToken' — Payment account type - `PaymentAccountDescription` string — Payment account description (like Visa ****2371 or Apple Pay. or Cash) - `OrderState` 'Created' | 'PlacedCanBeCancelled' | 'ReadyToProcess' | 'AcceptedByRestaurant' | 'Dispatched' | 'Delivered' | 'Cancelled' | 'ManualReview' | 'RejectedByStore' | 'RejectedByFlipdish' | 'RejectedAutomatically' | 'RejectedAfterBeingAccepted' | 'AcceptedAndRefunded' | 'PendingPayment' — Order state - `IsPreOrder` boolean — Is pre-order - `PlacedTime` string, date-time — Order placed time - `RequestedForTime` string, date-time — Order requested for - `ChefNote` string — Chef note - `AppType` 'Unknown' | 'Ios' | 'Android' | 'Web' | 'Kiosk' | 'Pos' | 'TelephoneCall' | 'Sms' | 'PwaAndroid' | 'PwaIos' | 'Google' — Used app type - `UserRating` integer, nullable — User rating - `PaymentStatus` 'Paid' | 'Unpaid' | 'Refunded' | 'PartiallyRefunded' | 'Disputed' — Status of the payment - `RejectionReason` 'TooBusy' | 'FoodUnavailable' | 'UnableToDeliver' | 'UnknownAddress' | 'UnknownReason' | 'TooSoon' | 'TimeUnavailable' | 'DontDeliverToArea' | 'StoreUncontactable', nullable — Rejection reason. Can have value if the order is rejected. - `RefundedAmount` number, double, nullable — Amount refunded to customer. - `DeliveryTrackingStatus` 'Unassigned' | 'Unaccepted' | 'Accepted' | 'Carrying' | 'OnTheWay' | 'ArrivedAtLocation' | 'Delivered' | 'CannotDeliver', nullable — Delivery tracking status - `DriverId` integer, nullable — Assigned driver identifier - `TotalTax` number, double — Total tax applied to order - `OrderTrackingCode` string — Unique, 6 character long alpha numeric code for tracking. - `DeliveryFeeAreaId` integer, nullable — Delivery area identifier - `ReceiptCode` string — Code used to view the order's receipt - `TotalDepositReturnFeeAmount` number, double — This contains the total deposit return fee amount for the order. - `FlipdishEventId` string, uuid — The identitfier of the event - `CreateTime` string, date-time — The time of creation of the event - `Position` integer — Position - `AppId` string — App id - `OrgId` string — Org id - `IpAddress` string — Ip Address - `ActivityId` string — Activity Id - `ActivityType` string — Activity Type - `OrderTipUpdatedEvent` OrderTipUpdatedEvent[] — Order tip updated events - `EventName` string — The event name - `TipAmount` number, double — Tip Amount - `Description` string — Description - `Order` Order — Order - `Store` StoreSummary — Store summary - `Id` integer — Store identifier - `Name` string — Store name - `MenuId` integer — Stores menu identifier - `MenuPublishId` string, uuid — Stores menu publish GUID - `Metadata` object — Store metadata - `Currency` 'EUR' | 'USD' | 'GBP' | 'CAD' | 'AUD' | 'DJF' | 'ZAR' | 'ETB' | 'AED' | 'BHD' | 'DZD' | 'EGP' | 'IQD' | 'JOD' | 'KWD' | 'LBP' | 'LYD' | 'MAD' | 'OMR' | 'QAR' | 'SAR' | 'SYP' | 'TND' | 'YER' | 'CLP' | 'INR' | 'AZN' | 'RUB' | 'BYN' | 'BGN' | 'NGN' | 'BDT' | 'CNY' | 'BAM' | 'CZK' | 'DKK' | 'CHF' | 'MVR' | 'BTN' | 'XCD' | 'BZD' | 'HKD' | 'IDR' | 'JMD' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'TTD' | 'XDR' | 'ARS' | 'BOB' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PEN' | 'PYG' | 'UYU' | 'VEF' | 'IRR' | 'XOF' | 'CDF' | 'XAF' | 'HTG' | 'ILS' | 'HRK' | 'HUF' | 'AMD' | 'ISK' | 'JPY' | 'GEL' | 'KZT' | 'KHR' | 'KRW' | 'KGS' | 'LAK' | 'MKD' | 'MNT' | 'BND' | 'MMK' | 'NOK' | 'NPR' | 'PKR' | 'PLN' | 'AFN' | 'BRL' | 'MDL' | 'RON' | 'RWF' | 'SEK' | 'LKR' | 'SOS' | 'ALL' | 'RSD' | 'KES' | 'TJS' | 'THB' | 'ERN' | 'TMT' | 'BWP' | 'TRY' | 'UAH' | 'UZS' | 'VND' | 'MOP' | 'TWD' | 'BMD' — Currency which used by the Store - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `StoreTimezone` string — Timezone of store - `StoreIanaTimezone` string — IANA Timezone of store - `StoreGroupId` integer — Store group id of store - `TaxId` string — VAT number or generic Tax ID of the store - `PrettyAddress` string — Address of the store - `CountryCode` string — Country code of the store address (ISO 3166-1 alpha-2) - `PropertyId` string — Property identifier - `Customer` CustomerSummary — Customer summary - `Id` integer — Customer identifier - `Name` string — Customer name - `EmailAddress` string — Customer email address - `PhoneNumberLocalFormat` string — Customer local phone number - `PhoneNumber` string — Customer phone number - `LanguagePreference` string — Preferred language of the consumer - `Voucher` OrderVoucherSummary — Voucher summary - `VoucherId` integer — Voucher ID - `Name` string — Voucher name - `Description` string — Voucher description - `Code` string — Voucher code - `Amount` number, double — Voucher amount - `Type` 'PercentageDiscount' | 'LumpDiscount' | 'AddItem' | 'CreditNote' | 'FreeDelivery' — Voucher type - `SubType` 'None' | 'SignUp' | 'Loyalty' | 'Loyalty25' | 'Retention' | 'SecondaryRetention' | 'Custom' — Voucher sub type - `Fees` FeeSummary — Fee Summary - `FeeAmount` number, double — Fee amount - `PercentageRate` number, double — Percentage rate - `PerTransactionFee` number, double — Per transaction fee - `OrderItems` OrderItem[] — Ordered items - `OrderItemOptions` OrderItemOption[] — Option list - `Metadata` object — Metadata - `MenuItemOptionPublicId` string, uuid — Public id of the Menu Item Option - `MenuItemOptionId` integer — Menu item option identifier - `IsMasterOptionSetItem` boolean — Is master option set item - `Name` string — Name - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `MenuItemOptionDisplayOrder` integer — Menu item option display order - `MenuItemOptionSetDisplayOrder` integer — Menu item option set display order - `DepositReturnFee` number, double, nullable — Deposit return fee - `Metadata` object — Metadata - `MenuItemPublicId` string, uuid — Public id of the Menu Item - `MenuSectionName` string — Menu section name - `MenuSectionDisplayOrder` integer — Menu section display order - `Name` string — Name - `Description` string — Description - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `PriceIncludingOptionSetItems` number, double — Price including option set items - `MenuItemId` integer — Menu item identifier - `MenuItemDisplayOrder` integer — Menu item display order - `IsAvailable` boolean — Is available - `DepositReturnFee` number, double, nullable — Deposit return fee - `DeliveryLocation` DeliveryLocation — Delivery location - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `Building` string — Building - `Street` string — Street - `Town` string — Town - `PostCode` string — Post code - `DeliveryInstructions` string — Delivery instructions - `PrettyAddressString` string — Formatted, pretty address string - `CustomerLocation` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `MaskedPhoneNumber` MaskedPhoneNumber — Represents a masked phone number - `IsEnabled` boolean — Defines if the feature is enabled - `PhoneNumber` string — Defines the phone number to call - `Code` string — Defines the code to enter - `DropOffLocationId` integer, nullable — Represents table service drop off location - `DropOffLocation` string — Represents table service drop off location - `AcceptedFor` string, date-time, nullable — Time store has accepted the order for - `InFraudZone` boolean — Was order made within a fraud zone - `UnusualHighValueOrder` boolean — Is order of unusually high value - `RejectedByUserId` integer, nullable — Id of user who rejected order, if available - `ChannelOrderId` string — ChannelOrderId from external channel - `ChannelOrderDisplayId` string — ChannelOrderDisplayId from external channel - `Channel` Channel — Channel. - `ChannelId` integer — Channel Id - `TranslationKey` string — Channel TranslationKey - `Source` 'Internal' | 'External' — Channel Source - `LogoUri` string — Channel Logo URl - `Available` boolean — Channel is Available or not - `MaintainedExternally` boolean — Channel is Maintained Externally or not - `OrderDropOffLocation` OrderDropOffLocation — OrderDropOffLocation. - `OrderId` integer — OrderId. - `LocationName` string — LocationName. - `LocationAreaName` string — LocationAreaName. - `LocationId` integer — LocationId. - `LocationAreaId` integer — LocationAreaId. - `ExternalLocationId` string — ExternalLocationId. - `FulfillmentStatus` OrderFulfillmentStatusBase — Fulfillment Status Information - `StatusId` string — Fulfillment Status Id - `StatusName` string — Fulfillment Status Name - `Icon` string — Status Icon - `OrderBatchInfo` OrderBatchSummary — Order batch info - `Id` integer — Order batch id - `DisplayCode` string — Order batch 6-sign human readable code - `CreateTime` string, date-time — Batch creation date and time - `IsPublished` boolean — If the batch is already published - `TaxItems` TaxItem[] — A collection of tax items on the order. - `Name` string — The name of the tax item. - `Rate` number, double — The tax rate applied to the item. - `Amount` number, double — The amount of tax applied to the item. - `CreatedCampaignVoucherId` integer, nullable — The id of the campaign voucher that was created from this order - `OrderId` integer — Order identifier - `LocalOrderId` string — Local order Id. This is used for displaying a "shorter" order ID for customers (eg. Kiosk orders) - `DeliveryType` 'Delivery' | 'Pickup' — Delivery type - `PickupLocationType` 'TakeOut' | 'TableService' | 'DineIn' — Pickup location type - `TableServiceCatagory` 'Generic' | 'Villa' | 'House' | 'Room' | 'Area' | 'Table' | 'ParkingBay' | 'Gate' | 'DriveThrough' | 'Team', nullable — Pickup location type - `TipAmount` number, double — Tip amount - `DeliveryAmount` number, double — Delivery amount - `OrderItemsAmount` number, double — Ordered items amount - `ServiceChargeAmount` number, double — Service Charge Amount - `ServiceChargePercentage` number, double — Service Charge Percentage - `Amount` number, 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. - `ProcessingFee` number, 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. - `PaymentAccountType` 'Card' | 'Cash' | 'Ideal' | 'Bancontact' | 'Giropay' | 'Eps' | 'Emv' | 'PayPal' | 'PayGreen' | 'GoogleWalletToken' — Payment account type - `PaymentAccountDescription` string — Payment account description (like Visa ****2371 or Apple Pay. or Cash) - `OrderState` 'Created' | 'PlacedCanBeCancelled' | 'ReadyToProcess' | 'AcceptedByRestaurant' | 'Dispatched' | 'Delivered' | 'Cancelled' | 'ManualReview' | 'RejectedByStore' | 'RejectedByFlipdish' | 'RejectedAutomatically' | 'RejectedAfterBeingAccepted' | 'AcceptedAndRefunded' | 'PendingPayment' — Order state - `IsPreOrder` boolean — Is pre-order - `PlacedTime` string, date-time — Order placed time - `RequestedForTime` string, date-time — Order requested for - `ChefNote` string — Chef note - `AppType` 'Unknown' | 'Ios' | 'Android' | 'Web' | 'Kiosk' | 'Pos' | 'TelephoneCall' | 'Sms' | 'PwaAndroid' | 'PwaIos' | 'Google' — Used app type - `UserRating` integer, nullable — User rating - `PaymentStatus` 'Paid' | 'Unpaid' | 'Refunded' | 'PartiallyRefunded' | 'Disputed' — Status of the payment - `RejectionReason` 'TooBusy' | 'FoodUnavailable' | 'UnableToDeliver' | 'UnknownAddress' | 'UnknownReason' | 'TooSoon' | 'TimeUnavailable' | 'DontDeliverToArea' | 'StoreUncontactable', nullable — Rejection reason. Can have value if the order is rejected. - `RefundedAmount` number, double, nullable — Amount refunded to customer. - `DeliveryTrackingStatus` 'Unassigned' | 'Unaccepted' | 'Accepted' | 'Carrying' | 'OnTheWay' | 'ArrivedAtLocation' | 'Delivered' | 'CannotDeliver', nullable — Delivery tracking status - `DriverId` integer, nullable — Assigned driver identifier - `TotalTax` number, double — Total tax applied to order - `OrderTrackingCode` string — Unique, 6 character long alpha numeric code for tracking. - `DeliveryFeeAreaId` integer, nullable — Delivery area identifier - `ReceiptCode` string — Code used to view the order's receipt - `TotalDepositReturnFeeAmount` number, double — This contains the total deposit return fee amount for the order. - `FlipdishEventId` string, uuid — The identitfier of the event - `CreateTime` string, date-time — The time of creation of the event - `Position` integer — Position - `AppId` string — App id - `OrgId` string — Org id - `IpAddress` string — Ip Address - `ActivityId` string — Activity Id - `ActivityType` string — Activity Type - `OrderTerminalNotifications` EmvNotificationEvent[] — Order Terminal Notification events - `EventName` string — The event name - `Notification` string — Notification Sent - `Order` Order — Order - `Store` StoreSummary — Store summary - `Id` integer — Store identifier - `Name` string — Store name - `MenuId` integer — Stores menu identifier - `MenuPublishId` string, uuid — Stores menu publish GUID - `Metadata` object — Store metadata - `Currency` 'EUR' | 'USD' | 'GBP' | 'CAD' | 'AUD' | 'DJF' | 'ZAR' | 'ETB' | 'AED' | 'BHD' | 'DZD' | 'EGP' | 'IQD' | 'JOD' | 'KWD' | 'LBP' | 'LYD' | 'MAD' | 'OMR' | 'QAR' | 'SAR' | 'SYP' | 'TND' | 'YER' | 'CLP' | 'INR' | 'AZN' | 'RUB' | 'BYN' | 'BGN' | 'NGN' | 'BDT' | 'CNY' | 'BAM' | 'CZK' | 'DKK' | 'CHF' | 'MVR' | 'BTN' | 'XCD' | 'BZD' | 'HKD' | 'IDR' | 'JMD' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'TTD' | 'XDR' | 'ARS' | 'BOB' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PEN' | 'PYG' | 'UYU' | 'VEF' | 'IRR' | 'XOF' | 'CDF' | 'XAF' | 'HTG' | 'ILS' | 'HRK' | 'HUF' | 'AMD' | 'ISK' | 'JPY' | 'GEL' | 'KZT' | 'KHR' | 'KRW' | 'KGS' | 'LAK' | 'MKD' | 'MNT' | 'BND' | 'MMK' | 'NOK' | 'NPR' | 'PKR' | 'PLN' | 'AFN' | 'BRL' | 'MDL' | 'RON' | 'RWF' | 'SEK' | 'LKR' | 'SOS' | 'ALL' | 'RSD' | 'KES' | 'TJS' | 'THB' | 'ERN' | 'TMT' | 'BWP' | 'TRY' | 'UAH' | 'UZS' | 'VND' | 'MOP' | 'TWD' | 'BMD' — Currency which used by the Store - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `StoreTimezone` string — Timezone of store - `StoreIanaTimezone` string — IANA Timezone of store - `StoreGroupId` integer — Store group id of store - `TaxId` string — VAT number or generic Tax ID of the store - `PrettyAddress` string — Address of the store - `CountryCode` string — Country code of the store address (ISO 3166-1 alpha-2) - `PropertyId` string — Property identifier - `Customer` CustomerSummary — Customer summary - `Id` integer — Customer identifier - `Name` string — Customer name - `EmailAddress` string — Customer email address - `PhoneNumberLocalFormat` string — Customer local phone number - `PhoneNumber` string — Customer phone number - `LanguagePreference` string — Preferred language of the consumer - `Voucher` OrderVoucherSummary — Voucher summary - `VoucherId` integer — Voucher ID - `Name` string — Voucher name - `Description` string — Voucher description - `Code` string — Voucher code - `Amount` number, double — Voucher amount - `Type` 'PercentageDiscount' | 'LumpDiscount' | 'AddItem' | 'CreditNote' | 'FreeDelivery' — Voucher type - `SubType` 'None' | 'SignUp' | 'Loyalty' | 'Loyalty25' | 'Retention' | 'SecondaryRetention' | 'Custom' — Voucher sub type - `Fees` FeeSummary — Fee Summary - `FeeAmount` number, double — Fee amount - `PercentageRate` number, double — Percentage rate - `PerTransactionFee` number, double — Per transaction fee - `OrderItems` OrderItem[] — Ordered items - `OrderItemOptions` OrderItemOption[] — Option list - `Metadata` object — Metadata - `MenuItemOptionPublicId` string, uuid — Public id of the Menu Item Option - `MenuItemOptionId` integer — Menu item option identifier - `IsMasterOptionSetItem` boolean — Is master option set item - `Name` string — Name - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `MenuItemOptionDisplayOrder` integer — Menu item option display order - `MenuItemOptionSetDisplayOrder` integer — Menu item option set display order - `DepositReturnFee` number, double, nullable — Deposit return fee - `Metadata` object — Metadata - `MenuItemPublicId` string, uuid — Public id of the Menu Item - `MenuSectionName` string — Menu section name - `MenuSectionDisplayOrder` integer — Menu section display order - `Name` string — Name - `Description` string — Description - `Price` number, double — Price - `TaxAmount` number, double — Tax currency amount - `PriceIncludingOptionSetItems` number, double — Price including option set items - `MenuItemId` integer — Menu item identifier - `MenuItemDisplayOrder` integer — Menu item display order - `IsAvailable` boolean — Is available - `DepositReturnFee` number, double, nullable — Deposit return fee - `DeliveryLocation` DeliveryLocation — Delivery location - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `Building` string — Building - `Street` string — Street - `Town` string — Town - `PostCode` string — Post code - `DeliveryInstructions` string — Delivery instructions - `PrettyAddressString` string — Formatted, pretty address string - `CustomerLocation` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `MaskedPhoneNumber` MaskedPhoneNumber — Represents a masked phone number - `IsEnabled` boolean — Defines if the feature is enabled - `PhoneNumber` string — Defines the phone number to call - `Code` string — Defines the code to enter - `DropOffLocationId` integer, nullable — Represents table service drop off location - `DropOffLocation` string — Represents table service drop off location - `AcceptedFor` string, date-time, nullable — Time store has accepted the order for - `InFraudZone` boolean — Was order made within a fraud zone - `UnusualHighValueOrder` boolean — Is order of unusually high value - `RejectedByUserId` integer, nullable — Id of user who rejected order, if available - `ChannelOrderId` string — ChannelOrderId from external channel - `ChannelOrderDisplayId` string — ChannelOrderDisplayId from external channel - `Channel` Channel — Channel. - `ChannelId` integer — Channel Id - `TranslationKey` string — Channel TranslationKey - `Source` 'Internal' | 'External' — Channel Source - `LogoUri` string — Channel Logo URl - `Available` boolean — Channel is Available or not - `MaintainedExternally` boolean — Channel is Maintained Externally or not - `OrderDropOffLocation` OrderDropOffLocation — OrderDropOffLocation. - `OrderId` integer — OrderId. - `LocationName` string — LocationName. - `LocationAreaName` string — LocationAreaName. - `LocationId` integer — LocationId. - `LocationAreaId` integer — LocationAreaId. - `ExternalLocationId` string — ExternalLocationId. - `FulfillmentStatus` OrderFulfillmentStatusBase — Fulfillment Status Information - `StatusId` string — Fulfillment Status Id - `StatusName` string — Fulfillment Status Name - `Icon` string — Status Icon - `OrderBatchInfo` OrderBatchSummary — Order batch info - `Id` integer — Order batch id - `DisplayCode` string — Order batch 6-sign human readable code - `CreateTime` string, date-time — Batch creation date and time - `IsPublished` boolean — If the batch is already published - `TaxItems` TaxItem[] — A collection of tax items on the order. - `Name` string — The name of the tax item. - `Rate` number, double — The tax rate applied to the item. - `Amount` number, double — The amount of tax applied to the item. - `CreatedCampaignVoucherId` integer, nullable — The id of the campaign voucher that was created from this order - `OrderId` integer — Order identifier - `LocalOrderId` string — Local order Id. This is used for displaying a "shorter" order ID for customers (eg. Kiosk orders) - `DeliveryType` 'Delivery' | 'Pickup' — Delivery type - `PickupLocationType` 'TakeOut' | 'TableService' | 'DineIn' — Pickup location type - `TableServiceCatagory` 'Generic' | 'Villa' | 'House' | 'Room' | 'Area' | 'Table' | 'ParkingBay' | 'Gate' | 'DriveThrough' | 'Team', nullable — Pickup location type - `TipAmount` number, double — Tip amount - `DeliveryAmount` number, double — Delivery amount - `OrderItemsAmount` number, double — Ordered items amount - `ServiceChargeAmount` number, double — Service Charge Amount - `ServiceChargePercentage` number, double — Service Charge Percentage - `Amount` number, 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. - `ProcessingFee` number, 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. - `PaymentAccountType` 'Card' | 'Cash' | 'Ideal' | 'Bancontact' | 'Giropay' | 'Eps' | 'Emv' | 'PayPal' | 'PayGreen' | 'GoogleWalletToken' — Payment account type - `PaymentAccountDescription` string — Payment account description (like Visa ****2371 or Apple Pay. or Cash) - `OrderState` 'Created' | 'PlacedCanBeCancelled' | 'ReadyToProcess' | 'AcceptedByRestaurant' | 'Dispatched' | 'Delivered' | 'Cancelled' | 'ManualReview' | 'RejectedByStore' | 'RejectedByFlipdish' | 'RejectedAutomatically' | 'RejectedAfterBeingAccepted' | 'AcceptedAndRefunded' | 'PendingPayment' — Order state - `IsPreOrder` boolean — Is pre-order - `PlacedTime` string, date-time — Order placed time - `RequestedForTime` string, date-time — Order requested for - `ChefNote` string — Chef note - `AppType` 'Unknown' | 'Ios' | 'Android' | 'Web' | 'Kiosk' | 'Pos' | 'TelephoneCall' | 'Sms' | 'PwaAndroid' | 'PwaIos' | 'Google' — Used app type - `UserRating` integer, nullable — User rating - `PaymentStatus` 'Paid' | 'Unpaid' | 'Refunded' | 'PartiallyRefunded' | 'Disputed' — Status of the payment - `RejectionReason` 'TooBusy' | 'FoodUnavailable' | 'UnableToDeliver' | 'UnknownAddress' | 'UnknownReason' | 'TooSoon' | 'TimeUnavailable' | 'DontDeliverToArea' | 'StoreUncontactable', nullable — Rejection reason. Can have value if the order is rejected. - `RefundedAmount` number, double, nullable — Amount refunded to customer. - `DeliveryTrackingStatus` 'Unassigned' | 'Unaccepted' | 'Accepted' | 'Carrying' | 'OnTheWay' | 'ArrivedAtLocation' | 'Delivered' | 'CannotDeliver', nullable — Delivery tracking status - `DriverId` integer, nullable — Assigned driver identifier - `TotalTax` number, double — Total tax applied to order - `OrderTrackingCode` string — Unique, 6 character long alpha numeric code for tracking. - `DeliveryFeeAreaId` integer, nullable — Delivery area identifier - `ReceiptCode` string — Code used to view the order's receipt - `TotalDepositReturnFeeAmount` number, double — This contains the total deposit return fee amount for the order. - `TerminalId` string — TerminalId - `Description` string — Description - `ExpDate` string — Expirey Date - `CardType` string — Card Type - `PaymentMethod` string — Payment Method - `AccountNumber` string — Masked Account Number - `AuthCode` string — Auth Code - `ProviderMessage` string — Payment Provider Message - `FlipdishEventId` string, uuid — The identitfier of the event - `CreateTime` string, date-time — The time of creation of the event - `Position` integer — Position - `AppId` string — App id - `OrgId` string — Org id - `IpAddress` string — Ip Address - `ActivityId` string — Activity Id - `ActivityType` string — Activity Type - `StoreCreatedEvent` StoreCreatedEvent[] — Store created events - `EventName` string — The event name - `OrgId` string — Organisation Id - `StoreId` integer — Store Id - `User` UserEventInfo — User Event Info - `UserId` integer — User Id - `UserName` string — User Name - `UserPhoneNumber` string — User Phone Number - `UserEmail` string — User Email - `Description` string — Description - `Store` Store — Store - `StoreId` integer — Store identifier - `StoreGroupId` integer — Store group id to which this store belongs - `Address` StoreAddress — Store address - `AddressId` integer — Address identifier - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `Line1` string — Address line 1 - `Postcode` string — Postcode - `City` string — City - `CountryCode` string — Country code (ISO-alpha2) - `DisplayForCustomer` string — Display for customer - `AddressFields` object — Dyanmic field/value pairs, defined by the form assigned to the given country code. - `SingleLineDisplay` string — Single line display i18n, may be empty for not supported countries - `TwoLinesDisplay` string[] — Two line display i18n, may be empty for not supported countries - `DeliveryZones` DeliveryZone[] — Delivery zones - `Id` integer — Delivery Fee Area Id - `FeeChargedToStore` number, double, nullable — Delivery Fee charged to store - `DeliveryFee` number, double — Delivery fee (will not be set below 0) - `MinimumDeliveryOrderAmount` number, double — Minimum delivery order amount (will not be set below 0) - `WellKnownText` string — Spatial data in Well Known Text format We also support CIRCLE((0 0, 200)) - (centerLong centerLat, radius in m) - `IsEnabled` boolean — Is delivery zone enabled - `ApmPhoneNumber` string — Automated Phone Marketing number - `PickupHours` BusinessHoursPeriod[] — Pickup hours - `Early` Range — A class that represents a single opening period in a day. This starts 'StartTime' after midnight and runs for a 'Period' after that, on the given DayOfWeek. - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `Late` Range — A class that represents a single opening period in a day. This starts 'StartTime' after midnight and runs for a 'Period' after that, on the given DayOfWeek. - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `Ranges` Range[] — Ranges - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `StartTime` string — Start time - `Period` string — Period - `StartTimeEarly` string — Start time early - `PeriodEarly` string — Period early - `DeliveryHours` BusinessHoursPeriod[] — Delivery hours - `Early` Range — A class that represents a single opening period in a day. This starts 'StartTime' after midnight and runs for a 'Period' after that, on the given DayOfWeek. - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `Late` Range — A class that represents a single opening period in a day. This starts 'StartTime' after midnight and runs for a 'Period' after that, on the given DayOfWeek. - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `Ranges` Range[] — Ranges - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `StartTime` string — Start time - `Period` string — Period - `StartTimeEarly` string — Start time early - `PeriodEarly` string — Period early - `MenuId` integer — Menu identifier - `OrderConfirmationMessageOverrideDelivery` string — Overridden confirmation message for delivery orders - `OrderConfirmationMessageOverridePickup` string — Overridden confirmation message for pickup orders - `PrintoutLayoutType` 'Default' | 'Centra' | 'SmallChefNotes' | 'SmallChefNotesAndCentra', nullable — Printout layout - `StoreNotes` StoreNote[] — Store notes - `UserId` integer — User identifier - `CreateTime` string, date-time — Create time - `Note` string — Note - `MicrosoftTimeZone` string — Microsoft Time Zone Index Values (https://msdn.microsoft.com/en-us/library/ms912391) (Editable through store coordinate change) - `IanaTimeZone` string — IANA Time Zone (https://www.iana.org/time-zones) (Editable through store coordinate change) - `Currency` 'EUR' | 'USD' | 'GBP' | 'CAD' | 'AUD' | 'DJF' | 'ZAR' | 'ETB' | 'AED' | 'BHD' | 'DZD' | 'EGP' | 'IQD' | 'JOD' | 'KWD' | 'LBP' | 'LYD' | 'MAD' | 'OMR' | 'QAR' | 'SAR' | 'SYP' | 'TND' | 'YER' | 'CLP' | 'INR' | 'AZN' | 'RUB' | 'BYN' | 'BGN' | 'NGN' | 'BDT' | 'CNY' | 'BAM' | 'CZK' | 'DKK' | 'CHF' | 'MVR' | 'BTN' | 'XCD' | 'BZD' | 'HKD' | 'IDR' | 'JMD' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'TTD' | 'XDR' | 'ARS' | 'BOB' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PEN' | 'PYG' | 'UYU' | 'VEF' | 'IRR' | 'XOF' | 'CDF' | 'XAF' | 'HTG' | 'ILS' | 'HRK' | 'HUF' | 'AMD' | 'ISK' | 'JPY' | 'GEL' | 'KZT' | 'KHR' | 'KRW' | 'KGS' | 'LAK' | 'MKD' | 'MNT' | 'BND' | 'MMK' | 'NOK' | 'NPR' | 'PKR' | 'PLN' | 'AFN' | 'BRL' | 'MDL' | 'RON' | 'RWF' | 'SEK' | 'LKR' | 'SOS' | 'ALL' | 'RSD' | 'KES' | 'TJS' | 'THB' | 'ERN' | 'TMT' | 'BWP' | 'TRY' | 'UAH' | 'UZS' | 'VND' | 'MOP' | 'TWD' | 'BMD' — Currency (derived from Store Group) - `PreOrderDeliveryEnabled` boolean — Is PerOrder Enabled for Delivery - `PreOrderPickupEnabled` boolean — Is PerOrder Enabled for Pickup - `LogoUrl` string — Url for logo image - `FraudPreventionStrategy` string — Fraud Prevention Strategy - `AppIds` string[] — Store's app ids - `PropertyId` string — Property Id - `PhoneNumber` string — Phone number - `AlwaysAppearOpen` boolean — True if the store always appears open - `PreOrderEnabled` boolean — True if the store accepts pre-orders - `TakeOutEnabled` boolean — True if the store accepts take-out orders - `TableServiceEnabled` boolean — True if the store has table service - `DineInEnabled` boolean — True if the store accepts dine-in orders - `AllowPreOrdersAndTableService` boolean — True if both pre-orders and talbe service can be enabled - `PickupEnabled` boolean — True if the store accepts pickup orders - `DeliveryEnabled` boolean — True if the store accepts delivery orders - `CardOrderDeliveryEnabled` boolean — True if the store accepts card payment for delivery orders - `CashOrdersDeliveryEnabled` boolean — True if the store accepts cash payment for delivery orders - `CardOrdersPickupEnabled` boolean — True if the store accepts card payment for pickup orders - `CashOrdersPickupEnabled` boolean — True if the store accepts cash payment for pickup orders - `TipsEnabled` boolean — True if the store accepts tips - `AutomaticallyAcceptOrders` boolean — True if the stores orders are automatically accepted in Flipdish - `OpenForDelivery` boolean — True if the store is open for delivery - `OpenForPickup` boolean — True if the store is open for pickup - `MinimumPickupOrderAmount` number, double — Minimum pickup order amount - `RequireCustomerNameForPickup` boolean — True if customer name required for pickup orders - `GdprCustomerPhoneNumbers` boolean — Mask your customers phone numbers printed on receipts and reduce the amout of personally identifiable customer information that is exposed. - `RequireCustomerNameForDelivery` boolean — True if customer name required for delivery orders - `AllowChefNotes` boolean — True if the customer is allowed enter custom notes with their orders - `EtaInPickupConfirmationSmsEnabled` boolean — True if order confirmation sms includes estimated time when order will be ready for collection - `EtaInDeliveryConfirmationSmsEnabled` boolean — True if order confirmation sms includes estimated time when order will delivered - `IsArchived` boolean — Is the Store Archived - `IsPublished` boolean — Is the Store Published - `Name` string — Name - `EmailAddress` string — Email address (visible to customers) - `StaffLanguage` string — Staff Language (used for communication with the staff) Emails, Printouts etc - `SalesChannelTypes` string[] — Sales Channel Types - `InheritanceConfigTypes` string[] — Inheritance Config Types - `FlipdishEventId` string, uuid — The identitfier of the event - `CreateTime` string, date-time — The time of creation of the event - `Position` integer — Position - `AppId` string — App id - `IpAddress` string — Ip Address - `ActivityId` string — Activity Id - `ActivityType` string — Activity Type - `StoreDeletedEvent` StoreDeletedEvent[] — Store deleted events - `EventName` string — The event name - `StoreId` integer — Store Id - `StoreGroupId` integer — Store group Id - `User` UserEventInfo — User Event Info - `UserId` integer — User Id - `UserName` string — User Name - `UserPhoneNumber` string — User Phone Number - `UserEmail` string — User Email - `Description` string — Description - `Store` Store — Store - `StoreId` integer — Store identifier - `StoreGroupId` integer — Store group id to which this store belongs - `Address` StoreAddress — Store address - `AddressId` integer — Address identifier - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `Line1` string — Address line 1 - `Postcode` string — Postcode - `City` string — City - `CountryCode` string — Country code (ISO-alpha2) - `DisplayForCustomer` string — Display for customer - `AddressFields` object — Dyanmic field/value pairs, defined by the form assigned to the given country code. - `SingleLineDisplay` string — Single line display i18n, may be empty for not supported countries - `TwoLinesDisplay` string[] — Two line display i18n, may be empty for not supported countries - `DeliveryZones` DeliveryZone[] — Delivery zones - `Id` integer — Delivery Fee Area Id - `FeeChargedToStore` number, double, nullable — Delivery Fee charged to store - `DeliveryFee` number, double — Delivery fee (will not be set below 0) - `MinimumDeliveryOrderAmount` number, double — Minimum delivery order amount (will not be set below 0) - `WellKnownText` string — Spatial data in Well Known Text format We also support CIRCLE((0 0, 200)) - (centerLong centerLat, radius in m) - `IsEnabled` boolean — Is delivery zone enabled - `ApmPhoneNumber` string — Automated Phone Marketing number - `PickupHours` BusinessHoursPeriod[] — Pickup hours - `Early` Range — A class that represents a single opening period in a day. This starts 'StartTime' after midnight and runs for a 'Period' after that, on the given DayOfWeek. - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `Late` Range — A class that represents a single opening period in a day. This starts 'StartTime' after midnight and runs for a 'Period' after that, on the given DayOfWeek. - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `Ranges` Range[] — Ranges - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `StartTime` string — Start time - `Period` string — Period - `StartTimeEarly` string — Start time early - `PeriodEarly` string — Period early - `DeliveryHours` BusinessHoursPeriod[] — Delivery hours - `Early` Range — A class that represents a single opening period in a day. This starts 'StartTime' after midnight and runs for a 'Period' after that, on the given DayOfWeek. - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `Late` Range — A class that represents a single opening period in a day. This starts 'StartTime' after midnight and runs for a 'Period' after that, on the given DayOfWeek. - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `Ranges` Range[] — Ranges - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `StartTime` string — Start time - `Period` string — Period - `StartTimeEarly` string — Start time early - `PeriodEarly` string — Period early - `MenuId` integer — Menu identifier - `OrderConfirmationMessageOverrideDelivery` string — Overridden confirmation message for delivery orders - `OrderConfirmationMessageOverridePickup` string — Overridden confirmation message for pickup orders - `PrintoutLayoutType` 'Default' | 'Centra' | 'SmallChefNotes' | 'SmallChefNotesAndCentra', nullable — Printout layout - `StoreNotes` StoreNote[] — Store notes - `UserId` integer — User identifier - `CreateTime` string, date-time — Create time - `Note` string — Note - `MicrosoftTimeZone` string — Microsoft Time Zone Index Values (https://msdn.microsoft.com/en-us/library/ms912391) (Editable through store coordinate change) - `IanaTimeZone` string — IANA Time Zone (https://www.iana.org/time-zones) (Editable through store coordinate change) - `Currency` 'EUR' | 'USD' | 'GBP' | 'CAD' | 'AUD' | 'DJF' | 'ZAR' | 'ETB' | 'AED' | 'BHD' | 'DZD' | 'EGP' | 'IQD' | 'JOD' | 'KWD' | 'LBP' | 'LYD' | 'MAD' | 'OMR' | 'QAR' | 'SAR' | 'SYP' | 'TND' | 'YER' | 'CLP' | 'INR' | 'AZN' | 'RUB' | 'BYN' | 'BGN' | 'NGN' | 'BDT' | 'CNY' | 'BAM' | 'CZK' | 'DKK' | 'CHF' | 'MVR' | 'BTN' | 'XCD' | 'BZD' | 'HKD' | 'IDR' | 'JMD' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'TTD' | 'XDR' | 'ARS' | 'BOB' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PEN' | 'PYG' | 'UYU' | 'VEF' | 'IRR' | 'XOF' | 'CDF' | 'XAF' | 'HTG' | 'ILS' | 'HRK' | 'HUF' | 'AMD' | 'ISK' | 'JPY' | 'GEL' | 'KZT' | 'KHR' | 'KRW' | 'KGS' | 'LAK' | 'MKD' | 'MNT' | 'BND' | 'MMK' | 'NOK' | 'NPR' | 'PKR' | 'PLN' | 'AFN' | 'BRL' | 'MDL' | 'RON' | 'RWF' | 'SEK' | 'LKR' | 'SOS' | 'ALL' | 'RSD' | 'KES' | 'TJS' | 'THB' | 'ERN' | 'TMT' | 'BWP' | 'TRY' | 'UAH' | 'UZS' | 'VND' | 'MOP' | 'TWD' | 'BMD' — Currency (derived from Store Group) - `PreOrderDeliveryEnabled` boolean — Is PerOrder Enabled for Delivery - `PreOrderPickupEnabled` boolean — Is PerOrder Enabled for Pickup - `LogoUrl` string — Url for logo image - `FraudPreventionStrategy` string — Fraud Prevention Strategy - `AppIds` string[] — Store's app ids - `PropertyId` string — Property Id - `PhoneNumber` string — Phone number - `AlwaysAppearOpen` boolean — True if the store always appears open - `PreOrderEnabled` boolean — True if the store accepts pre-orders - `TakeOutEnabled` boolean — True if the store accepts take-out orders - `TableServiceEnabled` boolean — True if the store has table service - `DineInEnabled` boolean — True if the store accepts dine-in orders - `AllowPreOrdersAndTableService` boolean — True if both pre-orders and talbe service can be enabled - `PickupEnabled` boolean — True if the store accepts pickup orders - `DeliveryEnabled` boolean — True if the store accepts delivery orders - `CardOrderDeliveryEnabled` boolean — True if the store accepts card payment for delivery orders - `CashOrdersDeliveryEnabled` boolean — True if the store accepts cash payment for delivery orders - `CardOrdersPickupEnabled` boolean — True if the store accepts card payment for pickup orders - `CashOrdersPickupEnabled` boolean — True if the store accepts cash payment for pickup orders - `TipsEnabled` boolean — True if the store accepts tips - `AutomaticallyAcceptOrders` boolean — True if the stores orders are automatically accepted in Flipdish - `OpenForDelivery` boolean — True if the store is open for delivery - `OpenForPickup` boolean — True if the store is open for pickup - `MinimumPickupOrderAmount` number, double — Minimum pickup order amount - `RequireCustomerNameForPickup` boolean — True if customer name required for pickup orders - `GdprCustomerPhoneNumbers` boolean — Mask your customers phone numbers printed on receipts and reduce the amout of personally identifiable customer information that is exposed. - `RequireCustomerNameForDelivery` boolean — True if customer name required for delivery orders - `AllowChefNotes` boolean — True if the customer is allowed enter custom notes with their orders - `EtaInPickupConfirmationSmsEnabled` boolean — True if order confirmation sms includes estimated time when order will be ready for collection - `EtaInDeliveryConfirmationSmsEnabled` boolean — True if order confirmation sms includes estimated time when order will delivered - `IsArchived` boolean — Is the Store Archived - `IsPublished` boolean — Is the Store Published - `Name` string — Name - `EmailAddress` string — Email address (visible to customers) - `StaffLanguage` string — Staff Language (used for communication with the staff) Emails, Printouts etc - `SalesChannelTypes` string[] — Sales Channel Types - `InheritanceConfigTypes` string[] — Inheritance Config Types - `FlipdishEventId` string, uuid — The identitfier of the event - `CreateTime` string, date-time — The time of creation of the event - `Position` integer — Position - `AppId` string — App id - `OrgId` string — Org id - `IpAddress` string — Ip Address - `ActivityId` string — Activity Id - `ActivityType` string — Activity Type - `StoreAddressUpdatedEvent` StoreAddressUpdatedEvent[] — Store address updated events - `EventName` string — The event name - `OrgId` string — Organisation Id - `StoreId` integer — Store Id - `StoreGroupId` integer — Store group Id - … truncated; see the full OpenAPI document linked below ## Other responses - `400` — BadRequest - `401` — Authentication has been denied for this request. - `403` — Successful authentication, but authorization has been denied for this request. --- [API](https://skmtc.net/flipdish/apis/flipdish-open-api-v1-0.md) · [All operations](https://skmtc.net/flipdish/apis/flipdish-open-api-v1-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flipdish/flipdish-open-api-v1-0/versions/a72c0465da74/schema)