openapi: 3.0.3 info: title: Flipdish API - Apps Accounts Events API version: v1.0 description: Flipdish Open API v1.0 — Apps operations. Flipdish is an online ordering and branded-app platform for restaurants and takeaways. This specification was derived from the official Flipdish Swagger document and grouped by resource domain. contact: name: Flipdish Support email: help@flipdish.com url: https://help.flipdish.com x-generated-from: https://api.flipdish.co/swagger/docs/v1.0 x-last-validated: '2026-06-02' servers: - url: https://api.flipdish.co description: Flipdish production API security: - oauth2: - api tags: - name: Events description: Operations for Events. paths: /api/v1.0/{appId}/events/{eventId}: get: tags: - Events operationId: GetEventsById parameters: - name: eventId in: path required: true schema: type: string format: uuid description: The event id path parameter. example: '500123' - name: appId in: path required: true schema: type: string description: The app id path parameter. example: '500123' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EventSearchResult' examples: GetEventsById200Example: summary: Default GetEventsById 200 response x-microcks-default: true value: AppCreatedEvent: [] AppUpdatedEvent: [] AnalyticsClientEvent: [] OrderAcceptedEvent: [] OrderDispatchedEvent: [] OrderCustomerTrackingCreatedEvent: [] OrderDeliveryTrackingStatusUpdatedEvent: [] OrderBatchPublishedEvent: [] OrderCreatedEvent: [] OrderRatingUpdatedEvent: [] OrderRefundedEvent: [] OrderRejectedEvent: [] OrderTipUpdatedEvent: [] OrderTerminalNotifications: [] StoreCreatedEvent: [] StoreDeletedEvent: [] StoreAddressUpdatedEvent: [] StoreKioskSettingUpdatedEvent: [] DeliveryZoneCreatedEvent: [] DeliveryZoneUpdatedEvent: [] DeliveryZoneDeletedEvent: [] StoreOpeningHoursUpdatedEvent: [] StoreMenuAssignedEvent: [] StoreBusinessHoursOverrideCreatedEvent: [] StoreBusinessHoursOverrideDeletedEvent: [] StoreArchivedEvent: [] StoreUnarchivedEvent: [] StorePublishedEvent: [] StoreUnpublishedEvent: [] StoreUpdatedEvent: [] StorePreOrderConfigUpdatedEvent: [] StoreLogoCreatedEvent: [] StoreLogoUpdatedEvent: [] StoreLogoDeletedEvent: [] MenuCreatedEvent: [] MenuAsyncCreationCompletedEvent: [] MenuUpdatedEvent: [] MenuUploadedEvent: [] MenuBulkEditEvent: [] MenuSectionCreatedEvent: [] MenuSectionUpdatedEvent: [] MenuSectionDeletedEvent: [] MenuSectionItemCreatedEvent: [] MenuSectionItemUpdatedEvent: [] MenuSectionItemDeletedEvent: [] MenuItemOptionSetCreatedEvent: [] MenuItemOptionSetUpdatedEvent: [] MenuItemOptionSetDeletedEvent: [] MenuItemOptionSetItemCreatedEvent: [] MenuItemOptionSetItemUpdatedEvent: [] MenuItemOptionSetItemDeletedEvent: [] MenuCheckpointCreatedEvent: [] StoreGroupCreatedEvent: [] StoreGroupUpdatedEvent: [] StoreGroupDeletedEvent: [] CustomerCreatedEvent: [] CustomerUpdatedEvent: [] CustomerConsentUpdatedEvent: [] WebhookSubscriptionCreatedEvent: [] WebhookSubscriptionUpdatedEvent: [] WebhookSubscriptionDeletedEvent: [] PrinterTurnedOnEvent: [] PrinterTurnedOffEvent: [] PrinterAssignedToStoreEvent: [] PrinterUnassignedFromStoreEvent: [] PhoneCallStartedEvent: [] PhoneCallEndedEvent: [] TelephonyConfigUpdatedEvent: [] ChannelStoresUpdatedEvent: [] LoyaltyCampaignCreatedEvent: [] LoyaltyCampaignDeletedEvent: [] LoyaltyCampaignUpdatedEvent: [] RetentionCampaignCreatedEvent: [] RetentionCampaignDeletedEvent: [] RetentionCampaignUpdatedEvent: [] SmsReceivedEvent: [] UserLoginEvent: [] UserCreatedEvent: [] UserUpdatedEvent: [] UserDeletedEvent: [] UserCreatedPasswordEvent: [] UserAnsweredSignupQuestionsEvent: [] VoucherCreatedEvent: [] VoucherUpdatedEvent: [] VoucherDeletedEvent: [] VoucherAppliedEvent: [] TeammateInviteSentEvent: [] TeammateInviteAcceptedEvent: [] TeammateUpdatedEvent: [] TeammateDeletedEvent: [] BankAccountCreatedEvent: [] BankAccountUpdatedEvent: [] BankAccountDeletedEvent: [] BankAccountAssignedEvent: [] HydraAssignedEvent: [] HydraRequestResetEvent: [] HydraStoreAssignedEvent: [] HydraStoreUnassignedEvent: [] HydraSettingChangedEvent: [] HydraUnAssignedEvent: [] HydraConnectionStatusChangedEvent: [] KioskBluetoothPairingModeEvent: [] KioskBluetoothUnpairingModeEvent: [] KioskBluetoothTerminalUnpairedEvent: [] KioskTerminalActionStateChangedEvent: [] KioskBluetoothTerminalUpdatedEvent: [] KioskBluetoothTerminalInitiateUpdateCheckEvent: [] KioskBluetoothInstallUpdateInitiateEvent: [] KioskBluetoothTerminalCancelUpdateEvent: [] KioskBluetoothTerminalFirmwareVersionStatusEvent: [] KioskBluetoothTerminalInstallationStatusEvent: [] PushNotificationScheduledEvent: [] PushNotificationSentEvent: [] PushNotificationDeletedEvent: [] DnsVerifiedEvent: [] CertificateCreatedEvent: [] CertificateRenewedEvent: [] WebsiteVanityUrlUpdatedEvent: [] WebsiteUpdatedEvent: [] OrderCapacityUpdatedEvent: [] ExternalStoreEvent: [] OrderFulfillmentStatusUpdatedEvent: [] AppStoreConfigCreatedEvent: [] AppStoreConfigUpdatedEvent: [] AppStoreConfigDeletedEvent: [] AppStoreSubscriptionChangeJobUpdatedEvent: [] CatalogItemCreatedEvent: [] CatalogItemUpdatedEvent: [] CatalogItemArchivedEvent: [] CatalogGroupCreatedEvent: [] CatalogGroupUpdatedEvent: [] CatalogGroupArchivedEvent: [] StoreTipUpdatedEvent: [] LocationAreaCreatedEvent: [] LocationAreaUpdatedEvent: [] LocationCreatedEvent: [] LocationDeletedEvent: [] StoreServiceChargeUpdatedEvent: [] MobileAppsSubmissionStatusUpdatedEvent: [] MobileAppsSubmissionUpdatedEvent: [] StoreFeeConfigUpdatedEvent: [] '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetEventsById400Example: summary: Default GetEventsById 400 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '401': description: Authentication has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetEventsById401Example: summary: Default GetEventsById 401 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '403': description: Successful authentication, but authorization has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetEventsById403Example: summary: Default GetEventsById 403 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetEventsById500Example: summary: Default GetEventsById 500 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. security: - oauth2: - api summary: Flipdish Get Events by Id description: Get Events by Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/{eventId}). x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1.0/{appId}/events/menu/{menuId}: get: tags: - Events operationId: GetMenuEvents parameters: - name: appId in: path required: true schema: type: string description: The app id path parameter. example: '500123' - name: menuId in: path required: true schema: type: integer format: int32 description: The menu id path parameter. example: 500123 - name: limit in: query description: The maximum elements to return required: false schema: type: integer format: int32 example: 1 - name: page in: query description: The index of the page to return, starting by 1 required: false schema: type: integer format: int32 example: 1 - name: start in: query description: Start date required: false x-nullable: true schema: type: string format: date-time example: '2026-06-02T12:00:00Z' - name: end in: query description: End date required: false x-nullable: true schema: type: string format: date-time example: '2026-06-02T12:00:00Z' - name: orderId in: query description: Events that have Order Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: storeId in: query description: Events that have Store Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: storeIdList in: query description: Events that have Store Id List required: false explode: true schema: type: array items: type: integer format: int32 example: - 1 - name: storeGroupId in: query description: Events that have Store Group Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: userId in: query description: Events that have User Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: menuId in: query description: Events that have Menu Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: campaignId in: query description: Events that have Campaign Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: userEmail in: query description: Events that have User Email required: false schema: type: string example: owner@example.com - name: userName in: query description: Events that have User Name required: false schema: type: string example: Example Name - name: voucherCode in: query description: Events that have voucher code required: false schema: type: string example: string - name: eventType in: query description: Events that have event type\s required: false explode: true schema: type: array items: type: string example: - string - name: flipdishEventId in: query description: Unique Identifier of Event, if this is specified, all other criteria are ignored. required: false schema: type: string example: '500123' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RestApiEventSearchPaginationResult' examples: GetMenuEvents200Example: summary: Default GetMenuEvents 200 response x-microcks-default: true value: Data: AppCreatedEvent: [] AppUpdatedEvent: [] AnalyticsClientEvent: [] OrderAcceptedEvent: [] OrderDispatchedEvent: [] OrderCustomerTrackingCreatedEvent: [] OrderDeliveryTrackingStatusUpdatedEvent: [] OrderBatchPublishedEvent: [] OrderCreatedEvent: [] OrderRatingUpdatedEvent: [] OrderRefundedEvent: [] OrderRejectedEvent: [] OrderTipUpdatedEvent: [] OrderTerminalNotifications: [] StoreCreatedEvent: [] StoreDeletedEvent: [] StoreAddressUpdatedEvent: [] StoreKioskSettingUpdatedEvent: [] DeliveryZoneCreatedEvent: [] DeliveryZoneUpdatedEvent: [] DeliveryZoneDeletedEvent: [] StoreOpeningHoursUpdatedEvent: [] StoreMenuAssignedEvent: [] StoreBusinessHoursOverrideCreatedEvent: [] StoreBusinessHoursOverrideDeletedEvent: [] StoreArchivedEvent: [] StoreUnarchivedEvent: [] StorePublishedEvent: [] StoreUnpublishedEvent: [] StoreUpdatedEvent: [] StorePreOrderConfigUpdatedEvent: [] StoreLogoCreatedEvent: [] StoreLogoUpdatedEvent: [] StoreLogoDeletedEvent: [] MenuCreatedEvent: [] MenuAsyncCreationCompletedEvent: [] MenuUpdatedEvent: [] MenuUploadedEvent: [] MenuBulkEditEvent: [] MenuSectionCreatedEvent: [] MenuSectionUpdatedEvent: [] MenuSectionDeletedEvent: [] MenuSectionItemCreatedEvent: [] MenuSectionItemUpdatedEvent: [] MenuSectionItemDeletedEvent: [] MenuItemOptionSetCreatedEvent: [] MenuItemOptionSetUpdatedEvent: [] MenuItemOptionSetDeletedEvent: [] MenuItemOptionSetItemCreatedEvent: [] MenuItemOptionSetItemUpdatedEvent: [] MenuItemOptionSetItemDeletedEvent: [] MenuCheckpointCreatedEvent: [] StoreGroupCreatedEvent: [] StoreGroupUpdatedEvent: [] StoreGroupDeletedEvent: [] CustomerCreatedEvent: [] CustomerUpdatedEvent: [] CustomerConsentUpdatedEvent: [] WebhookSubscriptionCreatedEvent: [] WebhookSubscriptionUpdatedEvent: [] WebhookSubscriptionDeletedEvent: [] PrinterTurnedOnEvent: [] PrinterTurnedOffEvent: [] PrinterAssignedToStoreEvent: [] PrinterUnassignedFromStoreEvent: [] PhoneCallStartedEvent: [] PhoneCallEndedEvent: [] TelephonyConfigUpdatedEvent: [] ChannelStoresUpdatedEvent: [] LoyaltyCampaignCreatedEvent: [] LoyaltyCampaignDeletedEvent: [] LoyaltyCampaignUpdatedEvent: [] RetentionCampaignCreatedEvent: [] RetentionCampaignDeletedEvent: [] RetentionCampaignUpdatedEvent: [] SmsReceivedEvent: [] UserLoginEvent: [] UserCreatedEvent: [] UserUpdatedEvent: [] UserDeletedEvent: [] UserCreatedPasswordEvent: [] UserAnsweredSignupQuestionsEvent: [] VoucherCreatedEvent: [] VoucherUpdatedEvent: [] VoucherDeletedEvent: [] VoucherAppliedEvent: [] TeammateInviteSentEvent: [] TeammateInviteAcceptedEvent: [] TeammateUpdatedEvent: [] TeammateDeletedEvent: [] BankAccountCreatedEvent: [] BankAccountUpdatedEvent: [] BankAccountDeletedEvent: [] BankAccountAssignedEvent: [] HydraAssignedEvent: [] HydraRequestResetEvent: [] HydraStoreAssignedEvent: [] HydraStoreUnassignedEvent: [] HydraSettingChangedEvent: [] HydraUnAssignedEvent: [] HydraConnectionStatusChangedEvent: [] KioskBluetoothPairingModeEvent: [] KioskBluetoothUnpairingModeEvent: [] KioskBluetoothTerminalUnpairedEvent: [] KioskTerminalActionStateChangedEvent: [] KioskBluetoothTerminalUpdatedEvent: [] KioskBluetoothTerminalInitiateUpdateCheckEvent: [] KioskBluetoothInstallUpdateInitiateEvent: [] KioskBluetoothTerminalCancelUpdateEvent: [] KioskBluetoothTerminalFirmwareVersionStatusEvent: [] KioskBluetoothTerminalInstallationStatusEvent: [] PushNotificationScheduledEvent: [] PushNotificationSentEvent: [] PushNotificationDeletedEvent: [] DnsVerifiedEvent: [] CertificateCreatedEvent: [] CertificateRenewedEvent: [] WebsiteVanityUrlUpdatedEvent: [] WebsiteUpdatedEvent: [] OrderCapacityUpdatedEvent: [] ExternalStoreEvent: [] OrderFulfillmentStatusUpdatedEvent: [] AppStoreConfigCreatedEvent: [] AppStoreConfigUpdatedEvent: [] AppStoreConfigDeletedEvent: [] AppStoreSubscriptionChangeJobUpdatedEvent: [] CatalogItemCreatedEvent: [] CatalogItemUpdatedEvent: [] CatalogItemArchivedEvent: [] CatalogGroupCreatedEvent: [] CatalogGroupUpdatedEvent: [] CatalogGroupArchivedEvent: [] StoreTipUpdatedEvent: [] LocationAreaCreatedEvent: [] LocationAreaUpdatedEvent: [] LocationCreatedEvent: [] LocationDeletedEvent: [] StoreServiceChargeUpdatedEvent: [] MobileAppsSubmissionStatusUpdatedEvent: [] MobileAppsSubmissionUpdatedEvent: [] StoreFeeConfigUpdatedEvent: [] Page: 1 Limit: 1 TotalRecordCount: 12.5 '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetMenuEvents400Example: summary: Default GetMenuEvents 400 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '401': description: Authentication has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetMenuEvents401Example: summary: Default GetMenuEvents 401 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '403': description: Successful authentication, but authorization has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetMenuEvents403Example: summary: Default GetMenuEvents 403 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetMenuEvents500Example: summary: Default GetMenuEvents 500 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. security: - oauth2: - api summary: Flipdish Get Menu Events description: Get Menu Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/menu/{menuId}). x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1.0/{appId}/events/user/{userId}: get: tags: - Events operationId: GetUserEvents parameters: - name: appId in: path required: true schema: type: string description: The app id path parameter. example: '500123' - name: userId in: path required: true schema: type: integer format: int32 description: The user id path parameter. example: 500123 - name: limit in: query description: The maximum elements to return required: false schema: type: integer format: int32 example: 1 - name: page in: query description: The index of the page to return, starting by 1 required: false schema: type: integer format: int32 example: 1 - name: start in: query description: Start date required: false x-nullable: true schema: type: string format: date-time example: '2026-06-02T12:00:00Z' - name: end in: query description: End date required: false x-nullable: true schema: type: string format: date-time example: '2026-06-02T12:00:00Z' - name: orderId in: query description: Events that have Order Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: storeId in: query description: Events that have Store Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: storeIdList in: query description: Events that have Store Id List required: false explode: true schema: type: array items: type: integer format: int32 example: - 1 - name: storeGroupId in: query description: Events that have Store Group Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: userId in: query description: Events that have User Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: menuId in: query description: Events that have Menu Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: campaignId in: query description: Events that have Campaign Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: userEmail in: query description: Events that have User Email required: false schema: type: string example: owner@example.com - name: userName in: query description: Events that have User Name required: false schema: type: string example: Example Name - name: voucherCode in: query description: Events that have voucher code required: false schema: type: string example: string - name: eventType in: query description: Events that have event type\s required: false explode: true schema: type: array items: type: string example: - string - name: flipdishEventId in: query description: Unique Identifier of Event, if this is specified, all other criteria are ignored. required: false schema: type: string example: '500123' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RestApiEventSearchPaginationResult' examples: GetUserEvents200Example: summary: Default GetUserEvents 200 response x-microcks-default: true value: Data: AppCreatedEvent: [] AppUpdatedEvent: [] AnalyticsClientEvent: [] OrderAcceptedEvent: [] OrderDispatchedEvent: [] OrderCustomerTrackingCreatedEvent: [] OrderDeliveryTrackingStatusUpdatedEvent: [] OrderBatchPublishedEvent: [] OrderCreatedEvent: [] OrderRatingUpdatedEvent: [] OrderRefundedEvent: [] OrderRejectedEvent: [] OrderTipUpdatedEvent: [] OrderTerminalNotifications: [] StoreCreatedEvent: [] StoreDeletedEvent: [] StoreAddressUpdatedEvent: [] StoreKioskSettingUpdatedEvent: [] DeliveryZoneCreatedEvent: [] DeliveryZoneUpdatedEvent: [] DeliveryZoneDeletedEvent: [] StoreOpeningHoursUpdatedEvent: [] StoreMenuAssignedEvent: [] StoreBusinessHoursOverrideCreatedEvent: [] StoreBusinessHoursOverrideDeletedEvent: [] StoreArchivedEvent: [] StoreUnarchivedEvent: [] StorePublishedEvent: [] StoreUnpublishedEvent: [] StoreUpdatedEvent: [] StorePreOrderConfigUpdatedEvent: [] StoreLogoCreatedEvent: [] StoreLogoUpdatedEvent: [] StoreLogoDeletedEvent: [] MenuCreatedEvent: [] MenuAsyncCreationCompletedEvent: [] MenuUpdatedEvent: [] MenuUploadedEvent: [] MenuBulkEditEvent: [] MenuSectionCreatedEvent: [] MenuSectionUpdatedEvent: [] MenuSectionDeletedEvent: [] MenuSectionItemCreatedEvent: [] MenuSectionItemUpdatedEvent: [] MenuSectionItemDeletedEvent: [] MenuItemOptionSetCreatedEvent: [] MenuItemOptionSetUpdatedEvent: [] MenuItemOptionSetDeletedEvent: [] MenuItemOptionSetItemCreatedEvent: [] MenuItemOptionSetItemUpdatedEvent: [] MenuItemOptionSetItemDeletedEvent: [] MenuCheckpointCreatedEvent: [] StoreGroupCreatedEvent: [] StoreGroupUpdatedEvent: [] StoreGroupDeletedEvent: [] CustomerCreatedEvent: [] CustomerUpdatedEvent: [] CustomerConsentUpdatedEvent: [] WebhookSubscriptionCreatedEvent: [] WebhookSubscriptionUpdatedEvent: [] WebhookSubscriptionDeletedEvent: [] PrinterTurnedOnEvent: [] PrinterTurnedOffEvent: [] PrinterAssignedToStoreEvent: [] PrinterUnassignedFromStoreEvent: [] PhoneCallStartedEvent: [] PhoneCallEndedEvent: [] TelephonyConfigUpdatedEvent: [] ChannelStoresUpdatedEvent: [] LoyaltyCampaignCreatedEvent: [] LoyaltyCampaignDeletedEvent: [] LoyaltyCampaignUpdatedEvent: [] RetentionCampaignCreatedEvent: [] RetentionCampaignDeletedEvent: [] RetentionCampaignUpdatedEvent: [] SmsReceivedEvent: [] UserLoginEvent: [] UserCreatedEvent: [] UserUpdatedEvent: [] UserDeletedEvent: [] UserCreatedPasswordEvent: [] UserAnsweredSignupQuestionsEvent: [] VoucherCreatedEvent: [] VoucherUpdatedEvent: [] VoucherDeletedEvent: [] VoucherAppliedEvent: [] TeammateInviteSentEvent: [] TeammateInviteAcceptedEvent: [] TeammateUpdatedEvent: [] TeammateDeletedEvent: [] BankAccountCreatedEvent: [] BankAccountUpdatedEvent: [] BankAccountDeletedEvent: [] BankAccountAssignedEvent: [] HydraAssignedEvent: [] HydraRequestResetEvent: [] HydraStoreAssignedEvent: [] HydraStoreUnassignedEvent: [] HydraSettingChangedEvent: [] HydraUnAssignedEvent: [] HydraConnectionStatusChangedEvent: [] KioskBluetoothPairingModeEvent: [] KioskBluetoothUnpairingModeEvent: [] KioskBluetoothTerminalUnpairedEvent: [] KioskTerminalActionStateChangedEvent: [] KioskBluetoothTerminalUpdatedEvent: [] KioskBluetoothTerminalInitiateUpdateCheckEvent: [] KioskBluetoothInstallUpdateInitiateEvent: [] KioskBluetoothTerminalCancelUpdateEvent: [] KioskBluetoothTerminalFirmwareVersionStatusEvent: [] KioskBluetoothTerminalInstallationStatusEvent: [] PushNotificationScheduledEvent: [] PushNotificationSentEvent: [] PushNotificationDeletedEvent: [] DnsVerifiedEvent: [] CertificateCreatedEvent: [] CertificateRenewedEvent: [] WebsiteVanityUrlUpdatedEvent: [] WebsiteUpdatedEvent: [] OrderCapacityUpdatedEvent: [] ExternalStoreEvent: [] OrderFulfillmentStatusUpdatedEvent: [] AppStoreConfigCreatedEvent: [] AppStoreConfigUpdatedEvent: [] AppStoreConfigDeletedEvent: [] AppStoreSubscriptionChangeJobUpdatedEvent: [] CatalogItemCreatedEvent: [] CatalogItemUpdatedEvent: [] CatalogItemArchivedEvent: [] CatalogGroupCreatedEvent: [] CatalogGroupUpdatedEvent: [] CatalogGroupArchivedEvent: [] StoreTipUpdatedEvent: [] LocationAreaCreatedEvent: [] LocationAreaUpdatedEvent: [] LocationCreatedEvent: [] LocationDeletedEvent: [] StoreServiceChargeUpdatedEvent: [] MobileAppsSubmissionStatusUpdatedEvent: [] MobileAppsSubmissionUpdatedEvent: [] StoreFeeConfigUpdatedEvent: [] Page: 1 Limit: 1 TotalRecordCount: 12.5 '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetUserEvents400Example: summary: Default GetUserEvents 400 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '401': description: Authentication has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetUserEvents401Example: summary: Default GetUserEvents 401 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '403': description: Successful authentication, but authorization has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetUserEvents403Example: summary: Default GetUserEvents 403 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetUserEvents500Example: summary: Default GetUserEvents 500 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. security: - oauth2: - api summary: Flipdish Get User Events description: Get User Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/user/{userId}). x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1.0/{appId}/events/order/{orderId}: get: tags: - Events operationId: GetOrderEvents parameters: - name: appId in: path required: true schema: type: string description: The app id path parameter. example: '500123' - name: orderId in: path required: true schema: type: integer format: int32 description: The order id path parameter. example: 500123 - name: limit in: query description: The maximum elements to return required: false schema: type: integer format: int32 example: 1 - name: page in: query description: The index of the page to return, starting by 1 required: false schema: type: integer format: int32 example: 1 - name: start in: query description: Start date required: false x-nullable: true schema: type: string format: date-time example: '2026-06-02T12:00:00Z' - name: end in: query description: End date required: false x-nullable: true schema: type: string format: date-time example: '2026-06-02T12:00:00Z' - name: orderId in: query description: Events that have Order Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: storeId in: query description: Events that have Store Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: storeIdList in: query description: Events that have Store Id List required: false explode: true schema: type: array items: type: integer format: int32 example: - 1 - name: storeGroupId in: query description: Events that have Store Group Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: userId in: query description: Events that have User Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: menuId in: query description: Events that have Menu Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: campaignId in: query description: Events that have Campaign Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: userEmail in: query description: Events that have User Email required: false schema: type: string example: owner@example.com - name: userName in: query description: Events that have User Name required: false schema: type: string example: Example Name - name: voucherCode in: query description: Events that have voucher code required: false schema: type: string example: string - name: eventType in: query description: Events that have event type\s required: false explode: true schema: type: array items: type: string example: - string - name: flipdishEventId in: query description: Unique Identifier of Event, if this is specified, all other criteria are ignored. required: false schema: type: string example: '500123' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RestApiEventSearchPaginationResult' examples: GetOrderEvents200Example: summary: Default GetOrderEvents 200 response x-microcks-default: true value: Data: AppCreatedEvent: [] AppUpdatedEvent: [] AnalyticsClientEvent: [] OrderAcceptedEvent: [] OrderDispatchedEvent: [] OrderCustomerTrackingCreatedEvent: [] OrderDeliveryTrackingStatusUpdatedEvent: [] OrderBatchPublishedEvent: [] OrderCreatedEvent: [] OrderRatingUpdatedEvent: [] OrderRefundedEvent: [] OrderRejectedEvent: [] OrderTipUpdatedEvent: [] OrderTerminalNotifications: [] StoreCreatedEvent: [] StoreDeletedEvent: [] StoreAddressUpdatedEvent: [] StoreKioskSettingUpdatedEvent: [] DeliveryZoneCreatedEvent: [] DeliveryZoneUpdatedEvent: [] DeliveryZoneDeletedEvent: [] StoreOpeningHoursUpdatedEvent: [] StoreMenuAssignedEvent: [] StoreBusinessHoursOverrideCreatedEvent: [] StoreBusinessHoursOverrideDeletedEvent: [] StoreArchivedEvent: [] StoreUnarchivedEvent: [] StorePublishedEvent: [] StoreUnpublishedEvent: [] StoreUpdatedEvent: [] StorePreOrderConfigUpdatedEvent: [] StoreLogoCreatedEvent: [] StoreLogoUpdatedEvent: [] StoreLogoDeletedEvent: [] MenuCreatedEvent: [] MenuAsyncCreationCompletedEvent: [] MenuUpdatedEvent: [] MenuUploadedEvent: [] MenuBulkEditEvent: [] MenuSectionCreatedEvent: [] MenuSectionUpdatedEvent: [] MenuSectionDeletedEvent: [] MenuSectionItemCreatedEvent: [] MenuSectionItemUpdatedEvent: [] MenuSectionItemDeletedEvent: [] MenuItemOptionSetCreatedEvent: [] MenuItemOptionSetUpdatedEvent: [] MenuItemOptionSetDeletedEvent: [] MenuItemOptionSetItemCreatedEvent: [] MenuItemOptionSetItemUpdatedEvent: [] MenuItemOptionSetItemDeletedEvent: [] MenuCheckpointCreatedEvent: [] StoreGroupCreatedEvent: [] StoreGroupUpdatedEvent: [] StoreGroupDeletedEvent: [] CustomerCreatedEvent: [] CustomerUpdatedEvent: [] CustomerConsentUpdatedEvent: [] WebhookSubscriptionCreatedEvent: [] WebhookSubscriptionUpdatedEvent: [] WebhookSubscriptionDeletedEvent: [] PrinterTurnedOnEvent: [] PrinterTurnedOffEvent: [] PrinterAssignedToStoreEvent: [] PrinterUnassignedFromStoreEvent: [] PhoneCallStartedEvent: [] PhoneCallEndedEvent: [] TelephonyConfigUpdatedEvent: [] ChannelStoresUpdatedEvent: [] LoyaltyCampaignCreatedEvent: [] LoyaltyCampaignDeletedEvent: [] LoyaltyCampaignUpdatedEvent: [] RetentionCampaignCreatedEvent: [] RetentionCampaignDeletedEvent: [] RetentionCampaignUpdatedEvent: [] SmsReceivedEvent: [] UserLoginEvent: [] UserCreatedEvent: [] UserUpdatedEvent: [] UserDeletedEvent: [] UserCreatedPasswordEvent: [] UserAnsweredSignupQuestionsEvent: [] VoucherCreatedEvent: [] VoucherUpdatedEvent: [] VoucherDeletedEvent: [] VoucherAppliedEvent: [] TeammateInviteSentEvent: [] TeammateInviteAcceptedEvent: [] TeammateUpdatedEvent: [] TeammateDeletedEvent: [] BankAccountCreatedEvent: [] BankAccountUpdatedEvent: [] BankAccountDeletedEvent: [] BankAccountAssignedEvent: [] HydraAssignedEvent: [] HydraRequestResetEvent: [] HydraStoreAssignedEvent: [] HydraStoreUnassignedEvent: [] HydraSettingChangedEvent: [] HydraUnAssignedEvent: [] HydraConnectionStatusChangedEvent: [] KioskBluetoothPairingModeEvent: [] KioskBluetoothUnpairingModeEvent: [] KioskBluetoothTerminalUnpairedEvent: [] KioskTerminalActionStateChangedEvent: [] KioskBluetoothTerminalUpdatedEvent: [] KioskBluetoothTerminalInitiateUpdateCheckEvent: [] KioskBluetoothInstallUpdateInitiateEvent: [] KioskBluetoothTerminalCancelUpdateEvent: [] KioskBluetoothTerminalFirmwareVersionStatusEvent: [] KioskBluetoothTerminalInstallationStatusEvent: [] PushNotificationScheduledEvent: [] PushNotificationSentEvent: [] PushNotificationDeletedEvent: [] DnsVerifiedEvent: [] CertificateCreatedEvent: [] CertificateRenewedEvent: [] WebsiteVanityUrlUpdatedEvent: [] WebsiteUpdatedEvent: [] OrderCapacityUpdatedEvent: [] ExternalStoreEvent: [] OrderFulfillmentStatusUpdatedEvent: [] AppStoreConfigCreatedEvent: [] AppStoreConfigUpdatedEvent: [] AppStoreConfigDeletedEvent: [] AppStoreSubscriptionChangeJobUpdatedEvent: [] CatalogItemCreatedEvent: [] CatalogItemUpdatedEvent: [] CatalogItemArchivedEvent: [] CatalogGroupCreatedEvent: [] CatalogGroupUpdatedEvent: [] CatalogGroupArchivedEvent: [] StoreTipUpdatedEvent: [] LocationAreaCreatedEvent: [] LocationAreaUpdatedEvent: [] LocationCreatedEvent: [] LocationDeletedEvent: [] StoreServiceChargeUpdatedEvent: [] MobileAppsSubmissionStatusUpdatedEvent: [] MobileAppsSubmissionUpdatedEvent: [] StoreFeeConfigUpdatedEvent: [] Page: 1 Limit: 1 TotalRecordCount: 12.5 '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetOrderEvents400Example: summary: Default GetOrderEvents 400 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '401': description: Authentication has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetOrderEvents401Example: summary: Default GetOrderEvents 401 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '403': description: Successful authentication, but authorization has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetOrderEvents403Example: summary: Default GetOrderEvents 403 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetOrderEvents500Example: summary: Default GetOrderEvents 500 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. security: - oauth2: - api summary: Flipdish Get Order Events description: Get Order Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/order/{orderId}). x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1.0/{appId}/events/store/{storeId}: get: tags: - Events operationId: GetStoreEvents parameters: - name: appId in: path required: true schema: type: string description: The app id path parameter. example: '500123' - name: storeId in: path required: true schema: type: integer format: int32 description: The store id path parameter. example: 500123 - name: limit in: query description: The maximum elements to return required: false schema: type: integer format: int32 example: 1 - name: page in: query description: The index of the page to return, starting by 1 required: false schema: type: integer format: int32 example: 1 - name: start in: query description: Start date required: false x-nullable: true schema: type: string format: date-time example: '2026-06-02T12:00:00Z' - name: end in: query description: End date required: false x-nullable: true schema: type: string format: date-time example: '2026-06-02T12:00:00Z' - name: orderId in: query description: Events that have Order Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: storeId in: query description: Events that have Store Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: storeIdList in: query description: Events that have Store Id List required: false explode: true schema: type: array items: type: integer format: int32 example: - 1 - name: storeGroupId in: query description: Events that have Store Group Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: userId in: query description: Events that have User Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: menuId in: query description: Events that have Menu Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: campaignId in: query description: Events that have Campaign Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: userEmail in: query description: Events that have User Email required: false schema: type: string example: owner@example.com - name: userName in: query description: Events that have User Name required: false schema: type: string example: Example Name - name: voucherCode in: query description: Events that have voucher code required: false schema: type: string example: string - name: eventType in: query description: Events that have event type\s required: false explode: true schema: type: array items: type: string example: - string - name: flipdishEventId in: query description: Unique Identifier of Event, if this is specified, all other criteria are ignored. required: false schema: type: string example: '500123' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RestApiEventSearchPaginationResult' examples: GetStoreEvents200Example: summary: Default GetStoreEvents 200 response x-microcks-default: true value: Data: AppCreatedEvent: [] AppUpdatedEvent: [] AnalyticsClientEvent: [] OrderAcceptedEvent: [] OrderDispatchedEvent: [] OrderCustomerTrackingCreatedEvent: [] OrderDeliveryTrackingStatusUpdatedEvent: [] OrderBatchPublishedEvent: [] OrderCreatedEvent: [] OrderRatingUpdatedEvent: [] OrderRefundedEvent: [] OrderRejectedEvent: [] OrderTipUpdatedEvent: [] OrderTerminalNotifications: [] StoreCreatedEvent: [] StoreDeletedEvent: [] StoreAddressUpdatedEvent: [] StoreKioskSettingUpdatedEvent: [] DeliveryZoneCreatedEvent: [] DeliveryZoneUpdatedEvent: [] DeliveryZoneDeletedEvent: [] StoreOpeningHoursUpdatedEvent: [] StoreMenuAssignedEvent: [] StoreBusinessHoursOverrideCreatedEvent: [] StoreBusinessHoursOverrideDeletedEvent: [] StoreArchivedEvent: [] StoreUnarchivedEvent: [] StorePublishedEvent: [] StoreUnpublishedEvent: [] StoreUpdatedEvent: [] StorePreOrderConfigUpdatedEvent: [] StoreLogoCreatedEvent: [] StoreLogoUpdatedEvent: [] StoreLogoDeletedEvent: [] MenuCreatedEvent: [] MenuAsyncCreationCompletedEvent: [] MenuUpdatedEvent: [] MenuUploadedEvent: [] MenuBulkEditEvent: [] MenuSectionCreatedEvent: [] MenuSectionUpdatedEvent: [] MenuSectionDeletedEvent: [] MenuSectionItemCreatedEvent: [] MenuSectionItemUpdatedEvent: [] MenuSectionItemDeletedEvent: [] MenuItemOptionSetCreatedEvent: [] MenuItemOptionSetUpdatedEvent: [] MenuItemOptionSetDeletedEvent: [] MenuItemOptionSetItemCreatedEvent: [] MenuItemOptionSetItemUpdatedEvent: [] MenuItemOptionSetItemDeletedEvent: [] MenuCheckpointCreatedEvent: [] StoreGroupCreatedEvent: [] StoreGroupUpdatedEvent: [] StoreGroupDeletedEvent: [] CustomerCreatedEvent: [] CustomerUpdatedEvent: [] CustomerConsentUpdatedEvent: [] WebhookSubscriptionCreatedEvent: [] WebhookSubscriptionUpdatedEvent: [] WebhookSubscriptionDeletedEvent: [] PrinterTurnedOnEvent: [] PrinterTurnedOffEvent: [] PrinterAssignedToStoreEvent: [] PrinterUnassignedFromStoreEvent: [] PhoneCallStartedEvent: [] PhoneCallEndedEvent: [] TelephonyConfigUpdatedEvent: [] ChannelStoresUpdatedEvent: [] LoyaltyCampaignCreatedEvent: [] LoyaltyCampaignDeletedEvent: [] LoyaltyCampaignUpdatedEvent: [] RetentionCampaignCreatedEvent: [] RetentionCampaignDeletedEvent: [] RetentionCampaignUpdatedEvent: [] SmsReceivedEvent: [] UserLoginEvent: [] UserCreatedEvent: [] UserUpdatedEvent: [] UserDeletedEvent: [] UserCreatedPasswordEvent: [] UserAnsweredSignupQuestionsEvent: [] VoucherCreatedEvent: [] VoucherUpdatedEvent: [] VoucherDeletedEvent: [] VoucherAppliedEvent: [] TeammateInviteSentEvent: [] TeammateInviteAcceptedEvent: [] TeammateUpdatedEvent: [] TeammateDeletedEvent: [] BankAccountCreatedEvent: [] BankAccountUpdatedEvent: [] BankAccountDeletedEvent: [] BankAccountAssignedEvent: [] HydraAssignedEvent: [] HydraRequestResetEvent: [] HydraStoreAssignedEvent: [] HydraStoreUnassignedEvent: [] HydraSettingChangedEvent: [] HydraUnAssignedEvent: [] HydraConnectionStatusChangedEvent: [] KioskBluetoothPairingModeEvent: [] KioskBluetoothUnpairingModeEvent: [] KioskBluetoothTerminalUnpairedEvent: [] KioskTerminalActionStateChangedEvent: [] KioskBluetoothTerminalUpdatedEvent: [] KioskBluetoothTerminalInitiateUpdateCheckEvent: [] KioskBluetoothInstallUpdateInitiateEvent: [] KioskBluetoothTerminalCancelUpdateEvent: [] KioskBluetoothTerminalFirmwareVersionStatusEvent: [] KioskBluetoothTerminalInstallationStatusEvent: [] PushNotificationScheduledEvent: [] PushNotificationSentEvent: [] PushNotificationDeletedEvent: [] DnsVerifiedEvent: [] CertificateCreatedEvent: [] CertificateRenewedEvent: [] WebsiteVanityUrlUpdatedEvent: [] WebsiteUpdatedEvent: [] OrderCapacityUpdatedEvent: [] ExternalStoreEvent: [] OrderFulfillmentStatusUpdatedEvent: [] AppStoreConfigCreatedEvent: [] AppStoreConfigUpdatedEvent: [] AppStoreConfigDeletedEvent: [] AppStoreSubscriptionChangeJobUpdatedEvent: [] CatalogItemCreatedEvent: [] CatalogItemUpdatedEvent: [] CatalogItemArchivedEvent: [] CatalogGroupCreatedEvent: [] CatalogGroupUpdatedEvent: [] CatalogGroupArchivedEvent: [] StoreTipUpdatedEvent: [] LocationAreaCreatedEvent: [] LocationAreaUpdatedEvent: [] LocationCreatedEvent: [] LocationDeletedEvent: [] StoreServiceChargeUpdatedEvent: [] MobileAppsSubmissionStatusUpdatedEvent: [] MobileAppsSubmissionUpdatedEvent: [] StoreFeeConfigUpdatedEvent: [] Page: 1 Limit: 1 TotalRecordCount: 12.5 '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetStoreEvents400Example: summary: Default GetStoreEvents 400 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '401': description: Authentication has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetStoreEvents401Example: summary: Default GetStoreEvents 401 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '403': description: Successful authentication, but authorization has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetStoreEvents403Example: summary: Default GetStoreEvents 403 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetStoreEvents500Example: summary: Default GetStoreEvents 500 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. security: - oauth2: - api summary: Flipdish Get Store Events description: Get Store Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/store/{storeId}). x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1.0/{appId}/events/customer/{customerId}: get: tags: - Events operationId: GetCustomerEvents parameters: - name: appId in: path required: true schema: type: string description: The app id path parameter. example: '500123' - name: customerId in: path required: true schema: type: integer format: int32 description: The customer id path parameter. example: 500123 - name: limit in: query description: The maximum elements to return required: false schema: type: integer format: int32 example: 1 - name: page in: query description: The index of the page to return, starting by 1 required: false schema: type: integer format: int32 example: 1 - name: start in: query description: Start date required: false x-nullable: true schema: type: string format: date-time example: '2026-06-02T12:00:00Z' - name: end in: query description: End date required: false x-nullable: true schema: type: string format: date-time example: '2026-06-02T12:00:00Z' - name: orderId in: query description: Events that have Order Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: storeId in: query description: Events that have Store Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: storeIdList in: query description: Events that have Store Id List required: false explode: true schema: type: array items: type: integer format: int32 example: - 1 - name: storeGroupId in: query description: Events that have Store Group Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: userId in: query description: Events that have User Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: menuId in: query description: Events that have Menu Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: campaignId in: query description: Events that have Campaign Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: userEmail in: query description: Events that have User Email required: false schema: type: string example: owner@example.com - name: userName in: query description: Events that have User Name required: false schema: type: string example: Example Name - name: voucherCode in: query description: Events that have voucher code required: false schema: type: string example: string - name: eventType in: query description: Events that have event type\s required: false explode: true schema: type: array items: type: string example: - string - name: flipdishEventId in: query description: Unique Identifier of Event, if this is specified, all other criteria are ignored. required: false schema: type: string example: '500123' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RestApiEventSearchPaginationResult' examples: GetCustomerEvents200Example: summary: Default GetCustomerEvents 200 response x-microcks-default: true value: Data: AppCreatedEvent: [] AppUpdatedEvent: [] AnalyticsClientEvent: [] OrderAcceptedEvent: [] OrderDispatchedEvent: [] OrderCustomerTrackingCreatedEvent: [] OrderDeliveryTrackingStatusUpdatedEvent: [] OrderBatchPublishedEvent: [] OrderCreatedEvent: [] OrderRatingUpdatedEvent: [] OrderRefundedEvent: [] OrderRejectedEvent: [] OrderTipUpdatedEvent: [] OrderTerminalNotifications: [] StoreCreatedEvent: [] StoreDeletedEvent: [] StoreAddressUpdatedEvent: [] StoreKioskSettingUpdatedEvent: [] DeliveryZoneCreatedEvent: [] DeliveryZoneUpdatedEvent: [] DeliveryZoneDeletedEvent: [] StoreOpeningHoursUpdatedEvent: [] StoreMenuAssignedEvent: [] StoreBusinessHoursOverrideCreatedEvent: [] StoreBusinessHoursOverrideDeletedEvent: [] StoreArchivedEvent: [] StoreUnarchivedEvent: [] StorePublishedEvent: [] StoreUnpublishedEvent: [] StoreUpdatedEvent: [] StorePreOrderConfigUpdatedEvent: [] StoreLogoCreatedEvent: [] StoreLogoUpdatedEvent: [] StoreLogoDeletedEvent: [] MenuCreatedEvent: [] MenuAsyncCreationCompletedEvent: [] MenuUpdatedEvent: [] MenuUploadedEvent: [] MenuBulkEditEvent: [] MenuSectionCreatedEvent: [] MenuSectionUpdatedEvent: [] MenuSectionDeletedEvent: [] MenuSectionItemCreatedEvent: [] MenuSectionItemUpdatedEvent: [] MenuSectionItemDeletedEvent: [] MenuItemOptionSetCreatedEvent: [] MenuItemOptionSetUpdatedEvent: [] MenuItemOptionSetDeletedEvent: [] MenuItemOptionSetItemCreatedEvent: [] MenuItemOptionSetItemUpdatedEvent: [] MenuItemOptionSetItemDeletedEvent: [] MenuCheckpointCreatedEvent: [] StoreGroupCreatedEvent: [] StoreGroupUpdatedEvent: [] StoreGroupDeletedEvent: [] CustomerCreatedEvent: [] CustomerUpdatedEvent: [] CustomerConsentUpdatedEvent: [] WebhookSubscriptionCreatedEvent: [] WebhookSubscriptionUpdatedEvent: [] WebhookSubscriptionDeletedEvent: [] PrinterTurnedOnEvent: [] PrinterTurnedOffEvent: [] PrinterAssignedToStoreEvent: [] PrinterUnassignedFromStoreEvent: [] PhoneCallStartedEvent: [] PhoneCallEndedEvent: [] TelephonyConfigUpdatedEvent: [] ChannelStoresUpdatedEvent: [] LoyaltyCampaignCreatedEvent: [] LoyaltyCampaignDeletedEvent: [] LoyaltyCampaignUpdatedEvent: [] RetentionCampaignCreatedEvent: [] RetentionCampaignDeletedEvent: [] RetentionCampaignUpdatedEvent: [] SmsReceivedEvent: [] UserLoginEvent: [] UserCreatedEvent: [] UserUpdatedEvent: [] UserDeletedEvent: [] UserCreatedPasswordEvent: [] UserAnsweredSignupQuestionsEvent: [] VoucherCreatedEvent: [] VoucherUpdatedEvent: [] VoucherDeletedEvent: [] VoucherAppliedEvent: [] TeammateInviteSentEvent: [] TeammateInviteAcceptedEvent: [] TeammateUpdatedEvent: [] TeammateDeletedEvent: [] BankAccountCreatedEvent: [] BankAccountUpdatedEvent: [] BankAccountDeletedEvent: [] BankAccountAssignedEvent: [] HydraAssignedEvent: [] HydraRequestResetEvent: [] HydraStoreAssignedEvent: [] HydraStoreUnassignedEvent: [] HydraSettingChangedEvent: [] HydraUnAssignedEvent: [] HydraConnectionStatusChangedEvent: [] KioskBluetoothPairingModeEvent: [] KioskBluetoothUnpairingModeEvent: [] KioskBluetoothTerminalUnpairedEvent: [] KioskTerminalActionStateChangedEvent: [] KioskBluetoothTerminalUpdatedEvent: [] KioskBluetoothTerminalInitiateUpdateCheckEvent: [] KioskBluetoothInstallUpdateInitiateEvent: [] KioskBluetoothTerminalCancelUpdateEvent: [] KioskBluetoothTerminalFirmwareVersionStatusEvent: [] KioskBluetoothTerminalInstallationStatusEvent: [] PushNotificationScheduledEvent: [] PushNotificationSentEvent: [] PushNotificationDeletedEvent: [] DnsVerifiedEvent: [] CertificateCreatedEvent: [] CertificateRenewedEvent: [] WebsiteVanityUrlUpdatedEvent: [] WebsiteUpdatedEvent: [] OrderCapacityUpdatedEvent: [] ExternalStoreEvent: [] OrderFulfillmentStatusUpdatedEvent: [] AppStoreConfigCreatedEvent: [] AppStoreConfigUpdatedEvent: [] AppStoreConfigDeletedEvent: [] AppStoreSubscriptionChangeJobUpdatedEvent: [] CatalogItemCreatedEvent: [] CatalogItemUpdatedEvent: [] CatalogItemArchivedEvent: [] CatalogGroupCreatedEvent: [] CatalogGroupUpdatedEvent: [] CatalogGroupArchivedEvent: [] StoreTipUpdatedEvent: [] LocationAreaCreatedEvent: [] LocationAreaUpdatedEvent: [] LocationCreatedEvent: [] LocationDeletedEvent: [] StoreServiceChargeUpdatedEvent: [] MobileAppsSubmissionStatusUpdatedEvent: [] MobileAppsSubmissionUpdatedEvent: [] StoreFeeConfigUpdatedEvent: [] Page: 1 Limit: 1 TotalRecordCount: 12.5 '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetCustomerEvents400Example: summary: Default GetCustomerEvents 400 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '401': description: Authentication has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetCustomerEvents401Example: summary: Default GetCustomerEvents 401 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '403': description: Successful authentication, but authorization has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetCustomerEvents403Example: summary: Default GetCustomerEvents 403 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetCustomerEvents500Example: summary: Default GetCustomerEvents 500 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. security: - oauth2: - api summary: Flipdish Get Customer Events description: Get Customer Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/customer/{customerId}). x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1.0/{appId}/events/whitelabel/{whitelabelId}: get: tags: - Events operationId: GetWhiteLabelEvents parameters: - name: appId in: path required: true schema: type: string description: The app id path parameter. example: '500123' - name: whitelabelId in: path required: true schema: type: integer format: int32 description: The whitelabel id path parameter. example: 500123 - name: limit in: query description: The maximum elements to return required: false schema: type: integer format: int32 example: 1 - name: page in: query description: The index of the page to return, starting by 1 required: false schema: type: integer format: int32 example: 1 - name: start in: query description: Start date required: false x-nullable: true schema: type: string format: date-time example: '2026-06-02T12:00:00Z' - name: end in: query description: End date required: false x-nullable: true schema: type: string format: date-time example: '2026-06-02T12:00:00Z' - name: orderId in: query description: Events that have Order Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: storeId in: query description: Events that have Store Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: storeIdList in: query description: Events that have Store Id List required: false explode: true schema: type: array items: type: integer format: int32 example: - 1 - name: storeGroupId in: query description: Events that have Store Group Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: userId in: query description: Events that have User Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: menuId in: query description: Events that have Menu Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: campaignId in: query description: Events that have Campaign Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: userEmail in: query description: Events that have User Email required: false schema: type: string example: owner@example.com - name: userName in: query description: Events that have User Name required: false schema: type: string example: Example Name - name: voucherCode in: query description: Events that have voucher code required: false schema: type: string example: string - name: eventType in: query description: Events that have event type\s required: false explode: true schema: type: array items: type: string example: - string - name: flipdishEventId in: query description: Unique Identifier of Event, if this is specified, all other criteria are ignored. required: false schema: type: string example: '500123' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RestApiEventSearchPaginationResult' examples: GetWhiteLabelEvents200Example: summary: Default GetWhiteLabelEvents 200 response x-microcks-default: true value: Data: AppCreatedEvent: [] AppUpdatedEvent: [] AnalyticsClientEvent: [] OrderAcceptedEvent: [] OrderDispatchedEvent: [] OrderCustomerTrackingCreatedEvent: [] OrderDeliveryTrackingStatusUpdatedEvent: [] OrderBatchPublishedEvent: [] OrderCreatedEvent: [] OrderRatingUpdatedEvent: [] OrderRefundedEvent: [] OrderRejectedEvent: [] OrderTipUpdatedEvent: [] OrderTerminalNotifications: [] StoreCreatedEvent: [] StoreDeletedEvent: [] StoreAddressUpdatedEvent: [] StoreKioskSettingUpdatedEvent: [] DeliveryZoneCreatedEvent: [] DeliveryZoneUpdatedEvent: [] DeliveryZoneDeletedEvent: [] StoreOpeningHoursUpdatedEvent: [] StoreMenuAssignedEvent: [] StoreBusinessHoursOverrideCreatedEvent: [] StoreBusinessHoursOverrideDeletedEvent: [] StoreArchivedEvent: [] StoreUnarchivedEvent: [] StorePublishedEvent: [] StoreUnpublishedEvent: [] StoreUpdatedEvent: [] StorePreOrderConfigUpdatedEvent: [] StoreLogoCreatedEvent: [] StoreLogoUpdatedEvent: [] StoreLogoDeletedEvent: [] MenuCreatedEvent: [] MenuAsyncCreationCompletedEvent: [] MenuUpdatedEvent: [] MenuUploadedEvent: [] MenuBulkEditEvent: [] MenuSectionCreatedEvent: [] MenuSectionUpdatedEvent: [] MenuSectionDeletedEvent: [] MenuSectionItemCreatedEvent: [] MenuSectionItemUpdatedEvent: [] MenuSectionItemDeletedEvent: [] MenuItemOptionSetCreatedEvent: [] MenuItemOptionSetUpdatedEvent: [] MenuItemOptionSetDeletedEvent: [] MenuItemOptionSetItemCreatedEvent: [] MenuItemOptionSetItemUpdatedEvent: [] MenuItemOptionSetItemDeletedEvent: [] MenuCheckpointCreatedEvent: [] StoreGroupCreatedEvent: [] StoreGroupUpdatedEvent: [] StoreGroupDeletedEvent: [] CustomerCreatedEvent: [] CustomerUpdatedEvent: [] CustomerConsentUpdatedEvent: [] WebhookSubscriptionCreatedEvent: [] WebhookSubscriptionUpdatedEvent: [] WebhookSubscriptionDeletedEvent: [] PrinterTurnedOnEvent: [] PrinterTurnedOffEvent: [] PrinterAssignedToStoreEvent: [] PrinterUnassignedFromStoreEvent: [] PhoneCallStartedEvent: [] PhoneCallEndedEvent: [] TelephonyConfigUpdatedEvent: [] ChannelStoresUpdatedEvent: [] LoyaltyCampaignCreatedEvent: [] LoyaltyCampaignDeletedEvent: [] LoyaltyCampaignUpdatedEvent: [] RetentionCampaignCreatedEvent: [] RetentionCampaignDeletedEvent: [] RetentionCampaignUpdatedEvent: [] SmsReceivedEvent: [] UserLoginEvent: [] UserCreatedEvent: [] UserUpdatedEvent: [] UserDeletedEvent: [] UserCreatedPasswordEvent: [] UserAnsweredSignupQuestionsEvent: [] VoucherCreatedEvent: [] VoucherUpdatedEvent: [] VoucherDeletedEvent: [] VoucherAppliedEvent: [] TeammateInviteSentEvent: [] TeammateInviteAcceptedEvent: [] TeammateUpdatedEvent: [] TeammateDeletedEvent: [] BankAccountCreatedEvent: [] BankAccountUpdatedEvent: [] BankAccountDeletedEvent: [] BankAccountAssignedEvent: [] HydraAssignedEvent: [] HydraRequestResetEvent: [] HydraStoreAssignedEvent: [] HydraStoreUnassignedEvent: [] HydraSettingChangedEvent: [] HydraUnAssignedEvent: [] HydraConnectionStatusChangedEvent: [] KioskBluetoothPairingModeEvent: [] KioskBluetoothUnpairingModeEvent: [] KioskBluetoothTerminalUnpairedEvent: [] KioskTerminalActionStateChangedEvent: [] KioskBluetoothTerminalUpdatedEvent: [] KioskBluetoothTerminalInitiateUpdateCheckEvent: [] KioskBluetoothInstallUpdateInitiateEvent: [] KioskBluetoothTerminalCancelUpdateEvent: [] KioskBluetoothTerminalFirmwareVersionStatusEvent: [] KioskBluetoothTerminalInstallationStatusEvent: [] PushNotificationScheduledEvent: [] PushNotificationSentEvent: [] PushNotificationDeletedEvent: [] DnsVerifiedEvent: [] CertificateCreatedEvent: [] CertificateRenewedEvent: [] WebsiteVanityUrlUpdatedEvent: [] WebsiteUpdatedEvent: [] OrderCapacityUpdatedEvent: [] ExternalStoreEvent: [] OrderFulfillmentStatusUpdatedEvent: [] AppStoreConfigCreatedEvent: [] AppStoreConfigUpdatedEvent: [] AppStoreConfigDeletedEvent: [] AppStoreSubscriptionChangeJobUpdatedEvent: [] CatalogItemCreatedEvent: [] CatalogItemUpdatedEvent: [] CatalogItemArchivedEvent: [] CatalogGroupCreatedEvent: [] CatalogGroupUpdatedEvent: [] CatalogGroupArchivedEvent: [] StoreTipUpdatedEvent: [] LocationAreaCreatedEvent: [] LocationAreaUpdatedEvent: [] LocationCreatedEvent: [] LocationDeletedEvent: [] StoreServiceChargeUpdatedEvent: [] MobileAppsSubmissionStatusUpdatedEvent: [] MobileAppsSubmissionUpdatedEvent: [] StoreFeeConfigUpdatedEvent: [] Page: 1 Limit: 1 TotalRecordCount: 12.5 '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetWhiteLabelEvents400Example: summary: Default GetWhiteLabelEvents 400 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '401': description: Authentication has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetWhiteLabelEvents401Example: summary: Default GetWhiteLabelEvents 401 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '403': description: Successful authentication, but authorization has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetWhiteLabelEvents403Example: summary: Default GetWhiteLabelEvents 403 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetWhiteLabelEvents500Example: summary: Default GetWhiteLabelEvents 500 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. security: - oauth2: - api summary: Flipdish Get White Label Events description: Get White Label Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/whitelabel/{whitelabelId}). x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1.0/{appId}/events/order: get: tags: - Events operationId: GetOrderEventsByCustomer parameters: - name: appId in: path required: true schema: type: string description: The app id path parameter. example: '500123' - name: customerId in: query required: true schema: type: integer format: int32 description: The customer id query parameter. example: 500123 - name: limit in: query description: The maximum elements to return required: false schema: type: integer format: int32 example: 1 - name: page in: query description: The index of the page to return, starting by 1 required: false schema: type: integer format: int32 example: 1 - name: start in: query description: Start date required: false x-nullable: true schema: type: string format: date-time example: '2026-06-02T12:00:00Z' - name: end in: query description: End date required: false x-nullable: true schema: type: string format: date-time example: '2026-06-02T12:00:00Z' - name: orderId in: query description: Events that have Order Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: storeId in: query description: Events that have Store Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: storeIdList in: query description: Events that have Store Id List required: false explode: true schema: type: array items: type: integer format: int32 example: - 1 - name: storeGroupId in: query description: Events that have Store Group Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: userId in: query description: Events that have User Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: menuId in: query description: Events that have Menu Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: campaignId in: query description: Events that have Campaign Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: userEmail in: query description: Events that have User Email required: false schema: type: string example: owner@example.com - name: userName in: query description: Events that have User Name required: false schema: type: string example: Example Name - name: voucherCode in: query description: Events that have voucher code required: false schema: type: string example: string - name: eventType in: query description: Events that have event type\s required: false explode: true schema: type: array items: type: string example: - string - name: flipdishEventId in: query description: Unique Identifier of Event, if this is specified, all other criteria are ignored. required: false schema: type: string example: '500123' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RestApiEventSearchPaginationResult' examples: GetOrderEventsByCustomer200Example: summary: Default GetOrderEventsByCustomer 200 response x-microcks-default: true value: Data: AppCreatedEvent: [] AppUpdatedEvent: [] AnalyticsClientEvent: [] OrderAcceptedEvent: [] OrderDispatchedEvent: [] OrderCustomerTrackingCreatedEvent: [] OrderDeliveryTrackingStatusUpdatedEvent: [] OrderBatchPublishedEvent: [] OrderCreatedEvent: [] OrderRatingUpdatedEvent: [] OrderRefundedEvent: [] OrderRejectedEvent: [] OrderTipUpdatedEvent: [] OrderTerminalNotifications: [] StoreCreatedEvent: [] StoreDeletedEvent: [] StoreAddressUpdatedEvent: [] StoreKioskSettingUpdatedEvent: [] DeliveryZoneCreatedEvent: [] DeliveryZoneUpdatedEvent: [] DeliveryZoneDeletedEvent: [] StoreOpeningHoursUpdatedEvent: [] StoreMenuAssignedEvent: [] StoreBusinessHoursOverrideCreatedEvent: [] StoreBusinessHoursOverrideDeletedEvent: [] StoreArchivedEvent: [] StoreUnarchivedEvent: [] StorePublishedEvent: [] StoreUnpublishedEvent: [] StoreUpdatedEvent: [] StorePreOrderConfigUpdatedEvent: [] StoreLogoCreatedEvent: [] StoreLogoUpdatedEvent: [] StoreLogoDeletedEvent: [] MenuCreatedEvent: [] MenuAsyncCreationCompletedEvent: [] MenuUpdatedEvent: [] MenuUploadedEvent: [] MenuBulkEditEvent: [] MenuSectionCreatedEvent: [] MenuSectionUpdatedEvent: [] MenuSectionDeletedEvent: [] MenuSectionItemCreatedEvent: [] MenuSectionItemUpdatedEvent: [] MenuSectionItemDeletedEvent: [] MenuItemOptionSetCreatedEvent: [] MenuItemOptionSetUpdatedEvent: [] MenuItemOptionSetDeletedEvent: [] MenuItemOptionSetItemCreatedEvent: [] MenuItemOptionSetItemUpdatedEvent: [] MenuItemOptionSetItemDeletedEvent: [] MenuCheckpointCreatedEvent: [] StoreGroupCreatedEvent: [] StoreGroupUpdatedEvent: [] StoreGroupDeletedEvent: [] CustomerCreatedEvent: [] CustomerUpdatedEvent: [] CustomerConsentUpdatedEvent: [] WebhookSubscriptionCreatedEvent: [] WebhookSubscriptionUpdatedEvent: [] WebhookSubscriptionDeletedEvent: [] PrinterTurnedOnEvent: [] PrinterTurnedOffEvent: [] PrinterAssignedToStoreEvent: [] PrinterUnassignedFromStoreEvent: [] PhoneCallStartedEvent: [] PhoneCallEndedEvent: [] TelephonyConfigUpdatedEvent: [] ChannelStoresUpdatedEvent: [] LoyaltyCampaignCreatedEvent: [] LoyaltyCampaignDeletedEvent: [] LoyaltyCampaignUpdatedEvent: [] RetentionCampaignCreatedEvent: [] RetentionCampaignDeletedEvent: [] RetentionCampaignUpdatedEvent: [] SmsReceivedEvent: [] UserLoginEvent: [] UserCreatedEvent: [] UserUpdatedEvent: [] UserDeletedEvent: [] UserCreatedPasswordEvent: [] UserAnsweredSignupQuestionsEvent: [] VoucherCreatedEvent: [] VoucherUpdatedEvent: [] VoucherDeletedEvent: [] VoucherAppliedEvent: [] TeammateInviteSentEvent: [] TeammateInviteAcceptedEvent: [] TeammateUpdatedEvent: [] TeammateDeletedEvent: [] BankAccountCreatedEvent: [] BankAccountUpdatedEvent: [] BankAccountDeletedEvent: [] BankAccountAssignedEvent: [] HydraAssignedEvent: [] HydraRequestResetEvent: [] HydraStoreAssignedEvent: [] HydraStoreUnassignedEvent: [] HydraSettingChangedEvent: [] HydraUnAssignedEvent: [] HydraConnectionStatusChangedEvent: [] KioskBluetoothPairingModeEvent: [] KioskBluetoothUnpairingModeEvent: [] KioskBluetoothTerminalUnpairedEvent: [] KioskTerminalActionStateChangedEvent: [] KioskBluetoothTerminalUpdatedEvent: [] KioskBluetoothTerminalInitiateUpdateCheckEvent: [] KioskBluetoothInstallUpdateInitiateEvent: [] KioskBluetoothTerminalCancelUpdateEvent: [] KioskBluetoothTerminalFirmwareVersionStatusEvent: [] KioskBluetoothTerminalInstallationStatusEvent: [] PushNotificationScheduledEvent: [] PushNotificationSentEvent: [] PushNotificationDeletedEvent: [] DnsVerifiedEvent: [] CertificateCreatedEvent: [] CertificateRenewedEvent: [] WebsiteVanityUrlUpdatedEvent: [] WebsiteUpdatedEvent: [] OrderCapacityUpdatedEvent: [] ExternalStoreEvent: [] OrderFulfillmentStatusUpdatedEvent: [] AppStoreConfigCreatedEvent: [] AppStoreConfigUpdatedEvent: [] AppStoreConfigDeletedEvent: [] AppStoreSubscriptionChangeJobUpdatedEvent: [] CatalogItemCreatedEvent: [] CatalogItemUpdatedEvent: [] CatalogItemArchivedEvent: [] CatalogGroupCreatedEvent: [] CatalogGroupUpdatedEvent: [] CatalogGroupArchivedEvent: [] StoreTipUpdatedEvent: [] LocationAreaCreatedEvent: [] LocationAreaUpdatedEvent: [] LocationCreatedEvent: [] LocationDeletedEvent: [] StoreServiceChargeUpdatedEvent: [] MobileAppsSubmissionStatusUpdatedEvent: [] MobileAppsSubmissionUpdatedEvent: [] StoreFeeConfigUpdatedEvent: [] Page: 1 Limit: 1 TotalRecordCount: 12.5 '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetOrderEventsByCustomer400Example: summary: Default GetOrderEventsByCustomer 400 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '401': description: Authentication has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetOrderEventsByCustomer401Example: summary: Default GetOrderEventsByCustomer 401 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '403': description: Successful authentication, but authorization has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetOrderEventsByCustomer403Example: summary: Default GetOrderEventsByCustomer 403 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetOrderEventsByCustomer500Example: summary: Default GetOrderEventsByCustomer 500 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. security: - oauth2: - api summary: Flipdish Get Order Events by Customer description: Get Order Events by Customer via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/order). x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1.0/{appId}/events: get: tags: - Events operationId: GetEvents parameters: - name: appId in: path required: true schema: type: string description: The app id path parameter. example: '500123' - name: whiteLabelId in: query required: false schema: type: integer format: int32 description: The white label id query parameter. example: 500123 - name: customerId in: query required: false schema: type: integer format: int32 description: The customer id query parameter. example: 500123 - name: limit in: query description: The maximum elements to return required: false schema: type: integer format: int32 example: 1 - name: page in: query description: The index of the page to return, starting by 1 required: false schema: type: integer format: int32 example: 1 - name: start in: query description: Start date required: false x-nullable: true schema: type: string format: date-time example: '2026-06-02T12:00:00Z' - name: end in: query description: End date required: false x-nullable: true schema: type: string format: date-time example: '2026-06-02T12:00:00Z' - name: orderId in: query description: Events that have Order Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: storeId in: query description: Events that have Store Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: storeIdList in: query description: Events that have Store Id List required: false explode: true schema: type: array items: type: integer format: int32 example: - 1 - name: storeGroupId in: query description: Events that have Store Group Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: userId in: query description: Events that have User Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: menuId in: query description: Events that have Menu Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: campaignId in: query description: Events that have Campaign Id required: false x-nullable: true schema: type: integer format: int32 example: 500123 - name: userEmail in: query description: Events that have User Email required: false schema: type: string example: owner@example.com - name: userName in: query description: Events that have User Name required: false schema: type: string example: Example Name - name: voucherCode in: query description: Events that have voucher code required: false schema: type: string example: string - name: eventType in: query description: Events that have event type\s required: false explode: true schema: type: array items: type: string example: - string - name: flipdishEventId in: query description: Unique Identifier of Event, if this is specified, all other criteria are ignored. required: false schema: type: string example: '500123' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RestApiEventSearchPaginationResult' examples: GetEvents200Example: summary: Default GetEvents 200 response x-microcks-default: true value: Data: AppCreatedEvent: [] AppUpdatedEvent: [] AnalyticsClientEvent: [] OrderAcceptedEvent: [] OrderDispatchedEvent: [] OrderCustomerTrackingCreatedEvent: [] OrderDeliveryTrackingStatusUpdatedEvent: [] OrderBatchPublishedEvent: [] OrderCreatedEvent: [] OrderRatingUpdatedEvent: [] OrderRefundedEvent: [] OrderRejectedEvent: [] OrderTipUpdatedEvent: [] OrderTerminalNotifications: [] StoreCreatedEvent: [] StoreDeletedEvent: [] StoreAddressUpdatedEvent: [] StoreKioskSettingUpdatedEvent: [] DeliveryZoneCreatedEvent: [] DeliveryZoneUpdatedEvent: [] DeliveryZoneDeletedEvent: [] StoreOpeningHoursUpdatedEvent: [] StoreMenuAssignedEvent: [] StoreBusinessHoursOverrideCreatedEvent: [] StoreBusinessHoursOverrideDeletedEvent: [] StoreArchivedEvent: [] StoreUnarchivedEvent: [] StorePublishedEvent: [] StoreUnpublishedEvent: [] StoreUpdatedEvent: [] StorePreOrderConfigUpdatedEvent: [] StoreLogoCreatedEvent: [] StoreLogoUpdatedEvent: [] StoreLogoDeletedEvent: [] MenuCreatedEvent: [] MenuAsyncCreationCompletedEvent: [] MenuUpdatedEvent: [] MenuUploadedEvent: [] MenuBulkEditEvent: [] MenuSectionCreatedEvent: [] MenuSectionUpdatedEvent: [] MenuSectionDeletedEvent: [] MenuSectionItemCreatedEvent: [] MenuSectionItemUpdatedEvent: [] MenuSectionItemDeletedEvent: [] MenuItemOptionSetCreatedEvent: [] MenuItemOptionSetUpdatedEvent: [] MenuItemOptionSetDeletedEvent: [] MenuItemOptionSetItemCreatedEvent: [] MenuItemOptionSetItemUpdatedEvent: [] MenuItemOptionSetItemDeletedEvent: [] MenuCheckpointCreatedEvent: [] StoreGroupCreatedEvent: [] StoreGroupUpdatedEvent: [] StoreGroupDeletedEvent: [] CustomerCreatedEvent: [] CustomerUpdatedEvent: [] CustomerConsentUpdatedEvent: [] WebhookSubscriptionCreatedEvent: [] WebhookSubscriptionUpdatedEvent: [] WebhookSubscriptionDeletedEvent: [] PrinterTurnedOnEvent: [] PrinterTurnedOffEvent: [] PrinterAssignedToStoreEvent: [] PrinterUnassignedFromStoreEvent: [] PhoneCallStartedEvent: [] PhoneCallEndedEvent: [] TelephonyConfigUpdatedEvent: [] ChannelStoresUpdatedEvent: [] LoyaltyCampaignCreatedEvent: [] LoyaltyCampaignDeletedEvent: [] LoyaltyCampaignUpdatedEvent: [] RetentionCampaignCreatedEvent: [] RetentionCampaignDeletedEvent: [] RetentionCampaignUpdatedEvent: [] SmsReceivedEvent: [] UserLoginEvent: [] UserCreatedEvent: [] UserUpdatedEvent: [] UserDeletedEvent: [] UserCreatedPasswordEvent: [] UserAnsweredSignupQuestionsEvent: [] VoucherCreatedEvent: [] VoucherUpdatedEvent: [] VoucherDeletedEvent: [] VoucherAppliedEvent: [] TeammateInviteSentEvent: [] TeammateInviteAcceptedEvent: [] TeammateUpdatedEvent: [] TeammateDeletedEvent: [] BankAccountCreatedEvent: [] BankAccountUpdatedEvent: [] BankAccountDeletedEvent: [] BankAccountAssignedEvent: [] HydraAssignedEvent: [] HydraRequestResetEvent: [] HydraStoreAssignedEvent: [] HydraStoreUnassignedEvent: [] HydraSettingChangedEvent: [] HydraUnAssignedEvent: [] HydraConnectionStatusChangedEvent: [] KioskBluetoothPairingModeEvent: [] KioskBluetoothUnpairingModeEvent: [] KioskBluetoothTerminalUnpairedEvent: [] KioskTerminalActionStateChangedEvent: [] KioskBluetoothTerminalUpdatedEvent: [] KioskBluetoothTerminalInitiateUpdateCheckEvent: [] KioskBluetoothInstallUpdateInitiateEvent: [] KioskBluetoothTerminalCancelUpdateEvent: [] KioskBluetoothTerminalFirmwareVersionStatusEvent: [] KioskBluetoothTerminalInstallationStatusEvent: [] PushNotificationScheduledEvent: [] PushNotificationSentEvent: [] PushNotificationDeletedEvent: [] DnsVerifiedEvent: [] CertificateCreatedEvent: [] CertificateRenewedEvent: [] WebsiteVanityUrlUpdatedEvent: [] WebsiteUpdatedEvent: [] OrderCapacityUpdatedEvent: [] ExternalStoreEvent: [] OrderFulfillmentStatusUpdatedEvent: [] AppStoreConfigCreatedEvent: [] AppStoreConfigUpdatedEvent: [] AppStoreConfigDeletedEvent: [] AppStoreSubscriptionChangeJobUpdatedEvent: [] CatalogItemCreatedEvent: [] CatalogItemUpdatedEvent: [] CatalogItemArchivedEvent: [] CatalogGroupCreatedEvent: [] CatalogGroupUpdatedEvent: [] CatalogGroupArchivedEvent: [] StoreTipUpdatedEvent: [] LocationAreaCreatedEvent: [] LocationAreaUpdatedEvent: [] LocationCreatedEvent: [] LocationDeletedEvent: [] StoreServiceChargeUpdatedEvent: [] MobileAppsSubmissionStatusUpdatedEvent: [] MobileAppsSubmissionUpdatedEvent: [] StoreFeeConfigUpdatedEvent: [] Page: 1 Limit: 1 TotalRecordCount: 12.5 '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetEvents400Example: summary: Default GetEvents 400 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '401': description: Authentication has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetEvents401Example: summary: Default GetEvents 401 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '403': description: Successful authentication, but authorization has been denied for this request. content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetEvents403Example: summary: Default GetEvents 403 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/FlipdishError' examples: GetEvents500Example: summary: Default GetEvents 500 response x-microcks-default: true value: error: errorMessage: Invalid or missing parameters. errorCode: BadRequest details: Validation failed for field 'storeId'. security: - oauth2: - api summary: Flipdish Get Events description: Get Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events). x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: MobileAppsSubmissionUpdatedEvent: description: Mobile Apps event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreOrderCapacityConfigEditModel: description: Represents one store's order capacity configuration edit type: object properties: OrderCapacityPeriods: description: Order capacity periods type: array items: $ref: '#/components/schemas/StoreOrderCapacityPeriod' example: [] MenuSectionItem: description: Menu item type: object properties: ActualPrice: format: double description: Actual price - the minimum price possible when all required option set items prices are included. type: number example: 12.5 MenuItemOptionSets: description: Menu item option sets type: array items: $ref: '#/components/schemas/MenuItemOptionSet' example: [] DailySpecialHours: description: Daily special hours type: array items: $ref: '#/components/schemas/BusinessHoursPeriod' example: [] PublicId: format: uuid description: Permanent reference to the item. type: string example: 00000000-0000-0000-0000-000000000000 TaxRateName: description: Tax rate name type: string example: Example Name TaxRateId: format: int32 description: TaxRate type: integer nullable: true example: 500123 TaxValue: format: double description: TaxValue - the tax associated with this item, based on TaxRate / TaxType and Currency (currency determines decimal point precision) type: number example: 1.0 ExcludeFromVoucherDiscounting: description: If true, the item is excluded from voucher discount calculations type: boolean example: true Metadata: description: List of metadata type: array items: $ref: '#/components/schemas/CreateMetadata' example: [] CatalogItemId: description: Catalog item Id when the Item is associated to a Product type: string example: '500123' Name: description: Menu item name (like "Korma") maxLength: 4000 minLength: 0 type: string example: Example Name Description: description: Description (like "A lovely dish from the east") maxLength: 4000 minLength: 0 type: string example: string SpicinessRating: description: Spiciness rating enum: - NotRated - Mild - Medium - Hot type: string example: NotRated Price: format: double description: Price - this is only used when there is no master option set and should be set to 0 if a master option set exists. type: number example: 12.5 DepositReturnFee: format: double description: An optional fee that can be added to the price of the item. type: number nullable: true example: 12.5 DisplayOrder: format: int32 description: Display order type: integer example: 1 Alcohol: description: To be set true if the item or an option of the item contains an alcoholic drink. type: boolean example: true IsAvailable: description: True if we accept orders for this item still type: boolean example: true CellLayoutType: description: "Small | Medium | Large\r\nAffects the layout of the menu." enum: - Small - Medium - Large - HiddenImage type: string example: Small DisableVouchers: description: If true, then vouchers won't be applied for this item type: boolean example: true ImageName: description: Image url type: string example: Example Name ImageUrl: description: Image url type: string example: https://api.flipdish.co/example MenuItemId: format: int32 description: Menu Item Id type: integer example: 500123 RetentionCampaignUpdatedEvent: description: Retention campaign updated event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string StoreId: format: int32 description: Store Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' RetentionCampaign: $ref: '#/components/schemas/RetentionCampaign' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreTipUpdatedEvent: description: Store Tip Updated type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string Config: $ref: '#/components/schemas/UpdateTipConfiguration' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string HydraStoreUnassignedEvent: description: Hydra store\s unassigned event type: object properties: User: $ref: '#/components/schemas/UserEventInfo' StoreIds: description: Store\s to unassign hydra from type: array items: format: int32 type: integer example: - 1 EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreOpeningHoursUpdatedEvent: description: Store Opening Hours Updated Event type: object properties: EventName: description: The event name type: string example: Example Name OrgId: description: Organisation Id type: string example: '500123' StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' DeliveryType: description: Type of opening hours Delivery / Pickup enum: - Delivery - Pickup type: string example: Delivery DeliveryTypeString: description: Type of opening hours Delivery / Pickup as a string enum: - Delivery - Pickup type: string example: Delivery BusinessHoursPeriodOld: $ref: '#/components/schemas/BusinessHoursPeriod' BusinessHoursPeriod: $ref: '#/components/schemas/BusinessHoursPeriod' Description: description: Description type: string example: string FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string SmsInfo: description: Sms Info type: object properties: From: description: Origin phone number type: string example: string To: description: Destination phone number type: string example: string Text: description: Text message type: string example: string VoucherDeletedEvent: description: Voucher Deleted Event type: object properties: VoucherId: format: int32 description: Voucher Id type: integer example: 500123 EventName: description: The event name type: string example: Example Name User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string Voucher: $ref: '#/components/schemas/Voucher' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string PushNotificationScheduledEvent: description: '' type: object properties: EventName: description: The event name type: string example: Example Name User: $ref: '#/components/schemas/UserEventInfo' Description: description: '' type: string example: string PushNotification: $ref: '#/components/schemas/PushNotificationRequest' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string OrderFulfillmentStatusUpdatedEvent: description: Fulfillment status updated event type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 Description: description: Description type: string example: string OrderId: format: int32 description: Order Id type: integer nullable: true example: 500123 StatusName: description: Fulfillment status name type: string example: Example Name StatusId: description: Fulfillment status ID type: string example: '500123' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string FeeSummary: description: Fee Summary type: object properties: FeeAmount: format: double description: Fee amount type: number example: 12.5 PercentageRate: format: double description: Percentage rate type: number example: 1.0 PerTransactionFee: format: double description: Per transaction fee type: number example: 12.5 App: description: App type: object properties: AppId: description: App Identifier type: string example: '500123' HasIosApp: description: Has iOS app in Apple App Store. This is readonly. type: boolean example: true IosAppStoreUrl: description: IOS App Store URL type: string example: https://api.flipdish.co/example HasAndroidApp: description: Has Android app in Google Play Store. This is readonly. type: boolean example: true AndroidPlayStoreUrl: description: Android Play Store URL type: string example: https://api.flipdish.co/example DisplayDeliveryRestaurantScreen: description: Display delivery restaurant screen type: boolean example: true LogoImageUrl: description: Application Logo. type: string example: https://api.flipdish.co/example Languages: description: Languages that have been selected to be available to customers. type: array items: $ref: '#/components/schemas/Language' example: [] AvailableAppLanguages: description: Lists all languages that are supported by Flipdish. type: array items: $ref: '#/components/schemas/Language' example: [] AppAccessLevel: description: App access level for the logged in user enum: - None - Owner - StoreOwner - PropertyOwner - ManagedOwner - Integrator - PropertyManager - StoreManager - StoreStaff - StoreReadOnlyAccess - FinanceManger - Onboarding - Support type: string example: None AppResourceSet: description: Constitutes a list of available resources type: array items: enum: - ViewApp - CreateApp - UpdateApp - ViewAppName - EditAppAssets - EditAppFeatures - ViewTeammates - EditTeammates - CreateTeammateOwner - CreateTeammateManagedOwner - CreateTeammateStoreOwner - CreateTeammateStoreManager - CreateTeammateStoreStaff - CreateTeammateStoreReadAccess - CreateTeammateFinanceManager - CreateTeammateIntegrator - CreateTeammateOnboarding - CreateTeammatePropertyManager - CreateTeammatePropertyOwner - ViewApmConfigurations - EditApmConfigurations - ViewCampaignsConfigurations - CreateCampaignsConfigurations - UpdateCampaignsConfigurations - DeleteCampaignsConfigurations - StampLoyaltyCardAgainstCampaignsConfigurations - ViewDevelopersSettings - EditDevelopersSettings - ViewOrders - UpdateOrdersAccept - UpdateOrdersReject - UpdateOrdersRefund - UpdateOrdersDispatch - ViewStores - CreateStores - EditStores - ViewStoresOpeningHours - UpdateStoresOpenForCollectionOrDelivery - UpdateStoresOpeningHours - ViewStoresOpeningHoursOverride - EditStoresOpeningHoursOverride - EditStoresOpeningHoursOverrideTemporary - UpdateStoresName - EditStoreKioskSettings - EditStoreOrderCapacity - ArchiveStores - PublishStores - UpdatePrinterTerminalsAssign - UpdatePrinterTerminalsToggle - EditStoreNotifications - ViewStoreGroups - CreateStoreGroups - UpdateStoreGroups - DeleteStoreGroups - ViewDeliveryZones - CreateDeliveryZones - UpdateDeliveryZones - DeleteDeliveryZones - ViewMenu - CreateMenu - UpdateMenu - DeleteMenu - UpdateMenuLock - UpdateMenuItemsHideTemporarily - EditMenuImage - ViewVouchers - EditVouchers - ViewWebsiteContent - EditWebsiteContent - ViewWebsiteDnsVerified - ViewWebsiteCertificateCreated - ViewWebsiteCertificateRenewed - ViewBankAccounts - CreateBankAccounts - UpdateBankAccounts - UpdateBankAccountsAssign - ViewAssignedBankAccount - VerifyBankAccounts - ViewServiceChargeConfigurations - EditServiceChargeConfigurations - EditStoreDeliveryZoneFees - EditStoreDeliveryFeesLimited - ViewHydraConfig - UpdateHydraConfigManage - InitiateBluetoothPairingMode - DeleteTerminal - ViewKioskTelemetry - ViewCustomers - EditCustomers - CreateCustomers - CreateCatalogElements - UpdateCatalogElements - ViewCatalogElements - DeleteCatalogElements - ViewMetafieldDefinitions - CreateMetafieldDefinitions - UpdateMetafieldDefinitions - DeleteMetafieldDefinitions - UpdateMetafields - ViewCatalogMenuChanges - PublishCatalogMenuChanges - ViewAppStatistics - ViewApmStatistics - ViewCampaignsStatistics - ViewCustomerStatistics - ViewLiveStatistics - ViewOrderStatistics - ViewSalesStatistics - ViewSalesEndOfDayStatistics - ViewVouchersStatistics - DownloadCustomerCsvExport - ViewApmAuditLogs - ViewStoreAuditLogs - ViewMenuAuditLogs - ViewBankAccountAuditLogs - ViewFeeConfigurationsAuditLogs - ViewOrdersAuditLogs - ViewVouchersAuditLogs - ViewUserEventsAuditLogs - ViewCampaignsAuditLogs - ViewTeammatesAuditLogs - ViewAppAuditLogs - ViewCustomerAuditLogs - ViewPrinterAuditLogs - ViewHydraAuditLogs - ViewPushNotificationAuditLogs - ViewStripeCustomConnectedAccountAuditLogs - ViewKioskBluetoothDeviceAuditLogs - ViewExternalAuditLogs - CreateExternalAuditLogEvents - ViewCatalogAuditLogs - ViewOrderFulfillmentAuditLogs - ViewChannelAuditLogs - ViewAppStoreAuditLogs - SendPushNotificationToCustomer - InviteDriverToApp - GetDriverForApp - RemoveDriverFromApp - AssignDriverToOrder - UnassignDriverFromOrder - UpdateOrdersDeliveryTrackingStatus - UpdateOrderFulfillmentStatus - ViewFulfillmentStatesConfiguration - CreateFulfillmentStatesConfiguration - UpdateFulfillmentStatesConfiguration - DeleteFulfillmentStatesConfiguration - ViewPayouts - ViewChannels - ViewOnboarding - UpdateOnboarding - ViewClientDevices - UpdateClientDevices - EnrollClientDevices - AssignClientDevices - ViewClientAuditLogs - CreateAppStoreAppConfiguration - ViewAppStoreAppConfiguration - UpdateAppStoreAppConfiguration - DeleteAppStoreAppConfiguration - UpdateAppStoreAppConfigurationSettings - CreateAppStoreSubscription - UpdateAppStoreSubscription - DeleteAppStoreSubscription - ViewSalesChannels - EditSalesChannels - ViewPayGreenWhiteLabelConfiguration - CreatePayGreenWhiteLabelConfiguration - UpdatePayGreenWhiteLabelConfiguration - UpdatePayGreenStoreConfiguration - ViewSubscriptions - ViewInvoices - EditAccountsBills - ViewAccountsBills - EditAccountsCategories - ViewAccountsCategories - EditAccountsCreditAccounts - ViewAccountsCreditAccounts - EditAccountsCreditBooks - ViewAccountsCreditBooks - EditAccountsExpenses - ViewAccountsExpenses - EditAccountsTransactionAccounts - ViewAccountsTransactionAccounts - EditDocumentExplorer - ViewDocumentExplorer - ViewInventoryReports - EditInventoryPurchaseOrders - ViewInventoryPurchaseOrders - EditInventoryStockItems - ViewInventoryStockItems - EditInventorySupplier - ViewInventorySupplier - EditInventoryTrackingProfiles - ViewInventoryTrackingProfiles - ViewPayrollReports - EditPayrollHoliday - ViewPayrollHoliday - EditPayrollRota - ViewPayrollRota - EditPayrollStaff - ViewPayrollStaff - ViewSalesReports - ViewCostReports - ViewMenuReports type: string example: - ViewApp Features: description: Feature flags. These cannot be set by 3rd parties. type: array items: type: string example: - string MapCenter: $ref: '#/components/schemas/Coordinates' MapNorthEast: $ref: '#/components/schemas/Coordinates' MapSouthWest: $ref: '#/components/schemas/Coordinates' GoogleMapsApiKeyWeb: description: Key to be passed with Google Maps requests type: string example: string OrgId: description: Org Id type: string example: '500123' SmsRestaurantName: description: SMS Restaurant Name type: string example: Example Name WebToAppRedirect: description: Web to App Redirect settings enum: - NoRedirect - RedirectOnce - RedirectAlways - SuggestPwa - ForcePwa type: string example: NoRedirect Name: description: "App name. \r\nThis is used in various places on the Apple App Store, Google Play Store, mobile apps and websites." type: string example: Example Name HostName: description: HostName on which the web-ordering system is allowed to be hosted or that a Flipdish website is hosted on. type: string example: Example Name MainColor: description: Main color of the web / Android / iOS applications type: string example: string KioskPrimaryColour: description: Primary colour used on the Kiosk type: string example: string ApplicationCategory: description: Application Category enum: - Restaurant - Cafe - Convenience type: string example: Restaurant IsPanaceaEnabled: description: "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.\r\nThe alternative to using Panacea websites is to use a custom domain." type: boolean example: true PanaceaVanityUrl: description: In case of IsPanaceaEnabled is true, the app can be accessed via https://my.flipdish.com/{PanaceaVanityUrl} type: string example: https://api.flipdish.co/example CookieConsentPromptEnabled: description: Cookie Consent Prompt Enabled type: boolean example: true CountryId: description: "Country identifier in ISO 3166-1 alpha-2 format. \r\nThis code is set automatically based on the locations of the Stores in the App. \r\n\r\nThe App Country is used \r\n - to determine how to parse mobile phone numbers that are entered in their local numbering format\r\n - to determine if country specific payment methods should be offered\r\n - in various fraud checks" maxLength: 2 minLength: 0 type: string example: '500123' UserLoginEvent: description: User login event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string CatalogItem: description: CatalogItem required: - ItemType - Sku - Name - Price type: object properties: CatalogItemId: description: Unique catalog Item id maxLength: 30 minLength: 0 type: string example: '500123' IsArchived: description: Returns true if the item is archived type: boolean example: true Groups: description: Collection of groups associated with this item type: array items: $ref: '#/components/schemas/CatalogGroupReference' example: [] Metafields: description: Collection of metafields type: array items: $ref: '#/components/schemas/Metafield' example: [] ItemType: description: Type of item (Product, Modifier, etc) enum: - Product - Modifier type: string example: Product Sku: description: Stock Keeping Unit (SKU) maxLength: 30 minLength: 0 type: string example: string Name: description: Item name maxLength: 300 minLength: 0 type: string example: Example Name Description: description: Item description maxLength: 3000 minLength: 0 type: string example: string Price: format: double description: Item price minimum: 0 type: number example: 12.5 ImageFileName: description: Image File Name maxLength: 512 minLength: 0 type: string example: Example Name Alcohol: description: item contains alcohol type: boolean example: true Teammate: description: '' type: object properties: TeammateId: description: Unique indentifier type: string example: '500123' UserId: format: int32 description: User ID of the teammate type: integer nullable: true example: 500123 Name: description: Name type: string example: Example Name LastActivity: format: date-time description: Last activity type: string nullable: true example: '2026-06-02T12:00:00Z' AppId: description: Access level is for this App type: string example: '500123' InvitationStatus: description: Invitation status enum: - Pending - Accepted - Expired type: string example: Pending Email: description: Email address type: string example: owner@example.com AppAccessLevel: description: App access level enum: - None - Owner - StoreOwner - PropertyOwner - ManagedOwner - Integrator - PropertyManager - StoreManager - StoreStaff - StoreReadOnlyAccess - FinanceManger - Onboarding - Support type: string example: None HasAccessToAllStores: description: The user has access to all stores for the app (including new stores that added later) type: boolean example: true StoreIds: description: Store IDs the user has access to (if HasAccessToAllStores is false) type: array items: format: int32 type: integer example: - 1 PropertyIds: description: Property Ids the user has access to (if HasAccessToAllStores is false) type: array items: type: string example: - string MenuBulkEditEvent: description: Menu bulk event type: object properties: EventName: description: The event name type: string example: Example Name MenuName: description: Menu Name type: string example: Example Name Description: description: Description type: string example: string Item: description: Product type: string example: string InstanceCount: format: int32 description: Quantity of product type: integer example: 3 IsAvailable: description: Visibility of the item type: boolean example: true User: $ref: '#/components/schemas/UserEventInfo' MenuId: format: int32 description: The menu Id type: integer example: 500123 FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string CatalogItemCreatedEvent: description: '' type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' CatalogItem: $ref: '#/components/schemas/CatalogItem' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string LocationDeletedEvent: description: Event for logging the deleting of Locations type: object properties: LocationId: format: int32 description: Location Id type: integer example: 500123 LocationName: description: Location Name type: string example: Example Name DisplayOrder: format: int32 description: Location DisplayOrder type: integer example: 1 ExternalLocationId: description: Location ExternalLocationId type: string example: '500123' LocationAreaId: format: int32 description: LocationAreaId type: integer example: 500123 EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string OrderItem: description: Order item type: object properties: OrderItemOptions: description: Option list type: array items: $ref: '#/components/schemas/OrderItemOption' example: [] Metadata: description: Metadata type: object additionalProperties: type: string MenuItemPublicId: format: uuid description: Public id of the Menu Item type: string example: 00000000-0000-0000-0000-000000000000 MenuSectionName: description: Menu section name type: string example: Example Name MenuSectionDisplayOrder: format: int32 description: Menu section display order type: integer example: 1 Name: description: Name type: string example: Example Name Description: description: Description type: string example: string Price: format: double description: Price type: number example: 12.5 TaxAmount: format: double description: Tax currency amount type: number example: 12.5 PriceIncludingOptionSetItems: format: double description: Price including option set items type: number example: 12.5 MenuItemId: format: int32 description: Menu item identifier type: integer example: 500123 MenuItemDisplayOrder: format: int32 description: Menu item display order type: integer example: 1 IsAvailable: description: Is available type: boolean example: true DepositReturnFee: format: double description: Deposit return fee type: number nullable: true example: 12.5 BluetoothTerminalStatus: description: Status of the bluetooth terminal type: object properties: SerialNumber: description: Serial Number type: string example: string SoftwareVersion: description: Software Version type: string example: string DeviceType: description: Device Type enum: - CHIPPER_2X - COTS_DEVICE - VERIFONE_P400 - WISEPAD_3 - WISEPOS_E type: string example: CHIPPER_2X Status: description: Device Status enum: - Not_Connected - Connecting - Connected - Online - Offline type: string example: Not_Connected BatteryLevel: format: float description: Indication of the battery level from 0 to 1 type: number nullable: true example: 1.0 UpdateTime: format: date-time description: Last time the status was updated type: string example: '2026-06-02T12:00:00Z' ReaderId: description: ReaderId for Stripe Terminal type: string example: '500123' MenuUpdatedEvent: description: Menu updated event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' Menu: $ref: '#/components/schemas/Menu' MenuId: format: int32 description: Menu Id type: integer example: 500123 FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string GroupReference: description: Reference to an existing {Flipdish.Menus.PublicModels.V1.Catalog.Groups.Group} required: - CatalogItemId - GroupType type: object properties: Group: $ref: '#/components/schemas/Group' CatalogItemId: description: Identifier of the ProductId to use as SubProduct maxLength: 30 minLength: 0 type: string example: '500123' GroupType: description: Type of the SupProduct enum: - ModifierGroup type: string example: ModifierGroup FieldChangeInformation: description: Change information for a field type: object properties: Path: description: Path (hierarchy) type: string example: string Name: description: Name of field type: string example: Example Name Key: description: Key (code) of field type: string example: string OldValue: description: Old value type: string example: string NewValue: description: New value type: string example: string OrderFulfillmentStatusBase: description: Fulfillment Status Information type: object properties: StatusId: description: Fulfillment Status Id type: string example: '500123' StatusName: description: Fulfillment Status Name type: string example: Example Name Icon: description: Status Icon type: string example: string MobileAppsSubmissionStatusUpdatedEvent: description: Mobile Apps event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' MobileAppsSubmissionStatus: $ref: '#/components/schemas/MobileAppsSubmissionStatus' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string WebhookSubscriptionCreatedEvent: description: '' type: object properties: EventName: description: The event name type: string example: Example Name WebhookSubscriptionEventInfo: $ref: '#/components/schemas/WebhookSubscriptionEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreAddress: description: Store address type: object properties: AddressId: format: int32 description: Address identifier type: integer example: 500123 Coordinates: $ref: '#/components/schemas/Coordinates' Line1: description: Address line 1 type: string example: string Postcode: description: Postcode type: string example: string City: description: City type: string example: string CountryCode: description: Country code (ISO-alpha2) maxLength: 2 minLength: 0 type: string example: IE DisplayForCustomer: description: Display for customer type: string example: string AddressFields: description: Dyanmic field/value pairs, defined by the form assigned to the given country code. type: object additionalProperties: type: object SingleLineDisplay: description: Single line display i18n, may be empty for not supported countries type: string example: string TwoLinesDisplay: description: Two line display i18n, may be empty for not supported countries type: array items: type: string example: - string UpdateTipConfiguration: description: Describes the configuration of tipping type: object properties: IsEnabled: description: Are tips enabled? type: boolean example: true AllowCustomTips: description: Are custom tips allowed? type: boolean example: true AllowRoundUp: description: Is round up allowed? type: boolean example: true AllowEmojis: description: Are emojis allowed? type: boolean example: true Percentages: description: Ordered list of tip breakpoints (smallest -> largest) type: array items: format: double type: number example: - 1.0 DefaultPercentage: format: double description: Defines a default percentage, it must be in the list of Percentages type: number nullable: true example: 1.0 AppStoreConfigUpdatedEvent: description: AppStore Config Updated event type: object properties: EventName: description: The event name type: string example: Example Name AppStoreAppId: description: App Store Id type: string example: '500123' AppStoreAppConfiguration: $ref: '#/components/schemas/UpdateAppStoreAppConfigurationWebhookDTO' User: $ref: '#/components/schemas/UserEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string LoyaltyCampaign: description: Loyalty campaign type: object properties: CampaignId: format: int32 description: Id of campaign type: integer example: 500123 Statistics: $ref: '#/components/schemas/CampaignStatistics' Stores: description: Stores this campaign applies to with campaign start time in Utc type: array items: $ref: '#/components/schemas/StoreCampaignStartTime' example: [] PublicId: format: uuid description: Permanent reference to the item. type: string example: 00000000-0000-0000-0000-000000000000 OrdersBeforeReceivingVoucher: format: int32 description: Number of orders customer needs to make, before receiving voucher type: integer example: 1 PercentDiscountAmount: format: int32 description: Discount amount in percents maximum: 100 minimum: 1 type: integer nullable: true example: 12.5 MaxDiscount: format: double description: Maximum discount for percentage discounts minimum: 0 type: number nullable: true example: 3 RoundingStrategy: format: int32 description: Controls how the loyalty voucher's amount is rounded maximum: 2 minimum: 0 type: integer nullable: true example: 1 ShouldIncludeOrdersWithLoyaltyVoucher: description: Controls whether we should include orders with loyalty vouchers in the campaign calculation type: boolean nullable: true example: true VoucherValidPeriodDays: format: int32 description: Number of days for which the voucher will be valid. maximum: 300 minimum: 1 type: integer example: 1 IncludeDeliveryFee: description: Discount will include delivery fee type: boolean example: true AutoApplyResultingVouchers: description: Automatically apply resulting vouchers type: boolean example: true IncludeExistingOrders: description: Campaign will apply to existing orders type: boolean example: true IsEnabled: description: Is campaign enabled type: boolean example: true StoreIds: description: Ids of stores this campaign applies to type: array items: format: int32 type: integer example: - 1 AppId: description: The app that this campaign belongs to. type: string example: '500123' ForceDiscount: description: Controls whether the voucher generated from this campaign will override discount exclusions type: boolean example: true UserAnsweredSignupQuestionsEvent: description: User answered signup questions event type: object properties: EventName: description: The event name type: string example: Example Name User: $ref: '#/components/schemas/UserEventInfo' SignupAnswers: description: The users answers type: string example: string FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreDeletedEvent: description: Store Deleted Event type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer readOnly: true example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string Store: $ref: '#/components/schemas/Store' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreCreatedEvent: description: Store Created Event type: object properties: EventName: description: The event name type: string example: Example Name OrgId: description: Organisation Id type: string example: '500123' StoreId: format: int32 description: Store Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string Store: $ref: '#/components/schemas/Store' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string PrinterTurnedOnEvent: description: Printer turned on event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Printer: $ref: '#/components/schemas/Printer' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string DeliveryZoneUpdatedEvent: description: Delivery Zone Updated Event type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string DeliveryZone: $ref: '#/components/schemas/DeliveryZone' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string HydraUnAssignedEvent: description: Hydra unassigned event type: object properties: User: $ref: '#/components/schemas/UserEventInfo' HydraStatus: $ref: '#/components/schemas/HydraStatus' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreKioskSetting: description: Store Kiosk Settings type: object properties: KioskSettingId: format: int32 description: Kiosk setting id type: integer example: 500123 KioskName: description: Store kiosk name type: string example: Example Name RequireCustomerName: description: Require customer name flag type: boolean example: true RequireCustomerPhoneNumber: description: Require customer phone number flag type: boolean example: true RequestCustomerPhoneNumber: description: Request customer phone number flag (Option to Skip) type: boolean example: true RequestTableNumber: description: Request table number flag type: boolean example: true OfferDineInOrTakeawayOption: description: Offer Dine-In/Takeaway option flag type: boolean example: true PhysicalRestaurantId: format: int32 description: Physical restaurant id type: integer example: 500123 HydraConfigId: format: int32 description: Hydra config id type: integer example: 500123 CustomerDeliveryTrackingOrder: description: Defines the order data required for customer driver tracking type: object properties: OrderId: format: int32 description: Order Id type: integer example: 500123 Address: description: Pretified address string in country format type: string example: string DeliveryNotes: description: Delivery Notes type: string example: string StorePhoneNumber: description: Phone number of the store type: string example: '+353000000000' AppIconUrl: description: App Icon of the store type: string example: https://api.flipdish.co/example OrderTrackingCode: description: Order Tracking Code type: string example: string PaymentMethodDescription: description: Payment method description i.e Cash/Card/iDeal/Paypal type: string example: string LastFourDigits: description: Last 4 digits of the card if applicable otherwise null type: string example: string OrderLines: description: Order lines of the order type: array items: $ref: '#/components/schemas/CustomerDeliveryTrackingOrderLine' example: [] TotalAmount: format: double description: Total amount for the order including tax type: number example: 12.5 Currency: description: Currency enum: - 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 type: string example: EUR Latitude: format: double description: Customer Location Latitude type: number example: 1.0 Longitude: format: double description: Customer Location Longitude type: number example: 1.0 Placed: format: date-time description: Order placed time type: string example: '2026-06-02T12:00:00Z' RequestedFor: format: date-time description: Order requested for type: string example: '2026-06-02T12:00:00Z' DriverId: format: int32 description: Driver Id type: integer nullable: true example: 500123 DriverName: description: Driver Name type: string example: Example Name DriverImage: description: Driver Image type: string example: string EstimatedMinutesForDelivery: format: int32 description: '' type: integer example: 1 AppStoreSubscriptionChangeJobUpdatedEvent: description: Subscription change job status updated event type: object properties: EventName: description: The event name type: string example: Example Name AppStoreAppId: description: App Store Id type: string example: '500123' Status: description: Status type: string example: Active FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string Channel: description: Channel. type: object properties: ChannelId: format: int32 description: Channel Id type: integer example: 500123 TranslationKey: description: Channel TranslationKey type: string example: string Source: description: Channel Source enum: - Internal - External type: string example: Internal LogoUri: description: Channel Logo URl type: string example: https://api.flipdish.co/example Available: description: Channel is Available or not type: boolean example: true MaintainedExternally: description: Channel is Maintained Externally or not type: boolean example: true StoreNote: description: Store note type: object properties: UserId: format: int32 description: User identifier type: integer example: 500123 CreateTime: format: date-time description: Create time type: string example: '2026-06-02T12:00:00Z' Note: description: Note type: string example: string Store: description: Store type: object properties: StoreId: format: int32 description: Store identifier type: integer example: 500123 StoreGroupId: format: int32 description: Store group id to which this store belongs type: integer example: 500123 Address: $ref: '#/components/schemas/StoreAddress' DeliveryZones: description: Delivery zones type: array items: $ref: '#/components/schemas/DeliveryZone' example: [] ApmPhoneNumber: description: Automated Phone Marketing number type: string example: '+353000000000' PickupHours: description: Pickup hours type: array items: $ref: '#/components/schemas/BusinessHoursPeriod' example: [] DeliveryHours: description: Delivery hours type: array items: $ref: '#/components/schemas/BusinessHoursPeriod' example: [] MenuId: format: int32 description: Menu identifier type: integer example: 500123 OrderConfirmationMessageOverrideDelivery: description: Overridden confirmation message for delivery orders type: string example: string OrderConfirmationMessageOverridePickup: description: Overridden confirmation message for pickup orders type: string example: string PrintoutLayoutType: description: Printout layout enum: - Default - Centra - SmallChefNotes - SmallChefNotesAndCentra type: string nullable: true example: Default StoreNotes: description: Store notes type: array items: $ref: '#/components/schemas/StoreNote' example: [] MicrosoftTimeZone: description: "Microsoft Time Zone Index Values (https://msdn.microsoft.com/en-us/library/ms912391)\r\n(Editable through store coordinate change)" type: string example: string IanaTimeZone: description: "IANA Time Zone (https://www.iana.org/time-zones)\r\n(Editable through store coordinate change)" type: string example: string Currency: description: Currency (derived from Store Group) enum: - 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 type: string example: EUR PreOrderDeliveryEnabled: description: Is PerOrder Enabled for Delivery type: boolean example: true PreOrderPickupEnabled: description: Is PerOrder Enabled for Pickup type: boolean example: true LogoUrl: description: Url for logo image type: string example: https://api.flipdish.co/example FraudPreventionStrategy: description: Fraud Prevention Strategy type: string example: string AppIds: description: Store's app ids type: array items: type: string example: - string PropertyId: description: Property Id type: string example: '500123' PhoneNumber: description: Phone number type: string example: '+353000000000' AlwaysAppearOpen: description: True if the store always appears open type: boolean example: true PreOrderEnabled: description: True if the store accepts pre-orders type: boolean example: true TakeOutEnabled: description: True if the store accepts take-out orders type: boolean example: true TableServiceEnabled: description: True if the store has table service type: boolean example: true DineInEnabled: description: True if the store accepts dine-in orders type: boolean example: true AllowPreOrdersAndTableService: description: True if both pre-orders and talbe service can be enabled type: boolean example: true PickupEnabled: description: True if the store accepts pickup orders type: boolean example: true DeliveryEnabled: description: True if the store accepts delivery orders type: boolean example: true CardOrderDeliveryEnabled: description: True if the store accepts card payment for delivery orders type: boolean example: true CashOrdersDeliveryEnabled: description: True if the store accepts cash payment for delivery orders type: boolean example: true CardOrdersPickupEnabled: description: True if the store accepts card payment for pickup orders type: boolean example: true CashOrdersPickupEnabled: description: True if the store accepts cash payment for pickup orders type: boolean example: true TipsEnabled: description: True if the store accepts tips type: boolean example: true AutomaticallyAcceptOrders: description: True if the stores orders are automatically accepted in Flipdish type: boolean example: true OpenForDelivery: description: True if the store is open for delivery type: boolean example: true OpenForPickup: description: True if the store is open for pickup type: boolean example: true MinimumPickupOrderAmount: format: double description: Minimum pickup order amount type: number example: 12.5 RequireCustomerNameForPickup: description: True if customer name required for pickup orders type: boolean example: true GdprCustomerPhoneNumbers: description: Mask your customers phone numbers printed on receipts and reduce the amout of personally identifiable customer information that is exposed. type: boolean example: true RequireCustomerNameForDelivery: description: True if customer name required for delivery orders type: boolean example: true AllowChefNotes: description: True if the customer is allowed enter custom notes with their orders type: boolean example: true EtaInPickupConfirmationSmsEnabled: description: True if order confirmation sms includes estimated time when order will be ready for collection type: boolean example: true EtaInDeliveryConfirmationSmsEnabled: description: True if order confirmation sms includes estimated time when order will delivered type: boolean example: true IsArchived: description: Is the Store Archived type: boolean example: true IsPublished: description: Is the Store Published type: boolean example: true Name: description: Name type: string example: Example Name EmailAddress: description: Email address (visible to customers) maxLength: 100 minLength: 0 type: string example: owner@example.com StaffLanguage: description: "Staff Language (used for communication with the staff)\r\nEmails, Printouts etc" type: string example: string SalesChannelTypes: description: Sales Channel Types type: array items: enum: - Web - App - Kiosk - Pos - None type: string example: - Web InheritanceConfigTypes: description: Inheritance Config Types type: array items: enum: - CollectionSettings type: string example: - CollectionSettings CreditNoteDetails: description: Credit note details type: object properties: RemainingCredit: format: double description: Remaining credit type: number example: 1.0 CustomerDeliveryTrackingOrderLine: description: Defines an order line for driver tracking type: object properties: ItemName: description: Item name from the order type: string example: Example Name SelectedOptions: description: Selected option names type: array items: type: string example: - string OrderDeliveryTrackingStatusUpdatedEvent: description: '' type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string Order: $ref: '#/components/schemas/Order' DeliveryIntegrationName: description: Delivery integration name type: string example: Example Name DeliveryErrorMessage: description: Delivery error message (optional) type: string example: string FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string OrderBatchSummary: description: Order batch info type: object properties: Id: format: int32 description: Order batch id type: integer example: 500123 DisplayCode: description: Order batch 6-sign human readable code type: string example: string CreateTime: format: date-time description: Batch creation date and time type: string example: '2026-06-02T12:00:00Z' IsPublished: description: If the batch is already published type: boolean example: true CatalogGroupReference: description: Reference to an existing {Flipdish.Menus.PublicModels.V1.Catalog.Groups.Group} required: - CatalogGroupId - GroupType type: object properties: Group: $ref: '#/components/schemas/Group' CatalogGroupId: description: Identifier of the ProductId to use as SubProduct maxLength: 30 minLength: 0 type: string example: '500123' CatalogItemId: description: Identifier of the ProductId to use as SubProduct maxLength: 30 minLength: 0 type: string example: '500123' GroupType: description: Type of the SupProduct enum: - ModifierGroup type: string example: ModifierGroup LoyaltyCampaignDeletedEvent: description: Loyalty campaign deleted event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string StoreId: format: int32 description: Store Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' LoyaltyCampaign: $ref: '#/components/schemas/LoyaltyCampaign' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string PromotionAward: description: Promotion type: object properties: PromotionAwardId: format: int32 description: Promotion Award Id type: integer example: 500123 MenuItemPublicId: format: uuid description: The public id of the menu item that will be awarded type: string example: 00000000-0000-0000-0000-000000000000 MaskedPhoneNumber: description: Represents a masked phone number type: object properties: IsEnabled: description: Defines if the feature is enabled type: boolean example: true PhoneNumber: description: Defines the phone number to call type: string example: '+353000000000' Code: description: Defines the code to enter type: string example: string Language: description: Sorted Language type: object properties: LanguageId: description: ISO 639-1 Language Code type: string example: '500123' DisplayOrder: format: int32 description: Display Order type: integer example: 1 Name: description: Language Name type: string example: Example Name Enabled: description: Is the language enabled for use. type: boolean example: true HydraStatus: description: Hydra status required: - AppId - IsRegistered type: object properties: AppId: description: '' type: string example: '500123' StoreIds: description: Store to assign the hydra type: array items: format: int32 type: integer example: - 1 IsRegistered: description: The device has been already registered type: boolean example: true PinCode: format: int32 description: 6 digit PIN code (not starting with zero). maximum: 999999 minimum: 100000 type: integer nullable: true example: 1 Images: description: Hydra images (covers) type: array items: type: string example: - string UserType: description: Hydra User Type enum: - Kiosk - Terminal - LegacyPrinter type: string example: Kiosk BusinessHoursOverride: description: '' required: - StartTime - EndTime type: object properties: BusinessHoursOverrideId: format: int32 description: Unique identifier type: integer example: 500123 DeliveryType: description: Delivery or Pickup enum: - Delivery - Pickup type: string example: Delivery StartTime: format: date-time description: Date and time in ISO 8601 format. type: string example: '2026-06-02T12:00:00Z' EndTime: format: date-time description: Date and time in ISO 8601 format. type: string example: '2026-06-02T12:00:00Z' Type: description: Open, Closed or ClosedAllowPreOrders enum: - Open - Closed - ClosedAllowPreOrders type: string example: Open Menu: description: Menu type: object properties: MenuId: format: int32 description: Menu identifier type: integer example: 500123 ModifiedTime: format: date-time description: Last modified time type: string example: '2026-06-02T12:00:00Z' VersionNumber: format: int32 description: Menu version type: integer example: 3 ImageName: description: Image Name type: string example: Example Name ImageUrl: description: Image url type: string example: https://api.flipdish.co/example Name: description: Name of Menu, only shown in portal type: string example: Example Name Locked: description: 'Locked: is menu locked against modifcation' type: boolean example: true MenuSections: description: Menu sections (startes, main etc) type: array items: $ref: '#/components/schemas/MenuSection' example: [] TaxRates: description: Menu tax rates type: array items: $ref: '#/components/schemas/MenuTaxRate' example: [] AppId: description: Identifier of App the menu is attached to type: string example: '500123' DisplaySectionLinks: description: Display menu section link on UI type: boolean example: true MenuSectionBehaviour: description: Menu section behaviour enum: - ExpandSingle - ExpandMultiple type: string example: ExpandSingle TaxType: description: Tax type enum: - IncludedInBasePrice - ExcludedFromBasePrice type: string example: IncludedInBasePrice IsIntegrated: description: Flag to indicate if the menu is integrated (contains metadata) type: boolean example: true BusinessHoursPeriod: description: Business hours period type: object properties: Early: $ref: '#/components/schemas/Range' Late: $ref: '#/components/schemas/Range' Ranges: description: Ranges type: array items: $ref: '#/components/schemas/Range' example: [] DayOfWeek: description: Day of week enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday type: string example: Sunday StartTime: description: Start time type: string example: '2026-06-02T12:00:00Z' Period: description: Period type: string example: string StartTimeEarly: description: Start time early type: string example: string PeriodEarly: description: Period early type: string example: string Group: description: CatalogGroup required: - GroupType - Sku - Name type: object properties: CatalogGroupId: description: Unique catalog group id maxLength: 30 minLength: 0 type: string example: '500123' CatalogItemId: description: Unique catalog item id maxLength: 30 minLength: 0 type: string example: '500123' IsArchived: description: Returns true if the group is archived type: boolean example: true MinSelectCount: format: int32 description: Minimum number of items that the user has to select type: integer example: 3 MaxSelectCount: format: int32 description: Maximum number of items that the user has to select type: integer nullable: true example: 3 Products: description: Collection of items associated with this product type: array items: $ref: '#/components/schemas/ProductReference' example: [] Metafields: description: Collection of metafields type: array items: $ref: '#/components/schemas/Metafield' example: [] GroupType: description: Type of group (ModifierGroup, etc) enum: - ModifierGroup type: string example: ModifierGroup Sku: description: Stock Keeping Unit (SKU) maxLength: 30 minLength: 0 type: string example: string Name: description: Group name maxLength: 300 minLength: 0 type: string example: Example Name AutogenerateDisplayText: description: Autogenerate display text in ordering applications type: boolean example: true ImageFileName: description: Image File Name maxLength: 512 minLength: 0 type: string example: Example Name StoreServiceChargeUpdatedEvent: description: Service Charge Updated Event type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string ServiceCharge: $ref: '#/components/schemas/ServiceCharge' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string DeliveryZoneDeletedEvent: description: Delivery Zone Deleted Event type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string DeliveryZone: $ref: '#/components/schemas/DeliveryZone' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreAddressUpdatedEvent: description: Store Address Updated Event type: object properties: EventName: description: The event name type: string example: Example Name OrgId: description: Organisation Id type: string example: '500123' StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string StoreAddress: $ref: '#/components/schemas/StoreAddress' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string ServiceCharge: description: Store Service Charge type: object properties: StoreId: format: int32 description: Store identifier type: integer example: 500123 PercentageValue: format: double description: The Default Service Charge Value type: number example: 1.0 Enabled: description: Enable Service Charge for store true(on) / false(off) type: boolean example: true IsOptional: description: Sets the service charge to be optional type: boolean example: true DisplayWithProcessingFee: description: Display service charge together with processing fee type: boolean example: true IncludesVouchers: description: "If true, will include voucher value in calculation \r\ni.e 10E order with 1E service charge and 5E voucher would have service charge at 0.5E" type: boolean example: true KioskBluetoothTerminalCancelUpdateEvent: description: Kiosk bluetooth Cancel Update Install Event type: object properties: DeviceId: description: Device Id of the Kiosk type: string example: '500123' BluetoothTerminalType: description: Terminal Type enum: - CHIPPER_2X - COTS_DEVICE - VERIFONE_P400 - WISEPAD_3 - WISEPOS_E type: string example: CHIPPER_2X User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string TeammateUpdatedEvent: description: '' type: object properties: Teammate: $ref: '#/components/schemas/Teammate' User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string KioskBluetoothTerminalInitiateUpdateCheckEvent: description: Kiosk bluetooth trigger update check event type: object properties: DeviceId: description: Device Id of the Kiosk type: string example: '500123' User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string WebhookSubscriptionDeletedEvent: description: '' type: object properties: EventName: description: The event name type: string example: Example Name WebhookSubscriptionEventInfo: $ref: '#/components/schemas/WebhookSubscriptionEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string MenuItemOptionSetItem: description: Menu item option set item type: object properties: MenuItemOptionSetItemId: format: int32 description: Menu item option set item identifier type: integer example: 500123 PublicId: format: uuid description: Permanent reference to the item. type: string example: 00000000-0000-0000-0000-000000000000 Metadata: description: List of metadata type: array items: $ref: '#/components/schemas/CreateMetadata' example: [] NextMenuItemOptionSetId: format: int32 description: if null, next option set is next. if -1, this is the final option set type: integer nullable: true example: 500123 CatalogItemId: description: Catalog item Id when the OptionSet is associated to a Product type: string example: '500123' TaxRateName: description: Tax rate name type: string example: Example Name TaxRateId: format: int32 description: TaxRateId. type: integer nullable: true example: 500123 TaxValue: format: double description: TaxValue. type: number example: 1.0 Name: description: Name type: string example: Example Name Price: format: double description: Price type: number example: 12.5 DepositReturnFee: format: double description: An optional fee that can be added to the price of the item. type: number nullable: true example: 12.5 IsAvailable: description: Is available type: boolean example: true DisplayOrder: format: int32 description: Display order. Displayed in ascending order. type: integer example: 1 CellLayoutType: description: "Small | Medium | Large\r\nAffects the layout of the menu." enum: - Small - Medium - Large - HiddenImage type: string example: Small ImageUrl: description: Image url type: string example: https://api.flipdish.co/example KioskBluetoothTerminalFirmwareVersionStatusEvent: description: Kiosk Stripe Terminal Update info received event type: object properties: DeviceId: description: Device Id of the Kiosk type: string example: '500123' SerialNumber: description: Serial Number of the device type: string example: string HasFirmwareUpdate: description: Indicates if Payment Terminal has Firmware Update type: boolean example: true HasConfigUpdate: description: Indicates if Payment Terminal has Config Update type: boolean example: true HasKeyUpdate: description: Indicates if Payment Terminal has Key Update type: boolean example: true UpdateTimeEstimate: description: ETA to install the update enum: - LessThanOneMinute - OneToTwoMinutes - TwoToFiveMinutes - FiveToFifteenMinutes type: string example: LessThanOneMinute UserEventInfo: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string KioskBluetoothTerminalInstallationStatusEvent: description: Kiosk bluetooth terminal Installation Status type: object properties: DeviceId: description: Device Id of the Kiosk type: string example: '500123' BluetoothTerminalType: description: Terminal Type enum: - CHIPPER_2X - COTS_DEVICE - VERIFONE_P400 - WISEPAD_3 - WISEPOS_E type: string example: CHIPPER_2X BluetoothTerminalSerialNumber: description: Serial number of the terminal type: string example: string User: $ref: '#/components/schemas/UserEventInfo' Progress: format: int32 description: Update Install Progress for Card Reader type: integer nullable: true example: 1 EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string KioskBluetoothUnpairingModeEvent: description: Kiosk Bluetooth Unpairing mode initiated type: object properties: DeviceId: description: Device Id of the Kiosk type: string example: '500123' BluetoothTerminalType: description: Terminal Type enum: - CHIPPER_2X - COTS_DEVICE - VERIFONE_P400 - WISEPAD_3 - WISEPOS_E type: string example: CHIPPER_2X User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string PrinterAssignedToStoreEvent: description: Printer assigned to store event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Printer: $ref: '#/components/schemas/Printer' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreGroupCreatedEvent: description: Store Group Created Event type: object properties: EventName: description: The event name type: string example: Example Name StoreGroupId: format: int32 description: Store Group Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string StoreGroup: $ref: '#/components/schemas/StoreGroup' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string BankAccountDeletedEvent: description: '' type: object properties: OrgId: description: Organisation Id type: string example: '500123' BankAccount: $ref: '#/components/schemas/BankAccount' User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string DeliveryZone: description: Delivery Zone type: object properties: Id: format: int32 description: Delivery Fee Area Id type: integer example: 500123 FeeChargedToStore: format: double description: Delivery Fee charged to store type: number nullable: true example: 12.5 DeliveryFee: format: double description: Delivery fee (will not be set below 0) type: number example: 12.5 MinimumDeliveryOrderAmount: format: double description: Minimum delivery order amount (will not be set below 0) type: number example: 12.5 WellKnownText: description: "Spatial data in Well Known Text format\r\nWe also support CIRCLE((0 0, 200)) - (centerLong centerLat, radius in m)" type: string example: string IsEnabled: description: Is delivery zone enabled type: boolean example: true StoreBusinessHoursOverrideCreatedEvent: description: Store Business Hours Override Created type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string BusinessHoursOverride: $ref: '#/components/schemas/BusinessHoursOverride' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string Range: description: "A class that represents a single opening period in a day.\r\nThis starts 'StartTime' after midnight and runs for a 'Period'\r\nafter that, on the given DayOfWeek." type: object properties: StartTime: description: Start time type: string example: '2026-06-02T12:00:00Z' Period: description: Period type: string example: string DayOfWeek: description: Day of week enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday type: string example: Sunday PushNotificationDeletedEvent: description: '' type: object properties: EventName: description: The event name type: string example: Example Name Description: description: '' type: string example: string PushNotification: $ref: '#/components/schemas/PushNotificationRequest' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string Order: description: Order type: object properties: Store: $ref: '#/components/schemas/StoreSummary' Customer: $ref: '#/components/schemas/CustomerSummary' Voucher: $ref: '#/components/schemas/OrderVoucherSummary' Fees: $ref: '#/components/schemas/FeeSummary' OrderItems: description: Ordered items type: array items: $ref: '#/components/schemas/OrderItem' example: [] DeliveryLocation: $ref: '#/components/schemas/DeliveryLocation' CustomerLocation: $ref: '#/components/schemas/Coordinates' MaskedPhoneNumber: $ref: '#/components/schemas/MaskedPhoneNumber' DropOffLocationId: format: int32 description: Represents table service drop off location type: integer nullable: true example: 500123 DropOffLocation: description: Represents table service drop off location type: string example: string AcceptedFor: format: date-time description: Time store has accepted the order for type: string nullable: true example: '2026-06-02T12:00:00Z' InFraudZone: description: Was order made within a fraud zone type: boolean example: true UnusualHighValueOrder: description: Is order of unusually high value type: boolean example: true RejectedByUserId: format: int32 description: Id of user who rejected order, if available type: integer nullable: true example: 500123 ChannelOrderId: description: ChannelOrderId from external channel type: string example: '500123' ChannelOrderDisplayId: description: ChannelOrderDisplayId from external channel type: string example: '500123' Channel: $ref: '#/components/schemas/Channel' OrderDropOffLocation: $ref: '#/components/schemas/OrderDropOffLocation' FulfillmentStatus: $ref: '#/components/schemas/OrderFulfillmentStatusBase' OrderBatchInfo: $ref: '#/components/schemas/OrderBatchSummary' TaxItems: description: A collection of tax items on the order. type: array items: $ref: '#/components/schemas/TaxItem' example: [] CreatedCampaignVoucherId: format: int32 description: The id of the campaign voucher that was created from this order type: integer nullable: true example: 500123 OrderId: format: int32 description: Order identifier type: integer example: 500123 LocalOrderId: description: Local order Id. This is used for displaying a "shorter" order ID for customers (eg. Kiosk orders) type: string example: '500123' DeliveryType: description: Delivery type enum: - Delivery - Pickup type: string example: Delivery PickupLocationType: description: Pickup location type enum: - TakeOut - TableService - DineIn type: string example: TakeOut TableServiceCatagory: description: Pickup location type enum: - Generic - Villa - House - Room - Area - Table - ParkingBay - Gate - DriveThrough - Team type: string nullable: true example: Generic TipAmount: format: double description: Tip amount type: number example: 12.5 DeliveryAmount: format: double description: Delivery amount type: number example: 12.5 OrderItemsAmount: format: double description: Ordered items amount type: number example: 12.5 ServiceChargeAmount: format: double description: Service Charge Amount type: number example: 12.5 ServiceChargePercentage: format: double description: Service Charge Percentage type: number example: 1.0 Amount: format: double description: "This is the sum of the OrderItemsAmount, DeliveryAmount, TipAmount and Voucher.Amount (which is usually negative) and OnlineOrderingFee for cash orders.\r\nIt does not include the OnlineOrderingFee in the case of card orders as this fee is charged by Flipdish directly to the customer." type: number example: 12.5 ProcessingFee: format: double description: 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. type: number example: 12.5 PaymentAccountType: description: Payment account type enum: - Card - Cash - Ideal - Bancontact - Giropay - Eps - Emv - PayPal - PayGreen - GoogleWalletToken type: string example: Card PaymentAccountDescription: description: Payment account description (like Visa ****2371 or Apple Pay. or Cash) type: string example: string OrderState: description: Order state enum: - Created - PlacedCanBeCancelled - ReadyToProcess - AcceptedByRestaurant - Dispatched - Delivered - Cancelled - ManualReview - RejectedByStore - RejectedByFlipdish - RejectedAutomatically - RejectedAfterBeingAccepted - AcceptedAndRefunded - PendingPayment type: string example: Created IsPreOrder: description: Is pre-order type: boolean example: true PlacedTime: format: date-time description: Order placed time type: string example: '2026-06-02T12:00:00Z' RequestedForTime: format: date-time description: Order requested for type: string example: '2026-06-02T12:00:00Z' ChefNote: description: Chef note type: string example: string AppType: description: Used app type enum: - Unknown - Ios - Android - Web - Kiosk - Pos - TelephoneCall - Sms - PwaAndroid - PwaIos - Google type: string example: Unknown UserRating: format: int32 description: User rating type: integer nullable: true example: 1 PaymentStatus: description: Status of the payment enum: - Paid - Unpaid - Refunded - PartiallyRefunded - Disputed type: string example: Paid RejectionReason: description: Rejection reason. Can have value if the order is rejected. enum: - TooBusy - FoodUnavailable - UnableToDeliver - UnknownAddress - UnknownReason - TooSoon - TimeUnavailable - DontDeliverToArea - StoreUncontactable type: string nullable: true example: TooBusy RefundedAmount: format: double description: Amount refunded to customer. type: number nullable: true example: 12.5 DeliveryTrackingStatus: description: Delivery tracking status enum: - Unassigned - Unaccepted - Accepted - Carrying - OnTheWay - ArrivedAtLocation - Delivered - CannotDeliver type: string nullable: true example: Unassigned DriverId: format: int32 description: Assigned driver identifier type: integer nullable: true example: 500123 TotalTax: format: double description: Total tax applied to order type: number example: 12.5 OrderTrackingCode: description: Unique, 6 character long alpha numeric code for tracking. type: string example: string DeliveryFeeAreaId: format: int32 description: Delivery area identifier type: integer nullable: true example: 500123 ReceiptCode: description: Code used to view the order's receipt type: string example: string TotalDepositReturnFeeAmount: format: double description: This contains the total deposit return fee amount for the order. type: number example: 12.5 VoucherAppliedEvent: description: Voucher Applied Event type: object properties: VoucherId: format: int32 description: Voucher Id type: integer example: 500123 EventName: description: The event name type: string example: Example Name OrderId: format: int32 description: Order id type: integer example: 500123 FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string HydraRequestResetEvent: description: Hydra request reset event type: object properties: User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string DeliveryZoneCreatedEvent: description: Delivery Zone Created Event type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string DeliveryZone: $ref: '#/components/schemas/DeliveryZone' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string OrderRejectedEvent: description: Order Rejected Event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string OrderRejectedTime: format: date-time description: Order Rejected Time type: string example: '2026-06-02T12:00:00Z' Reason: description: Reason for Rejection type: string example: string User: $ref: '#/components/schemas/UserEventInfo' Order: $ref: '#/components/schemas/Order' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string MobileAppsSubmissionStatus: description: Mobile Apps Status type: object properties: MobileAppsSubmissionStatusId: format: int32 description: Mobile Apps Submission Status Id type: integer example: 500123 MobileAppsSubmissionId: format: int32 description: Mobile Apps Submission Id type: integer example: 500123 Type: description: Mobile Type enum: - None - Android - IOS type: string example: None AppStatus: description: Mobile App Status enum: - None - Published - Unpublished type: string example: None UpdateStatus: description: Mobile App Status enum: - None - Submitted - InReview - Rejected - Approved - Published type: string example: None LastUpdateStatusTime: format: date-time description: Mobile LastUpdateStatusTime type: string nullable: true example: '2026-06-02T12:00:00Z' CreateTime: format: date-time description: Mobile CreateTime type: string example: '2026-06-02T12:00:00Z' UpdateTime: format: date-time description: Mobile UpdateTime type: string nullable: true example: '2026-06-02T12:00:00Z' Notes: description: Mobile Notes type: string example: string CreateMetadata: description: Create metadata type: object properties: StoreId: format: int32 description: Store identifier type: integer example: 500123 Key: description: Metadata key (Unique identifier) maxLength: 128 minLength: 0 type: string example: string Value: description: Metadata value maxLength: 4000 minLength: 0 type: string example: string MenuCheckpointCreatedEvent: description: '' type: object properties: Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' Menu: $ref: '#/components/schemas/Menu' MenuId: format: int32 description: Menu Id type: integer example: 500123 EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string OrderVoucherSummary: description: Voucher summary type: object properties: VoucherId: format: int32 description: Voucher ID type: integer example: 500123 Name: description: Voucher name type: string example: Example Name Description: description: Voucher description type: string example: string Code: description: Voucher code type: string example: string Amount: format: double description: Voucher amount type: number example: 12.5 Type: description: Voucher type enum: - PercentageDiscount - LumpDiscount - AddItem - CreditNote - FreeDelivery type: string example: PercentageDiscount SubType: description: Voucher sub type enum: - None - SignUp - Loyalty - Loyalty25 - Retention - SecondaryRetention - Custom type: string example: None TeammateDeletedEvent: description: '' type: object properties: Teammate: $ref: '#/components/schemas/Teammate' User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string AnalyticsClientEvent: description: Client Analytics event type: object properties: EventName: description: The event name type: string example: Example Name EventType: description: Type of the event type: string example: string AppType: description: Type of the app the event is coming from type: string example: string Metadata: description: JSON Metadata type: string example: string UserId: format: int32 description: User Id type: integer nullable: true example: 500123 Latitude: format: double description: Latitude of the event type: number nullable: true example: 1.0 Longitude: format: double description: Longitude of the event type: number nullable: true example: 1.0 FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string CatalogItemArchivedEvent: description: '' type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' CatalogItem: $ref: '#/components/schemas/CatalogItem' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string MenuSectionDeletedEvent: description: '' type: object properties: MenuId: format: int32 description: Menu identifier type: integer example: 500123 Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' MenuSection: $ref: '#/components/schemas/MenuSection' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string MenuItemOptionSetDeletedEvent: description: '' type: object properties: MenuId: format: int32 description: Menu identifier type: integer example: 500123 Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' MenuItemOptionSet: $ref: '#/components/schemas/MenuItemOptionSet' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string DeviceSettings: description: Device settings for Hydra required: - Volume - FontSize - Brightness type: object properties: Volume: format: int32 description: Gets or sets the device volume maximum: 10 minimum: 0 type: integer example: 1 FontSize: format: double description: Gets or sets the font size used on the device maximum: 100 minimum: 1 type: number example: 1.0 Brightness: format: int32 description: Gets or sets the display brightness on the device maximum: 100 minimum: 0 type: integer example: 1 StoreBusinessHoursOverrideDeletedEvent: description: Store Business Hours Override Deleted type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string BusinessHoursOverride: $ref: '#/components/schemas/BusinessHoursOverride' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreFeeConfigUpdatedEvent: description: Fee Config Updated Event type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string Changes: description: Diff between before and after type: string example: string StoreFeeConfig: $ref: '#/components/schemas/StoreFeeConfig' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string ExternalStoreEvent: description: External event type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string DescriptionFormat: description: Description with format placeholders type: string example: '2026-06-02T12:00:00Z' DescriptionFields: description: Description with format placeholders type: string example: string DescriptionId: description: Description type: string example: '500123' Ref1: description: Ref (reference field) type: string example: string Ref2: description: Ref2 (reference field) type: string example: string Ref3: description: Ref3 (reference field) type: string example: string Ref4: description: Ref4 (reference field) type: string example: string OrderId: format: int32 description: Order Id type: integer nullable: true example: 500123 Tags: description: Tags type: array items: type: string example: - string FieldChanges: description: Field changes list type: array items: $ref: '#/components/schemas/FieldChangeInformation' example: [] FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string CatalogGroupUpdatedEvent: description: '' type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' Group: $ref: '#/components/schemas/Group' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string TeammateInviteAcceptedEvent: description: '' type: object properties: Teammate: $ref: '#/components/schemas/Teammate' User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string LoyaltyCampaignCreatedEvent: description: Loyalty campaign created event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string StoreId: format: int32 description: Store Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' LoyaltyCampaign: $ref: '#/components/schemas/LoyaltyCampaign' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreLogoCreatedEvent: description: Store logo created type: object properties: EventName: description: The event name type: string example: Example Name OrgId: description: Organisation Id type: string example: '500123' StoreId: format: int32 description: ID of store that the logo has been added to type: integer example: 500123 LogoUrl: description: Url of logo type: string example: https://api.flipdish.co/example Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string MenuCreatedEvent: description: Menu created event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' Menu: $ref: '#/components/schemas/Menu' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string HydraSettingChangedEvent: description: Hydra settings changed type: object properties: User: $ref: '#/components/schemas/UserEventInfo' HydraConfig: $ref: '#/components/schemas/HydraConfig' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string PrinterUnassignedFromStoreEvent: description: Printer assigned from store event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Printer: $ref: '#/components/schemas/Printer' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string UserCreatedEvent: description: User created event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string TelephonyConfig: description: Phone call type: object properties: TelephonyConfigId: format: int32 description: ID of the phone call type: integer example: 500123 ApmEnabled: description: APM enabled flag type: boolean example: true Type: description: Type of telephony service enum: - PreRecorded - VoiceAI type: string example: PreRecorded ConsentEnabled: description: Consent enabled flag type: boolean example: true PhoneNumber: description: APM phone number of the store type: string example: '+353000000000' SendAppLinkSms: description: Send app link SMS flag type: boolean example: true UseCustomAppLinkSmsMessage: description: Use custom app link SMS message flag type: boolean example: true UseCustomVoiceMessage: description: Use custom voice message flag type: boolean example: true AppLinkSmsMessage: description: App link SMS message type: string example: https://api.flipdish.co/example ResendApmMessageAfterDays: format: int32 description: Amount of days to resend APM message type: integer example: 1 UserDeletedEvent: description: User deleted event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string DnsVerifiedEvent: description: The DNS for the Hostname verified type: object properties: Hostname: description: Description type: string example: Example Name EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string PrinterTurnedOffEvent: description: Printer turned off event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Printer: $ref: '#/components/schemas/Printer' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string HydraStoreAssignedEvent: description: Hydra store\s assigned event type: object properties: User: $ref: '#/components/schemas/UserEventInfo' StoreIds: description: Store\s to assign hydra to type: array items: format: int32 type: integer example: - 1 EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string ChannelStoresUpdatedEvent: description: Channel Stores Updated Event type: object properties: EventName: description: The event name type: string example: Example Name ChannelId: format: int32 description: ID of the channel type: integer example: 500123 StoreIds: description: List of store ids type: array items: format: int32 type: integer example: - 1 User: $ref: '#/components/schemas/UserEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string MenuSectionItemUpdatedEvent: description: '' type: object properties: MenuId: format: int32 description: Menu identifier type: integer example: 500123 Description: description: Event description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' MenuSectionItem: $ref: '#/components/schemas/MenuSectionItem' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreLogoUpdatedEvent: description: Store logo updated type: object properties: EventName: description: The event name type: string example: Example Name OrgId: description: Organisation Id type: string example: '500123' StoreId: format: int32 description: ID of store that the logo has been added to type: integer example: 500123 LogoUrl: description: Url of logo type: string example: https://api.flipdish.co/example Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string PercentDiscountDetails: description: Percent discount details type: object properties: PercentageDiscount: format: int32 description: Percentage discount type: integer example: 3 MaxDiscountAmount: format: double description: "The maximum amount that the percentage discount value can be.\r\nIf not set then there is no maximum.\r\nIf set to e.g. 20 euro, and the percentage discount is 25%, and the order total is 100 euro, then the discount will be 20 euro (not 25 euro)." type: number nullable: true example: 12.5 PromotionDetails: description: Promotion type: object properties: PromotionId: format: int32 description: Promotion Id type: integer example: 500123 Name: description: The name of the promotion type: string example: Example Name PromotionAwards: description: The items that this promotion will award type: array items: $ref: '#/components/schemas/PromotionAward' example: [] AppStoreConfigDeletedEvent: description: AppStore Config Deleted event type: object properties: EventName: description: The event name type: string example: Example Name AppStoreAppId: description: App Store Id type: string example: '500123' AppStoreAppConfigurationId: description: App Store Configuration Id type: string example: '500123' User: $ref: '#/components/schemas/UserEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string HydraAssignedEvent: description: Hydra assigned event type: object properties: User: $ref: '#/components/schemas/UserEventInfo' HydraStatus: $ref: '#/components/schemas/HydraStatus' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string BankAccountCreatedEvent: description: '' type: object properties: OrgId: description: Organisation Id type: string example: '500123' BankAccount: $ref: '#/components/schemas/BankAccount' User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string Metafield: description: Metafield required: - Key - Value type: object properties: Key: description: "Key of the metafield.\r\nAllowed characters: lowercase letters, numbers, hyphen, underscore and dot" type: string example: string Value: description: Value of the metafield. type: string example: string RetentionCampaignDeletedEvent: description: Retention campaign deleted event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string StoreId: format: int32 description: Store Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' RetentionCampaign: $ref: '#/components/schemas/RetentionCampaign' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string LocationCreatedEvent: description: Event for logging the creating of Locations type: object properties: LocationId: format: int32 description: Location Location Id type: integer example: 500123 LocationName: description: Location LocationName type: string example: Example Name DisplayOrder: format: int32 description: Location DisplayOrder type: integer example: 1 ExternalLocationId: description: Location ExternalLocationId type: string example: '500123' LocationAreaId: format: int32 description: Location LocationAreaId type: integer example: 500123 EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreGroupDeletedEvent: description: Store Group Deleted Event type: object properties: EventName: description: The event name type: string example: Example Name StoreGroupId: format: int32 description: Store Group Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string StoreGroup: $ref: '#/components/schemas/StoreGroup' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string PhoneCallEndedEvent: description: Phone call ended event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string StoreId: format: int32 description: Store Id type: integer example: 500123 PhoneCall: $ref: '#/components/schemas/PhoneCall' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string CustomerSummary: description: Customer summary type: object properties: Id: format: int32 description: Customer identifier type: integer example: 500123 Name: description: Customer name type: string example: Example Name EmailAddress: description: Customer email address type: string example: owner@example.com PhoneNumberLocalFormat: description: Customer local phone number type: string example: '2026-06-02T12:00:00Z' PhoneNumber: description: Customer phone number type: string example: '+353000000000' LanguagePreference: description: Preferred language of the consumer type: string example: string CustomerUpdatedEvent: description: Customer updated event type: object properties: EventName: description: The event name type: string example: Example Name User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string PushNotificationRequest: description: Push Notification Details required: - Message type: object properties: ScheduledTime: format: date-time description: UTC Time at which to send the push notification type: string example: '2026-06-02T12:00:00Z' Title: description: Title of the notification type: string example: string Message: description: Message of the notification type: string example: string PreOrderConfig: description: Pre Order Config type: object properties: LeadTimeMinutes: format: int32 description: Lead Time in Minutes type: integer example: 1 IntervalMinutes: format: int32 description: Interval in minutes type: integer example: 1 MaxOrderAheadDays: format: int32 description: Max Days to order ahead type: integer example: 1 IncludeAsap: description: Show ASAP as option type: boolean example: true IncludeMoreGranularInitialTime: description: Granual Init' Time type: boolean example: true CutOffTimePreviousDayBasic: description: Cut off time previous day type: string nullable: true example: string CutOffTimeCurrentDayBasic: description: Cut off time current day type: string nullable: true example: string PreOrderTimeDisplayType: description: Type of time displayed. enum: - SingleTime - StartAndEndTime - DayOnly type: string example: SingleTime AlwaysAppearOpen: description: Specifies whether a customer can pre-order outside the store opening hours or not. type: boolean example: true RequireExplicitSelectAlways: description: Force customer to select collection time. type: boolean example: true MenuAsyncCreationCompletedEvent: description: Menu async creation completed event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' Menu: $ref: '#/components/schemas/Menu' Success: description: Flag indicating if the menu creation was successful type: boolean example: true FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string CustomerCreatedEvent: description: Customer created event type: object properties: EventName: description: The event name type: string example: Example Name OrgId: description: Organisation Id type: string example: '500123' User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string BankAccountUpdatedEvent: description: '' type: object properties: OrgId: description: Organisation Id type: string example: '500123' BankAccount: $ref: '#/components/schemas/BankAccount' User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string MenuItemOptionSetCreatedEvent: description: '' type: object properties: MenuId: format: int32 description: Menu identifier type: integer example: 500123 Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' MenuItemOptionSet: $ref: '#/components/schemas/MenuItemOptionSet' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreCampaignStartTime: description: Store campaign start time type: object properties: StoreId: format: int32 description: Store Id type: integer example: 500123 TsStart: format: date-time description: Campaign start time in Utc type: string example: '2026-06-02T12:00:00Z' ValidityPeriod: description: ValidityPeriod. type: object properties: DayOfWeek: description: DayOfWeek. enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday type: string example: Sunday StartTime: description: StartTime. type: string example: '2026-06-02T12:00:00Z' EndTime: description: EndTime. type: string example: '2026-06-02T12:00:00Z' UserPasswordCreatedEvent: description: User created password event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string MenuSectionAvailability: description: Menu section availability type: object properties: AvailableTimes: description: Available times type: array items: $ref: '#/components/schemas/BusinessHoursPeriod' example: [] AvailabilityMode: description: Availability mode enum: - DisplayAlways - DisplayBasedOnTimes - DisplayAlwaysStartCollapsed - DisplayAlwaysStartCollapsedBasedOnTimes type: string nullable: true example: DisplayAlways PhoneCallStartedEvent: description: Phone call started event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string StoreId: format: int32 description: Store Id type: integer example: 500123 PhoneCall: $ref: '#/components/schemas/PhoneCall' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string WebhookSubscriptionUpdatedEvent: description: '' type: object properties: EventName: description: The event name type: string example: Example Name WebhookSubscriptionEventInfo: $ref: '#/components/schemas/WebhookSubscriptionEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string OrderCustomerTrackingCreatedEvent: description: '' type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string Order: $ref: '#/components/schemas/CustomerDeliveryTrackingOrder' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string KioskBluetoothTerminalUnpairedEvent: description: Kiosk Bluetooth Unpairing mode initiated type: object properties: DeviceId: description: Device Id of the Kiosk type: string example: '500123' BluetoothTerminalType: description: Terminal Type enum: - CHIPPER_2X - COTS_DEVICE - VERIFONE_P400 - WISEPAD_3 - WISEPOS_E type: string example: CHIPPER_2X User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string PushNotificationSentEvent: description: '' type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string PushNotification: $ref: '#/components/schemas/PushNotificationRequest' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string OrderDropOffLocation: description: OrderDropOffLocation. type: object properties: OrderId: format: int32 description: OrderId. type: integer example: 500123 LocationName: description: LocationName. type: string example: Example Name LocationAreaName: description: LocationAreaName. type: string example: Example Name LocationId: format: int32 description: LocationId. type: integer example: 500123 LocationAreaId: format: int32 description: LocationAreaId. type: integer example: 500123 ExternalLocationId: description: ExternalLocationId. type: string example: '500123' OrderRefundedEvent: description: Order Refunded Event type: object properties: EventName: description: The event name type: string example: Example Name RefundedAmount: format: double description: The amount refunded type: number example: 12.5 Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' Order: $ref: '#/components/schemas/Order' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string MenuItemOptionSetUpdatedEvent: description: '' type: object properties: MenuId: format: int32 description: Menu identifier type: integer example: 500123 Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' MenuItemOptionSet: $ref: '#/components/schemas/MenuItemOptionSet' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string Printer: description: Printer type: object properties: SerialNumber: description: Unique serial number of the printer type: string example: string LastPollTime: format: date-time description: Date and time when the printer last polled Flipdish for new orders. type: string example: '2026-06-02T12:00:00Z' UserUpdatedEvent: description: User updated event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string UserEventInfo: description: User Event Info type: object properties: UserId: format: int32 description: User Id type: integer example: 500123 UserName: description: User Name type: string example: Example Name UserPhoneNumber: description: User Phone Number type: string example: '+353000000000' UserEmail: description: User Email type: string example: owner@example.com LumpDiscountDetails: description: Lump discount details type: object properties: DiscountAmount: format: double description: Discount amount type: number example: 12.5 StoreArchivedEvent: description: Store Archived Event type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer readOnly: true example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string Store: $ref: '#/components/schemas/Store' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string Product: description: Product required: - ProductType - Sku - Name - Price type: object properties: CatalogItemId: description: Unique catalog Item id maxLength: 30 minLength: 0 type: string example: '500123' IsArchived: description: Returns true if the item is archived type: boolean example: true Groups: description: Collection of groups associated with this item type: array items: $ref: '#/components/schemas/GroupReference' example: [] Metafields: description: Collection of metafields type: array items: $ref: '#/components/schemas/Metafield' example: [] ProductType: description: Type of item (Product, Modifier, etc) enum: - Product - Modifier type: string example: Product Sku: description: Stock Keeping Unit (SKU) maxLength: 30 minLength: 0 type: string example: string Name: description: Product name maxLength: 300 minLength: 0 type: string example: Example Name Description: description: Product description maxLength: 3000 minLength: 0 type: string example: string Price: format: double description: Product price minimum: 0 type: number example: 12.5 ImageFileName: description: Image File Name maxLength: 512 minLength: 0 type: string example: Example Name Alcohol: description: Product contains alcohol type: boolean example: true OrderItemOption: description: Order item option type: object properties: Metadata: description: Metadata type: object additionalProperties: type: string MenuItemOptionPublicId: format: uuid description: Public id of the Menu Item Option type: string example: 00000000-0000-0000-0000-000000000000 MenuItemOptionId: format: int32 description: Menu item option identifier type: integer example: 500123 IsMasterOptionSetItem: description: Is master option set item type: boolean example: true Name: description: Name type: string example: Example Name Price: format: double description: Price type: number example: 12.5 TaxAmount: format: double description: Tax currency amount type: number example: 12.5 MenuItemOptionDisplayOrder: format: int32 description: Menu item option display order type: integer example: 1 MenuItemOptionSetDisplayOrder: format: int32 description: Menu item option set display order type: integer example: 1 DepositReturnFee: format: double description: Deposit return fee type: number nullable: true example: 12.5 TaxItem: description: A collection of tax items on the order. type: object properties: Name: description: The name of the tax item. type: string example: Example Name Rate: format: double description: The tax rate applied to the item. type: number example: 1.0 Amount: format: double description: The amount of tax applied to the item. type: number example: 12.5 TeammateInviteSentEvent: description: '' type: object properties: Teammate: $ref: '#/components/schemas/Teammate' User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string AccountFieldKeyValuePair: description: Represents one populated account field (its key and value) type: object properties: Key: description: Depending on the Key, the field's value will be stored in a different field in PayeeBankAccountData enum: - Iban - AccountNumber - RoutingNumber - BSB - BranchCode - BankCode - InstitutionNumber - TransitNumber - ClearingCode - IfscCode - Clabe - SortCode - Swift type: string example: Iban Value: description: The value of the field type: string example: string OrderBatchPublishedEvent: description: Order Batch Published Event type: object properties: EventName: description: The event name type: string example: Example Name OrderBatchId: format: int32 description: Order Batch Id type: integer example: 500123 StoreId: format: int32 description: Store id the order batch belogs to type: integer example: 500123 OrderIds: description: Orders' ids on the batch type: array items: format: int32 type: integer example: - 1 FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string AppStoreConfigCreatedEvent: description: AppStore Config Created event type: object properties: EventName: description: The event name type: string example: Example Name AppStoreAppId: description: App Store App Id type: string example: '500123' AppStoreAppConfigurationId: description: App Store Configuration Id type: string example: '500123' User: $ref: '#/components/schemas/UserEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string BankAccount: description: BANK ACCOUNT type: object properties: Id: format: int32 description: Id of this account type: integer example: 500123 AccountName: description: Name of this account type: string example: Example Name Iban: description: IBAN of this account type: string example: string Swift: description: SWIFT of this bank account type: string example: string PopulatedAccountFields: description: "A list of one or more populated account fields (field key-value pairs).\r\nIf this list contains at least one item, the Iban, Swift and NationalClearingCode fields should be ignored." type: array items: $ref: '#/components/schemas/AccountFieldKeyValuePair' example: [] AccountState: description: Status of Account enum: - Unverified - AwatingVerification - Verified - Grandfathered type: string example: Unverified StoreNames: description: Store Names that are attached to this account type: array items: type: string example: - Example Name StoreIds: description: Store Ids that are attached to this account type: array items: format: int32 type: integer example: - 1 BankAddress: description: Address lf the bank type: string example: string BankCountryCode: description: CountryCode of the Bank Account type: string example: IE AccountHolderAddress: description: Account Holders Address type: string example: string AccountHolderCountryCode: description: Account Holders Country Code type: string example: IE VatNumber: description: Account Holders Vat Number type: string example: string StripeAccountId: description: Stripe Id of the connected account type: string example: '500123' StoreUpdatedEvent: description: Store Updated Event type: object properties: EventName: description: The event name type: string example: Example Name OrgId: description: Organisation Id type: string example: '500123' StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer readOnly: true example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string Store: $ref: '#/components/schemas/Store' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string MenuItemOptionSetItemUpdatedEvent: description: '' type: object properties: MenuId: format: int32 description: Menu identifier type: integer example: 500123 Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' MenuItemOptionSetItem: $ref: '#/components/schemas/MenuItemOptionSetItem' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string CatalogGroupCreatedEvent: description: '' type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' Group: $ref: '#/components/schemas/Group' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreGroupUpdatedEvent: description: Store Group Updated Event type: object properties: EventName: description: The event name type: string example: Example Name StoreGroupId: format: int32 description: Store Group Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string StoreGroup: $ref: '#/components/schemas/StoreGroup' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string AppUpdatedEvent: description: Application updated event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string Changes: description: A summary of changes made type: string example: string AppName: description: App Name type: string example: Example Name CountryId: description: Country Id type: string example: '500123' User: $ref: '#/components/schemas/UserEventInfo' App: $ref: '#/components/schemas/App' OrgId: description: Organisation Id type: string example: '500123' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string TelephonyConfigUpdatedEvent: description: Telephony Config Updated Event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string StoreId: format: int32 description: Store Id type: integer example: 500123 TelephonyConfig: $ref: '#/components/schemas/TelephonyConfig' PropertyId: description: Property Id type: string example: '500123' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string RestApiEventSearchPaginationResult: description: '' required: - Data - Page - Limit - TotalRecordCount type: object properties: Data: $ref: '#/components/schemas/EventSearchResult' Page: format: int32 description: Current page index type: integer example: 1 Limit: format: int32 description: Current page size type: integer example: 1 TotalRecordCount: format: int32 description: Total record count type: integer example: 12.5 MenuSectionItemDeletedEvent: description: '' type: object properties: MenuId: format: int32 description: Menu identifier type: integer example: 500123 Description: description: Event description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' MenuSectionItem: $ref: '#/components/schemas/MenuSectionItem' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string HydraConnectionStatusChangedEvent: description: Hydra Connection Status Changed Event type: object properties: DeviceId: description: Hydra Device Id type: string example: '500123' HydraDeviceStatus: description: Hydra Device Status enum: - Online - PossiblyOffline - Offline type: string example: Online PollTime: format: date-time description: Hydra Last Poll Time type: string example: '2026-06-02T12:00:00Z' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string RetentionCampaignCreatedEvent: description: Retention campaign created event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string StoreId: format: int32 description: Store Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' RetentionCampaign: $ref: '#/components/schemas/RetentionCampaign' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string KioskTerminalActionStateChangedEvent: description: Kiosk Terminal action state changed type: object properties: ReaderId: description: Card reader id type: string example: '500123' BluetoothTerminalType: description: Terminal type enum: - CHIPPER_2X - COTS_DEVICE - VERIFONE_P400 - WISEPAD_3 - WISEPOS_E type: string example: CHIPPER_2X ActionState: description: Action state. success or fail type: string example: string FailureCode: description: Failure code if processing is failed type: string example: string EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string OrderAcceptedEvent: description: Order Accepted Event type: object properties: EventName: description: The event name type: string example: Example Name OrgId: description: Organisation Id type: string example: '500123' Description: description: Description type: string example: string OrderAcceptedTime: format: date-time description: Order Accepted Time type: string example: '2026-06-02T12:00:00Z' User: $ref: '#/components/schemas/UserEventInfo' Order: $ref: '#/components/schemas/Order' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreOrderCapacityPeriod: description: Represents a single order capacity period type: object properties: MaxOrderNumberPerStoreInterval: format: int32 description: "The maximum number of orders per each store order interval in this order capacity period.\r\nE.g. for a period from 9:00 till 11:00, if the store's interval is 10 minutes, and MaxOrderNumberPerStoreInterval is set to 5,\r\nit means that within each 10-minute interval between 9:00 and 11:00 (i.e. 9:00-9:10, 9:10-9:20, .. , 10:50-11:00) it will be possible to\r\nrequest at most 5 orders." type: integer example: 3 DayOfTheWeek: description: Day of the week the period pertains to enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday type: string example: Sunday PeriodStartHour: format: int32 description: The hour the period starts at type: integer example: 1 PeriodStartMinutes: format: int32 description: The minutes after the hour the period starts at type: integer example: 1 PeriodEndHour: format: int32 description: The hour the period ends at type: integer example: 1 PeriodEndMinutes: format: int32 description: The minutes after the hour the period ends at type: integer example: 1 CertificateRenewedEvent: description: The DNS for the Hostname verified type: object properties: Hostname: description: Description type: string example: Example Name EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string CatalogItemUpdatedEvent: description: '' type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' CatalogItem: $ref: '#/components/schemas/CatalogItem' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string FlipdishError: type: object description: Standard Flipdish API error response. Errors are returned as a JSON object with a human-readable message and a programmatic error code (see https://developers.flipdish.com/docs/error-handling). properties: error: type: object description: Error detail object. properties: errorMessage: type: string description: Descriptive explanation of the issue. example: Invalid or missing parameters. errorCode: type: string description: Unique identifier for programmatic error handling. example: BadRequest details: type: string description: Additional context returned in non-production environments. example: Validation failed for field 'storeId'. CatalogGroupArchivedEvent: description: '' type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' Group: $ref: '#/components/schemas/Group' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string MenuSectionUpdatedEvent: description: '' type: object properties: MenuId: format: int32 description: Menu identifier type: integer example: 500123 Description: description: Event description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' MenuSection: $ref: '#/components/schemas/MenuSection' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string AppCreatedEvent: description: Application created event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string AppName: description: App Name type: string example: Example Name CountryId: description: Country Id type: string example: '500123' User: $ref: '#/components/schemas/UserEventInfo' AccountId: description: Salesforce Account Id type: string example: '500123' OrgId: description: Organisation Id type: string example: '500123' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreGroup: description: Store Group type: object properties: StoreGroupId: format: int32 description: Unique Store Group Identifier type: integer example: 500123 GeneralRating: format: double description: Store Group rating type: number nullable: true example: 1.0 GeneralRatingCount: format: int32 description: Store Group rating count type: integer example: 3 DeliveryMenuMessage: description: Delivery menu message type: string example: string PickupMenuMessage: description: Pickup menu message type: string example: string BrandIds: description: List of brand ids (AppIds) that are associated with this store group type: array items: type: string example: - string Name: description: Store Group Name type: string example: Example Name Currency: description: Currency used by the stores in this group enum: - 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 type: string example: EUR MenuSectionItemCreatedEvent: description: '' type: object properties: MenuId: format: int32 description: Menu identifier type: integer example: 500123 Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' MenuSectionItem: $ref: '#/components/schemas/MenuSectionItem' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string MenuItemOptionSetItemDeletedEvent: description: '' type: object properties: MenuId: format: int32 description: Menu identifier type: integer example: 500123 Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' MenuItemOptionSetItem: $ref: '#/components/schemas/MenuItemOptionSetItem' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string BankAccountAssignedEvent: description: '' type: object properties: OrgId: description: Organisation Id type: string example: '500123' BankAccount: $ref: '#/components/schemas/BankAccount' Description: description: Event description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string KioskBluetoothPairingModeEvent: description: Kiosk Bluetooth Pairing mode initiated type: object properties: DeviceId: description: Device Id of the Kiosk type: string example: '500123' BluetoothTerminalType: description: Terminal Type enum: - CHIPPER_2X - COTS_DEVICE - VERIFONE_P400 - WISEPAD_3 - WISEPOS_E type: string example: CHIPPER_2X User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string Setting: type: object properties: Key: type: string example: string Value: type: string example: string MenuSection: description: Menu section type: object properties: MenuSectionId: format: int32 description: Menu section identifier type: integer example: 500123 MenuItems: description: Menu items type: array items: $ref: '#/components/schemas/MenuSectionItem' example: [] MenuSectionAvailability: $ref: '#/components/schemas/MenuSectionAvailability' PublicId: format: uuid description: Permanent reference to the item. type: string example: 00000000-0000-0000-0000-000000000000 ImageName: description: Image Name type: string example: Example Name Name: description: Name maxLength: 4000 minLength: 0 type: string example: Example Name Description: description: Description maxLength: 4000 minLength: 0 type: string example: string DisplayOrder: format: int32 description: Display order type: integer example: 1 IsAvailable: description: Is available type: boolean example: true IsHiddenFromCustomers: description: Is hidden from customer. Perhaps when the item is out of stock. type: boolean example: true ImageUrl: description: Image url type: string example: https://api.flipdish.co/example MenuUploadedEvent: description: Menu uploaded event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' Menu: $ref: '#/components/schemas/Menu' InstanceEventCount: description: Quantity of events type: string example: string MenuId: format: int32 description: The menu Id type: integer example: 500123 FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string MenuTaxRate: description: Tax Rates Associated with a Menu type: object properties: TaxRateId: format: int32 description: Id of Tax Rate type: integer example: 500123 Name: description: Name of Tax Rate maxLength: 2048 minLength: 0 type: string example: Example Name Rate: format: double description: In Percentage type: number example: 1.0 MenuItemOptionSetItemCreatedEvent: description: '' type: object properties: MenuId: format: int32 description: Menu identifier type: integer example: 500123 Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' MenuItemOptionSetItem: $ref: '#/components/schemas/MenuItemOptionSetItem' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreMenuAssignedEvent: description: Menu Assigned To Store Event type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 MenuId: format: int32 description: MenuId Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string CustomerConsentUpdatedEvent: description: Customer consent updated type: object properties: EventName: description: The event name type: string example: Example Name OrgId: description: Organisation Id type: string example: '500123' Enabled: description: Enabled type: boolean example: true Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreKioskSettingUpdatedEvent: description: Store kiosk setting updated type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string StoreKioskSetting: $ref: '#/components/schemas/StoreKioskSetting' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string Coordinates: description: Coordinates type: object properties: Latitude: format: double description: Latitude type: number example: 1.0 Longitude: format: double description: Longitude type: number example: 1.0 OrderCreatedEvent: description: Order Created Event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string OrderCreatedTime: format: date-time description: Order Created Time type: string example: '2026-06-02T12:00:00Z' Order: $ref: '#/components/schemas/Order' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreFeeConfig: description: '' type: object properties: FeeConfigId: format: int32 description: '' type: integer example: 500123 StoreId: format: int32 description: '' type: integer example: 500123 StartTime: format: date-time description: '' type: string example: '2026-06-02T12:00:00Z' PercentFeeCardOrders: format: double description: '' type: number example: 12.5 PercentFeeCashOrders: format: double description: '' type: number example: 12.5 PercentFeeCardOrdersWeb: format: double description: '' type: number example: 12.5 PercentFeeCashOrdersWeb: format: double description: '' type: number example: 12.5 PercentFeeCardOrdersKiosk: format: double description: '' type: number example: 12.5 PercentFeeCashOrdersKiosk: format: double description: '' type: number example: 12.5 FixedFeeCardOrdersKiosk: format: double description: '' type: number example: 12.5 FixedFeeCashOrdersKiosk: format: double description: '' type: number example: 12.5 PercentFeeCardOrdersKioskChargedToCustomerIncludingVat: format: double description: '' type: number example: 12.5 FixedFeeCardOrdersKioskChargedToCustomerIncludingVat: format: double description: '' type: number example: 12.5 PercentFeeCashOrdersKioskChargedToCustomerIncludingVat: format: double description: '' type: number example: 12.5 FixedFeeCashOrdersKioskChargedToCustomerIncludingVat: format: double description: '' type: number example: 12.5 FixedFeeCardOrders: format: double description: '' type: number example: 12.5 FixedFeeCashOrders: format: double description: '' type: number example: 12.5 PercentFeeCardOrdersChargedToCustomerIncludingVat: format: double description: '' type: number example: 12.5 FixedFeeCardOrdersChargedToCustomerIncludingVat: format: double description: '' type: number example: 12.5 PercentFeeCashOrdersChargedToCustomerIncludingVat: format: double description: '' type: number example: 12.5 FixedFeeCashOrdersChargedToCustomerIncludingVat: format: double description: '' type: number example: 12.5 PercentFeeTips: format: double description: Gets or sets the percent fee tips. type: number example: 12.5 PercentFeeTipsCollection: format: double description: Gets or sets the percent fee tips for collection. type: number example: 12.5 PercentFeeTipsDelivery: format: double description: Gets or sets the percent fee tips for delivery. type: number example: 12.5 TaxRatePercent: format: double description: Gets or sets the tax rate percent. type: number example: 1.0 PercentFeeCardOrdersLocationService: format: double description: Gets or sets the percent fee card orders location service. type: number example: 12.5 PercentFeeCashOrdersLocationService: format: double description: Gets or sets the percent fee cash orders location service. type: number example: 12.5 FixedFeeCardOrdersLocationService: format: double description: Gets or sets the fixed fee card orders location service. type: number example: 12.5 FixedFeeCashOrdersLocationService: format: double description: Gets or sets the fixed fee cash orders location service. type: number example: 12.5 PercentFeeCardOrdersLocationServiceChargedToCustomerIncludingVat: format: double description: Gets or sets the percent fee card orders location service charged to customer including vat. type: number example: 12.5 PercentFeeCashOrdersLocationServiceChargedToCustomerIncludingVat: format: double description: Gets or sets the percent fee cash orders location service charged to customer including vat. type: number example: 12.5 FixedFeeCardOrdersLocationServiceChargedToCustomerIncludingVat: format: double description: Gets or sets the fixed fee card orders location service charged to customer including vat. type: number example: 12.5 FixedFeeCashOrdersLocationServiceChargedToCustomerIncludingVat: format: double description: Gets or sets the fixed fee cash orders location service charged to customer including vat. type: number example: 12.5 PercentFeeCardOrdersIngest: format: double description: Gets or sets the percent fee card orders ingest. type: number nullable: true example: 12.5 PercentFeeCashOrdersIngest: format: double description: Gets or sets the percent fee cash orders ingest. type: number nullable: true example: 12.5 FixedFeeCardOrdersIngest: format: double description: Gets or sets the fixed fee card orders ingest. type: number nullable: true example: 12.5 FixedFeeCashOrdersIngest: format: double description: Gets or sets the fixed fee cash orders ingest. type: number nullable: true example: 12.5 PercentFeeDelivery: format: double description: Gets or sets the percent fee for delivery orders. type: number example: 12.5 FixedFeeDelivery: format: double description: Gets or sets the fixed fee for delivery orders. type: number example: 12.5 PercentFeeCardPosTransaction: format: double description: Gets or sets the percent fee for POS transactions. type: number example: 12.5 FixedFeeCardPosTransaction: format: double description: Gets or sets the fixed fee for POS transactions. type: number example: 12.5 PercentFeeOrderWithGoogle: format: double description: Additional percentage fee charged on orders submitted through Order With Google type: number example: 12.5 FixedFeeOrderWithGoogle: format: double description: Additional fixed fee charged on orders submitted through Order With Google type: number example: 12.5 ShouldNotAutoIncreaseBefore: format: date-time description: Should not auto increase fees before this date type: string nullable: true example: '2026-06-02T12:00:00Z' Reason: description: Reason for the last fee change (optional) type: string example: string PercentFeeCardOrdersPhoneAgent: format: double description: Gets or sets the percent fee card orders phone agent. type: number example: 12.5 PercentFeeCashOrdersPhoneAgent: format: double description: Gets or sets the percent fee cash orders phone agent. type: number example: 12.5 FixedFeeCardOrdersPhoneAgent: format: double description: Gets or sets the fixed fee card orders phone agent. type: number example: 12.5 FixedFeeCashOrdersPhoneAgent: format: double description: Gets or sets the fixed fee cash orders phone agent. type: number example: 12.5 PercentFeeCardOrdersPhoneAgentChargedToCustomerIncludingVat: format: double description: Gets or sets the percent fee card orders phone agent charged to customer including vat. type: number example: 12.5 PercentFeeCashOrdersPhoneAgentChargedToCustomerIncludingVat: format: double description: Gets or sets the percent fee cash orders phone agent charged to customer including vat. type: number example: 12.5 FixedFeeCardOrdersPhoneAgentChargedToCustomerIncludingVat: format: double description: Gets or sets the fixed fee card orders phone agent charged to customer including vat. type: number example: 12.5 FixedFeeCashOrdersPhoneAgentChargedToCustomerIncludingVat: format: double description: Gets or sets the fixed fee cash orders phone agent charged to customer including vat. type: number example: 12.5 WebsiteVanityUrlUpdatedEvent: description: Website vanity url type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' VanityUrl: description: New vanity url type: string example: https://api.flipdish.co/example FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string OrderRatingUpdatedEvent: description: Order Rating Update Event type: object properties: EventName: description: The event name type: string example: Example Name Rating: format: int32 description: New User Rating type: integer nullable: true example: 1 Description: description: Description type: string example: string Order: $ref: '#/components/schemas/Order' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreSummary: description: Store summary type: object properties: Id: format: int32 description: Store identifier type: integer example: 500123 Name: description: Store name type: string example: Example Name MenuId: format: int32 description: Stores menu identifier type: integer example: 500123 MenuPublishId: format: uuid description: Stores menu publish GUID type: string example: 00000000-0000-0000-0000-000000000000 Metadata: description: Store metadata type: object additionalProperties: type: string Currency: description: Currency which used by the Store enum: - 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 type: string example: EUR Coordinates: $ref: '#/components/schemas/Coordinates' StoreTimezone: description: Timezone of store type: string example: string StoreIanaTimezone: description: IANA Timezone of store type: string example: string StoreGroupId: format: int32 description: Store group id of store type: integer example: 500123 TaxId: description: VAT number or generic Tax ID of the store type: string example: '500123' PrettyAddress: description: Address of the store type: string example: string CountryCode: description: Country code of the store address (ISO 3166-1 alpha-2) type: string example: IE PropertyId: description: Property identifier type: string example: '500123' CertificateCreatedEvent: description: The DNS for the Hostname verified type: object properties: Hostname: description: Description type: string example: Example Name EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string KioskBluetoothTerminalUpdatedEvent: description: Kiosk bluetooth terminal unpaired type: object properties: DeviceId: description: Device Id of the Kiosk type: string example: '500123' BluetoothTerminalType: description: Terminal Type enum: - CHIPPER_2X - COTS_DEVICE - VERIFONE_P400 - WISEPAD_3 - WISEPOS_E type: string example: CHIPPER_2X BluetoothTerminalSerialNumber: description: Serial number of the terminal type: string example: string BluetoothTerminalStatus: $ref: '#/components/schemas/BluetoothTerminalStatus' User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string DeliveryLocation: description: Delivery location type: object properties: Coordinates: $ref: '#/components/schemas/Coordinates' Building: description: Building type: string example: string Street: description: Street type: string example: string Town: description: Town type: string example: string PostCode: description: Post code type: string example: string DeliveryInstructions: description: Delivery instructions type: string example: string PrettyAddressString: description: Formatted, pretty address string type: string example: string StorePreOrderConfigUpdatedEvent: description: Store Pre order config updated type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string PreOrderConfig: $ref: '#/components/schemas/PreOrderConfig' OldPreOrderConfig: $ref: '#/components/schemas/PreOrderConfig' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string MenuItemOptionSet: description: Menu item option set type: object properties: MenuItemOptionSetId: format: int32 description: Menu item option set identifier type: integer example: 500123 ImageName: description: Image Name type: string example: Example Name ImageUrl: description: Image url type: string example: https://api.flipdish.co/example MenuItemOptionSetItems: description: Option set items type: array items: $ref: '#/components/schemas/MenuItemOptionSetItem' example: [] PublicId: format: uuid description: Permanent reference to the item. type: string example: 00000000-0000-0000-0000-000000000000 CatalogItemId: description: Catalog item Id when the OptionSet is associated to a Product type: string example: '500123' Name: description: Menu item option set name maxLength: 4000 minLength: 0 type: string example: Example Name IsMasterOptionSet: description: Is master option set. This can affect the layout of the options in the menu displayed to the customer. Usually it is true if the option could be considerd a standalone item as opposed to an addition ("with ketchup") or modifier ("large"). type: boolean example: true DisplayOrder: format: int32 description: Display order. Displayed in ascending order. type: integer example: 1 MinSelectCount: format: int32 description: Minimum items must be selected type: integer example: 3 MaxSelectCount: format: int32 description: Maximum number of items can be selected type: integer example: 3 CellLayoutType: description: "Small | Medium | Large\r\nAffects the layout of the menu." enum: - Small - Medium - Large - HiddenImage type: string example: Small LocationAreaUpdatedEvent: description: Event for logging updates of LocationAreas type: object properties: LocationAreaId: description: LocationArea Id type: string example: '500123' LocationAreaName: description: LocationArea Name type: string example: Example Name User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string OrderDispatchedEvent: description: Order Dispatched Event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string OrderDispatchedTime: format: date-time description: Order Rejected Time type: string example: '2026-06-02T12:00:00Z' Order: $ref: '#/components/schemas/Order' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string LocationAreaCreatedEvent: description: Event for logging creating of LocationAreas type: object properties: LocationAreaId: description: LocationArea Id type: string example: '500123' LocationAreaName: description: LocationArea name type: string example: Example Name User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string OrderTipUpdatedEvent: description: Order Tip Update Event type: object properties: EventName: description: The event name type: string example: Example Name TipAmount: format: double description: Tip Amount type: number example: 12.5 Description: description: Description type: string example: string Order: $ref: '#/components/schemas/Order' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string ProductReference: description: Catalog Item associated required: - CatalogItemId - ProductType type: object properties: Item: $ref: '#/components/schemas/Product' Product: $ref: '#/components/schemas/Product' CatalogItemId: description: Identifier of the CatalogItemId to use as SubProduct maxLength: 30 minLength: 0 type: string example: '500123' ProductType: description: Type of the SupProduct enum: - Product - Modifier type: string example: Product PreselectedQuantity: format: int32 description: Quantity of the modifier that will be set when the parent product is placed in the basket type: integer example: 3 MenuSectionCreatedEvent: description: '' type: object properties: MenuId: format: int32 description: Menu identifier type: integer example: 500123 Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' MenuSection: $ref: '#/components/schemas/MenuSection' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string VoucherCreatedEvent: description: Voucher Created Event type: object properties: VoucherId: format: int32 description: Voucher Id type: integer example: 500123 EventName: description: The event name type: string example: Example Name User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string Voucher: $ref: '#/components/schemas/Voucher' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string HydraConfig: description: Hydra configuration required: - MinimumVersion - PaymentOptions - DeviceSettings type: object properties: MinimumVersion: description: Minimum version type: string example: string PaymentOptions: description: Payment options type: array items: enum: - Online - Emv - Counter type: string example: - Online DeviceSettings: $ref: '#/components/schemas/DeviceSettings' Version: description: Version of the device type: string example: string BuildNumber: description: Build number of the device type: string example: string GitSha: description: SHA of the commit type: string example: string GitBranch: description: Build branch type: string example: string KioskBluetoothInstallUpdateInitiateEvent: description: Kiosk bluetooth Initiate Install Update Event type: object properties: DeviceId: description: Device Id of the Kiosk type: string example: '500123' BluetoothTerminalType: description: Terminal Type enum: - CHIPPER_2X - COTS_DEVICE - VERIFONE_P400 - WISEPAD_3 - WISEPOS_E type: string example: CHIPPER_2X User: $ref: '#/components/schemas/UserEventInfo' EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string VoucherUpdatedEvent: description: Voucher Updated Event type: object properties: VoucherId: format: int32 description: Voucher Id type: integer example: 500123 EventName: description: The event name type: string example: Example Name User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string Voucher: $ref: '#/components/schemas/Voucher' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StoreUnarchivedEvent: description: Store Unarchived Event type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer readOnly: true example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string Store: $ref: '#/components/schemas/Store' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string PhoneCall: description: Phone call type: object properties: PhoneCallId: format: int32 description: Phone call id type: integer example: 500123 CallSid: description: Twilio Call SID type: string example: '500123' TimeOfCall: format: date-time description: Time of the call type: string example: '2026-06-02T12:00:00Z' TimeOfCallLocal: format: date-time description: Time of the call, local to the store to which the call was made type: string example: '2026-06-02T12:00:00Z' StoreId: format: int32 description: ID of the store that the call was TO type: integer example: 500123 StoreName: description: Name of the store that the call was TO type: string example: Example Name CallerName: description: Name of the caller type: string example: Example Name CallerUserId: format: int32 description: UserID of the caller type: integer example: 500123 CallerNumber: description: Phone number of the caller type: string example: string CallLengthInSeconds: format: int32 description: The amount of time the call took type: integer example: 1 CallStatus: description: The status of the call enum: - Queued - Ringing - InProgress - Completed - Failed - Busy - NoAnswer - Unknown - Canceled type: string example: Queued WebsiteUpdatedEvent: description: WebsiteUpdatedEvent type: object properties: AppNameId: description: App Name id of the whitelabel of the website type: string example: '500123' User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description of event type: string example: string EventName: description: The event name type: string example: Example Name FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string UpdateAppStoreAppConfigurationWebhookDTO: required: - Id - IsEnabled type: object properties: Id: type: string example: '500123' IsEnabled: type: boolean example: true StoreIds: type: array items: format: int32 type: integer example: - 1 Settings: type: array items: $ref: '#/components/schemas/Setting' example: [] CampaignStatistics: description: Campaign statistics type: object properties: VouchersIssued: format: int32 description: "Deprecated. Number of issued vouchers.\r\nThis field is always zero." type: integer example: 1 VouchersRedeemed: format: int32 description: "Deprecated. Number of redeemed vouchers. This field is always zero.\r\nThis field is always zero." type: integer example: 1 Conversion: format: double description: "Deprecated. Conversion of campaign (VouchersIssued / VouchersRedeemed).\r\nThis field is always zero." type: number example: 1.0 SalesGenerated: format: double description: "Deprecated.\r\nSales generated by campaign (TotalAmount - FeeChargedToCustomer ie. the discounted sale value).\r\nThis field is always zero." type: number example: 1.0 ReturnOfInvestment: format: double description: "Deprecated.\r\nReturn of investment of campaign (TotalAmount / DiscountAmount).\r\nThis field is always zero." type: number example: 1.0 SmsReceivedEvent: description: Sms received event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string SmsInfo: $ref: '#/components/schemas/SmsInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string RetentionCampaign: description: Retention campaign type: object properties: CampaignId: format: int32 description: Id of campaign type: integer example: 500123 Statistics: $ref: '#/components/schemas/CampaignStatistics' Stores: description: Stores this campaign applies to with campaign start time in Utc type: array items: $ref: '#/components/schemas/StoreCampaignStartTime' example: [] PublicId: format: uuid description: Permanent reference to the item. type: string example: 00000000-0000-0000-0000-000000000000 NotifyCustomerAfterMinutes: format: int32 description: Time in minutes, after which customer will receive retention voucher if he/she does not order maximum: 2147483647 minimum: 1440 type: integer example: 1 PercentDiscountAmount: format: int32 description: Discount amount in percents maximum: 100 minimum: 1 type: integer nullable: true example: 12.5 MaxDiscount: format: double description: Maximum discount for percentage discounts minimum: 0 type: number nullable: true example: 3 LumpDiscountAmount: format: double description: Discount amount in sum of money maximum: 2147483647 minimum: 0 type: number nullable: true example: 12.5 VoucherValidPeriodDays: format: int32 description: Number of days for which the voucher will be valid. maximum: 300 minimum: 1 type: integer example: 1 IncludeDeliveryFee: description: Discount will include delivery fee type: boolean example: true AutoApplyResultingVouchers: description: Automatically apply resulting vouchers type: boolean example: true IncludeExistingOrders: description: Campaign will apply to existing orders type: boolean example: true IsEnabled: description: Is campaign enabled type: boolean example: true StoreIds: description: Ids of stores this campaign applies to type: array items: format: int32 type: integer example: - 1 AppId: description: The app that this campaign belongs to. type: string example: '500123' ForceDiscount: description: Controls whether the voucher generated from this campaign will override discount exclusions type: boolean example: true StoreUnpublishedEvent: description: Store Unpublished Event type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer readOnly: true example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string Store: $ref: '#/components/schemas/Store' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string EmvNotificationEvent: description: Order Terminal Notification type: object properties: EventName: description: The event name type: string example: Example Name Notification: description: Notification Sent type: string example: string Order: $ref: '#/components/schemas/Order' TerminalId: description: TerminalId type: string example: '500123' Description: description: Description type: string example: string ExpDate: description: Expirey Date type: string example: '2026-06-02T12:00:00Z' CardType: description: Card Type type: string example: string PaymentMethod: description: Payment Method type: string example: string AccountNumber: description: Masked Account Number type: string example: string AuthCode: description: Auth Code type: string example: string ProviderMessage: description: Payment Provider Message type: string example: string FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string EventSearchResult: description: '' type: object properties: AppCreatedEvent: description: App Created Event type: array items: $ref: '#/components/schemas/AppCreatedEvent' example: [] AppUpdatedEvent: description: App Updated Event type: array items: $ref: '#/components/schemas/AppUpdatedEvent' example: [] AnalyticsClientEvent: description: Client Analytics events type: array items: $ref: '#/components/schemas/AnalyticsClientEvent' example: [] OrderAcceptedEvent: description: Order accepted events type: array items: $ref: '#/components/schemas/OrderAcceptedEvent' example: [] OrderDispatchedEvent: description: Order dispatched events type: array items: $ref: '#/components/schemas/OrderDispatchedEvent' example: [] OrderCustomerTrackingCreatedEvent: description: Order delivery tracking created events type: array items: $ref: '#/components/schemas/OrderCustomerTrackingCreatedEvent' example: [] OrderDeliveryTrackingStatusUpdatedEvent: description: Order delivery tracking updated events type: array items: $ref: '#/components/schemas/OrderDeliveryTrackingStatusUpdatedEvent' example: [] OrderBatchPublishedEvent: description: Order Batch published event type: array items: $ref: '#/components/schemas/OrderBatchPublishedEvent' example: [] OrderCreatedEvent: description: Order created events type: array items: $ref: '#/components/schemas/OrderCreatedEvent' example: [] OrderRatingUpdatedEvent: description: Order rating updated events type: array items: $ref: '#/components/schemas/OrderRatingUpdatedEvent' example: [] OrderRefundedEvent: description: Order refunded events type: array items: $ref: '#/components/schemas/OrderRefundedEvent' example: [] OrderRejectedEvent: description: Order rejected events type: array items: $ref: '#/components/schemas/OrderRejectedEvent' example: [] OrderTipUpdatedEvent: description: Order tip updated events type: array items: $ref: '#/components/schemas/OrderTipUpdatedEvent' example: [] OrderTerminalNotifications: description: Order Terminal Notification events type: array items: $ref: '#/components/schemas/EmvNotificationEvent' example: [] StoreCreatedEvent: description: Store created events type: array items: $ref: '#/components/schemas/StoreCreatedEvent' example: [] StoreDeletedEvent: description: Store deleted events type: array items: $ref: '#/components/schemas/StoreDeletedEvent' example: [] StoreAddressUpdatedEvent: description: Store address updated events type: array items: $ref: '#/components/schemas/StoreAddressUpdatedEvent' example: [] StoreKioskSettingUpdatedEvent: description: Store kiosk setting updated events type: array items: $ref: '#/components/schemas/StoreKioskSettingUpdatedEvent' example: [] DeliveryZoneCreatedEvent: description: Store delivery zone created events type: array items: $ref: '#/components/schemas/DeliveryZoneCreatedEvent' example: [] DeliveryZoneUpdatedEvent: description: Store delivery zone updated events type: array items: $ref: '#/components/schemas/DeliveryZoneUpdatedEvent' example: [] DeliveryZoneDeletedEvent: description: Store delivery zone deleted events type: array items: $ref: '#/components/schemas/DeliveryZoneDeletedEvent' example: [] StoreOpeningHoursUpdatedEvent: description: Store opening hours updated events type: array items: $ref: '#/components/schemas/StoreOpeningHoursUpdatedEvent' example: [] StoreMenuAssignedEvent: description: Store opening hours updated events type: array items: $ref: '#/components/schemas/StoreMenuAssignedEvent' example: [] StoreBusinessHoursOverrideCreatedEvent: description: Store business hours override created events type: array items: $ref: '#/components/schemas/StoreBusinessHoursOverrideCreatedEvent' example: [] StoreBusinessHoursOverrideDeletedEvent: description: Store business hours override deleted events type: array items: $ref: '#/components/schemas/StoreBusinessHoursOverrideDeletedEvent' example: [] StoreArchivedEvent: description: Store archived events type: array items: $ref: '#/components/schemas/StoreArchivedEvent' example: [] StoreUnarchivedEvent: description: Store unarchived events type: array items: $ref: '#/components/schemas/StoreUnarchivedEvent' example: [] StorePublishedEvent: description: Store published events type: array items: $ref: '#/components/schemas/StorePublishedEvent' example: [] StoreUnpublishedEvent: description: Store unpublished events type: array items: $ref: '#/components/schemas/StoreUnpublishedEvent' example: [] StoreUpdatedEvent: description: Store updated events type: array items: $ref: '#/components/schemas/StoreUpdatedEvent' example: [] StorePreOrderConfigUpdatedEvent: description: Store updated events type: array items: $ref: '#/components/schemas/StorePreOrderConfigUpdatedEvent' example: [] StoreLogoCreatedEvent: description: Store logo created events type: array items: $ref: '#/components/schemas/StoreLogoCreatedEvent' example: [] StoreLogoUpdatedEvent: description: Store logo updated events type: array items: $ref: '#/components/schemas/StoreLogoUpdatedEvent' example: [] StoreLogoDeletedEvent: description: Store logo deleted events type: array items: $ref: '#/components/schemas/StoreLogoDeletedEvent' example: [] MenuCreatedEvent: description: Menu created events type: array items: $ref: '#/components/schemas/MenuCreatedEvent' example: [] MenuAsyncCreationCompletedEvent: description: Menu async creation completed events type: array items: $ref: '#/components/schemas/MenuAsyncCreationCompletedEvent' example: [] MenuUpdatedEvent: description: Menu updated events type: array items: $ref: '#/components/schemas/MenuUpdatedEvent' example: [] MenuUploadedEvent: description: Menu uploaded events type: array items: $ref: '#/components/schemas/MenuUploadedEvent' example: [] MenuBulkEditEvent: description: Menu bulk events type: array items: $ref: '#/components/schemas/MenuBulkEditEvent' example: [] MenuSectionCreatedEvent: description: Menu section created events type: array items: $ref: '#/components/schemas/MenuSectionCreatedEvent' example: [] MenuSectionUpdatedEvent: description: Menu section updated events type: array items: $ref: '#/components/schemas/MenuSectionUpdatedEvent' example: [] MenuSectionDeletedEvent: description: Menu section deleted events type: array items: $ref: '#/components/schemas/MenuSectionDeletedEvent' example: [] MenuSectionItemCreatedEvent: description: Menu section item created events type: array items: $ref: '#/components/schemas/MenuSectionItemCreatedEvent' example: [] MenuSectionItemUpdatedEvent: description: Menu section item updated events type: array items: $ref: '#/components/schemas/MenuSectionItemUpdatedEvent' example: [] MenuSectionItemDeletedEvent: description: Menu section item deleted events type: array items: $ref: '#/components/schemas/MenuSectionItemDeletedEvent' example: [] MenuItemOptionSetCreatedEvent: description: Menu item option set created events type: array items: $ref: '#/components/schemas/MenuItemOptionSetCreatedEvent' example: [] MenuItemOptionSetUpdatedEvent: description: Menu item option set updated events type: array items: $ref: '#/components/schemas/MenuItemOptionSetUpdatedEvent' example: [] MenuItemOptionSetDeletedEvent: description: Menu item option set deleted events type: array items: $ref: '#/components/schemas/MenuItemOptionSetDeletedEvent' example: [] MenuItemOptionSetItemCreatedEvent: description: Menu item option set item created events type: array items: $ref: '#/components/schemas/MenuItemOptionSetItemCreatedEvent' example: [] MenuItemOptionSetItemUpdatedEvent: description: Menu item option set item updated events type: array items: $ref: '#/components/schemas/MenuItemOptionSetItemUpdatedEvent' example: [] MenuItemOptionSetItemDeletedEvent: description: Menu item option set item deleted events type: array items: $ref: '#/components/schemas/MenuItemOptionSetItemDeletedEvent' example: [] MenuCheckpointCreatedEvent: description: Menu checkpoint created event type: array items: $ref: '#/components/schemas/MenuCheckpointCreatedEvent' example: [] StoreGroupCreatedEvent: description: Store group created events type: array items: $ref: '#/components/schemas/StoreGroupCreatedEvent' example: [] StoreGroupUpdatedEvent: description: Store group updated events type: array items: $ref: '#/components/schemas/StoreGroupUpdatedEvent' example: [] StoreGroupDeletedEvent: description: Store group deleted events type: array items: $ref: '#/components/schemas/StoreGroupDeletedEvent' example: [] CustomerCreatedEvent: description: Customer created events type: array items: $ref: '#/components/schemas/CustomerCreatedEvent' example: [] CustomerUpdatedEvent: description: Customer updated events type: array items: $ref: '#/components/schemas/CustomerUpdatedEvent' example: [] CustomerConsentUpdatedEvent: description: Customer consent updated events type: array items: $ref: '#/components/schemas/CustomerConsentUpdatedEvent' example: [] WebhookSubscriptionCreatedEvent: description: Webhook subscription created events type: array items: $ref: '#/components/schemas/WebhookSubscriptionCreatedEvent' example: [] WebhookSubscriptionUpdatedEvent: description: Webhook subscription updated events type: array items: $ref: '#/components/schemas/WebhookSubscriptionUpdatedEvent' example: [] WebhookSubscriptionDeletedEvent: description: Webhook subscription deleted events type: array items: $ref: '#/components/schemas/WebhookSubscriptionDeletedEvent' example: [] PrinterTurnedOnEvent: description: Printer turned ON event type: array items: $ref: '#/components/schemas/PrinterTurnedOnEvent' example: [] PrinterTurnedOffEvent: description: Printer turned OFF event type: array items: $ref: '#/components/schemas/PrinterTurnedOffEvent' example: [] PrinterAssignedToStoreEvent: description: Printer assigned to store event type: array items: $ref: '#/components/schemas/PrinterAssignedToStoreEvent' example: [] PrinterUnassignedFromStoreEvent: description: Printer unassigned from store event type: array items: $ref: '#/components/schemas/PrinterUnassignedFromStoreEvent' example: [] PhoneCallStartedEvent: description: Phone call started event type: array items: $ref: '#/components/schemas/PhoneCallStartedEvent' example: [] PhoneCallEndedEvent: description: Phone call ended event type: array items: $ref: '#/components/schemas/PhoneCallEndedEvent' example: [] TelephonyConfigUpdatedEvent: description: Telephony config updated event type: array items: $ref: '#/components/schemas/TelephonyConfigUpdatedEvent' example: [] ChannelStoresUpdatedEvent: description: Channel stores updated event type: array items: $ref: '#/components/schemas/ChannelStoresUpdatedEvent' example: [] LoyaltyCampaignCreatedEvent: description: Loyalty campaign created event type: array items: $ref: '#/components/schemas/LoyaltyCampaignCreatedEvent' example: [] LoyaltyCampaignDeletedEvent: description: Loyalty campaign deleted event type: array items: $ref: '#/components/schemas/LoyaltyCampaignDeletedEvent' example: [] LoyaltyCampaignUpdatedEvent: description: Loyalty campaign updated event type: array items: $ref: '#/components/schemas/LoyaltyCampaignUpdatedEvent' example: [] RetentionCampaignCreatedEvent: description: Retention campaign created event type: array items: $ref: '#/components/schemas/RetentionCampaignCreatedEvent' example: [] RetentionCampaignDeletedEvent: description: Retention campaign deleted event type: array items: $ref: '#/components/schemas/RetentionCampaignDeletedEvent' example: [] RetentionCampaignUpdatedEvent: description: Retention campaign updated event type: array items: $ref: '#/components/schemas/RetentionCampaignUpdatedEvent' example: [] SmsReceivedEvent: description: Sms received event type: array items: $ref: '#/components/schemas/SmsReceivedEvent' example: [] UserLoginEvent: description: User login event type: array items: $ref: '#/components/schemas/UserLoginEvent' example: [] UserCreatedEvent: description: User created event type: array items: $ref: '#/components/schemas/UserCreatedEvent' example: [] UserUpdatedEvent: description: User updated event type: array items: $ref: '#/components/schemas/UserUpdatedEvent' example: [] UserDeletedEvent: description: User deleted event type: array items: $ref: '#/components/schemas/UserDeletedEvent' example: [] UserCreatedPasswordEvent: description: User password created event type: array items: $ref: '#/components/schemas/UserPasswordCreatedEvent' example: [] UserAnsweredSignupQuestionsEvent: description: User answered signup questions event type: array items: $ref: '#/components/schemas/UserAnsweredSignupQuestionsEvent' example: [] VoucherCreatedEvent: description: Voucher created event type: array items: $ref: '#/components/schemas/VoucherCreatedEvent' example: [] VoucherUpdatedEvent: description: Voucher updated event type: array items: $ref: '#/components/schemas/VoucherUpdatedEvent' example: [] VoucherDeletedEvent: description: Voucher deleted event type: array items: $ref: '#/components/schemas/VoucherDeletedEvent' example: [] VoucherAppliedEvent: description: Voucher applied event type: array items: $ref: '#/components/schemas/VoucherAppliedEvent' example: [] TeammateInviteSentEvent: description: Teammate invite sent event type: array items: $ref: '#/components/schemas/TeammateInviteSentEvent' example: [] TeammateInviteAcceptedEvent: description: Teammate invite accepted event type: array items: $ref: '#/components/schemas/TeammateInviteAcceptedEvent' example: [] TeammateUpdatedEvent: description: Teammate updated event type: array items: $ref: '#/components/schemas/TeammateUpdatedEvent' example: [] TeammateDeletedEvent: description: Teammate deleted event type: array items: $ref: '#/components/schemas/TeammateDeletedEvent' example: [] BankAccountCreatedEvent: description: Bank account created event type: array items: $ref: '#/components/schemas/BankAccountCreatedEvent' example: [] BankAccountUpdatedEvent: description: Bank account updated event type: array items: $ref: '#/components/schemas/BankAccountUpdatedEvent' example: [] BankAccountDeletedEvent: description: Bank account updated event type: array items: $ref: '#/components/schemas/BankAccountDeletedEvent' example: [] BankAccountAssignedEvent: description: Bank account assigned event type: array items: $ref: '#/components/schemas/BankAccountAssignedEvent' example: [] HydraAssignedEvent: description: Hydra assigned event type: array items: $ref: '#/components/schemas/HydraAssignedEvent' example: [] HydraRequestResetEvent: description: Hydra reset requested event type: array items: $ref: '#/components/schemas/HydraRequestResetEvent' example: [] HydraStoreAssignedEvent: description: Hydra store assigned event type: array items: $ref: '#/components/schemas/HydraStoreAssignedEvent' example: [] HydraStoreUnassignedEvent: description: Hydra store unassigned type: array items: $ref: '#/components/schemas/HydraStoreUnassignedEvent' example: [] HydraSettingChangedEvent: description: Hydra settings changed event type: array items: $ref: '#/components/schemas/HydraSettingChangedEvent' example: [] HydraUnAssignedEvent: description: Hydra un-assigned event type: array items: $ref: '#/components/schemas/HydraUnAssignedEvent' example: [] HydraConnectionStatusChangedEvent: description: Hydra connection state change type: array items: $ref: '#/components/schemas/HydraConnectionStatusChangedEvent' example: [] KioskBluetoothPairingModeEvent: description: Bluetooth Pairing Mode initiated type: array items: $ref: '#/components/schemas/KioskBluetoothPairingModeEvent' example: [] KioskBluetoothUnpairingModeEvent: description: Bluetooth Unpairing Mode initiated type: array items: $ref: '#/components/schemas/KioskBluetoothUnpairingModeEvent' example: [] KioskBluetoothTerminalUnpairedEvent: description: Bluetooth Terminal Unpaired with Kiosk type: array items: $ref: '#/components/schemas/KioskBluetoothTerminalUnpairedEvent' example: [] KioskTerminalActionStateChangedEvent: description: Terminal actionstate change type: array items: $ref: '#/components/schemas/KioskTerminalActionStateChangedEvent' example: [] KioskBluetoothTerminalUpdatedEvent: description: Bluetooth Terminal Updated type: array items: $ref: '#/components/schemas/KioskBluetoothTerminalUpdatedEvent' example: [] KioskBluetoothTerminalInitiateUpdateCheckEvent: description: Trigger bluetooth payment terminal update checker type: array items: $ref: '#/components/schemas/KioskBluetoothTerminalInitiateUpdateCheckEvent' example: [] KioskBluetoothInstallUpdateInitiateEvent: description: Bluetooth Terminal Initiate Update type: array items: $ref: '#/components/schemas/KioskBluetoothInstallUpdateInitiateEvent' example: [] KioskBluetoothTerminalCancelUpdateEvent: description: Bluetooth Terminal Cancel Update Install type: array items: $ref: '#/components/schemas/KioskBluetoothTerminalCancelUpdateEvent' example: [] KioskBluetoothTerminalFirmwareVersionStatusEvent: description: Bluetooth Payment Terminal Firmware Version Status Info type: array items: $ref: '#/components/schemas/KioskBluetoothTerminalFirmwareVersionStatusEvent' example: [] KioskBluetoothTerminalInstallationStatusEvent: description: Bluetooth Terminal Update Installation Status type: array items: $ref: '#/components/schemas/KioskBluetoothTerminalInstallationStatusEvent' example: [] PushNotificationScheduledEvent: description: Push notification scheduled event type: array items: $ref: '#/components/schemas/PushNotificationScheduledEvent' example: [] PushNotificationSentEvent: description: Push notification sent event type: array items: $ref: '#/components/schemas/PushNotificationSentEvent' example: [] PushNotificationDeletedEvent: description: Push notification deleted event type: array items: $ref: '#/components/schemas/PushNotificationDeletedEvent' example: [] DnsVerifiedEvent: description: DNS Verified type: array items: $ref: '#/components/schemas/DnsVerifiedEvent' example: [] CertificateCreatedEvent: description: Certificate created type: array items: $ref: '#/components/schemas/CertificateCreatedEvent' example: [] CertificateRenewedEvent: description: Certificate renewed type: array items: $ref: '#/components/schemas/CertificateRenewedEvent' example: [] WebsiteVanityUrlUpdatedEvent: description: Panacea vanity url updated type: array items: $ref: '#/components/schemas/WebsiteVanityUrlUpdatedEvent' example: [] WebsiteUpdatedEvent: description: Website updated type: array items: $ref: '#/components/schemas/WebsiteUpdatedEvent' example: [] OrderCapacityUpdatedEvent: description: Order capacity config updated type: array items: $ref: '#/components/schemas/OrderCapacityConfigUpdatedEvent' example: [] ExternalStoreEvent: description: External event type: array items: $ref: '#/components/schemas/ExternalStoreEvent' example: [] OrderFulfillmentStatusUpdatedEvent: description: Fulfillment status updated event type: array items: $ref: '#/components/schemas/OrderFulfillmentStatusUpdatedEvent' example: [] AppStoreConfigCreatedEvent: description: App Store Config Created type: array items: $ref: '#/components/schemas/AppStoreConfigCreatedEvent' example: [] AppStoreConfigUpdatedEvent: description: App Store Config Updated type: array items: $ref: '#/components/schemas/AppStoreConfigUpdatedEvent' example: [] AppStoreConfigDeletedEvent: description: App Store Config Deleted type: array items: $ref: '#/components/schemas/AppStoreConfigDeletedEvent' example: [] AppStoreSubscriptionChangeJobUpdatedEvent: description: App Store Subscription Change Job Updated type: array items: $ref: '#/components/schemas/AppStoreSubscriptionChangeJobUpdatedEvent' example: [] CatalogItemCreatedEvent: description: Catalog Item Created type: array items: $ref: '#/components/schemas/CatalogItemCreatedEvent' example: [] CatalogItemUpdatedEvent: description: Catalog Item Updated type: array items: $ref: '#/components/schemas/CatalogItemUpdatedEvent' example: [] CatalogItemArchivedEvent: description: Catalog Item Archived type: array items: $ref: '#/components/schemas/CatalogItemArchivedEvent' example: [] CatalogGroupCreatedEvent: description: Catalog Group Created type: array items: $ref: '#/components/schemas/CatalogGroupCreatedEvent' example: [] CatalogGroupUpdatedEvent: description: Catalog Group Updated type: array items: $ref: '#/components/schemas/CatalogGroupUpdatedEvent' example: [] CatalogGroupArchivedEvent: description: Catalog Group Archived type: array items: $ref: '#/components/schemas/CatalogGroupArchivedEvent' example: [] StoreTipUpdatedEvent: description: Store Tip Updated Event type: array items: $ref: '#/components/schemas/StoreTipUpdatedEvent' example: [] LocationAreaCreatedEvent: description: LocationArea created event type: array items: $ref: '#/components/schemas/LocationAreaCreatedEvent' example: [] LocationAreaUpdatedEvent: description: LocationArea updated event type: array items: $ref: '#/components/schemas/LocationAreaUpdatedEvent' example: [] LocationCreatedEvent: description: Location created event type: array items: $ref: '#/components/schemas/LocationCreatedEvent' example: [] LocationDeletedEvent: description: Location deleted event type: array items: $ref: '#/components/schemas/LocationDeletedEvent' example: [] StoreServiceChargeUpdatedEvent: description: Service Charge Updated Event type: array items: $ref: '#/components/schemas/StoreServiceChargeUpdatedEvent' example: [] MobileAppsSubmissionStatusUpdatedEvent: description: Mobile Submission Status Updated Event type: array items: $ref: '#/components/schemas/MobileAppsSubmissionStatusUpdatedEvent' example: [] MobileAppsSubmissionUpdatedEvent: description: Mobile Submission Updated Event type: array items: $ref: '#/components/schemas/MobileAppsSubmissionUpdatedEvent' example: [] StoreFeeConfigUpdatedEvent: description: Store Fee Config Updated Event type: array items: $ref: '#/components/schemas/StoreFeeConfigUpdatedEvent' example: [] OrderCapacityConfigUpdatedEvent: description: Store's Order Capacity Configuration Updated type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Id of the store whose order capacity configuration has been updated type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string OrderCapacityConfig: $ref: '#/components/schemas/StoreOrderCapacityConfigEditModel' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string LoyaltyCampaignUpdatedEvent: description: Loyalty campaign updated event type: object properties: EventName: description: The event name type: string example: Example Name Description: description: Description type: string example: string StoreId: format: int32 description: Store Id type: integer example: 500123 User: $ref: '#/components/schemas/UserEventInfo' LoyaltyCampaign: $ref: '#/components/schemas/LoyaltyCampaign' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string StorePublishedEvent: description: Store Published Event type: object properties: EventName: description: The event name type: string example: Example Name StoreId: format: int32 description: Store Id type: integer example: 500123 StoreGroupId: format: int32 description: Store group Id type: integer readOnly: true example: 500123 User: $ref: '#/components/schemas/UserEventInfo' Description: description: Description type: string example: string Store: $ref: '#/components/schemas/Store' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' OrgId: description: Org id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string Voucher: description: Voucher type: object properties: VoucherId: format: int32 description: Voucher Id type: integer example: 500123 Status: description: Voucher Status enum: - Valid - NotYetValid - Expired - Used - Disabled type: string example: Valid VoucherType: description: Voucher Type enum: - PercentageDiscount - LumpDiscount - AddItem - CreditNote - FreeDelivery type: string example: PercentageDiscount Currency: description: Currency of the voucher enum: - 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 type: string example: EUR StoreNames: description: Stores that this voucher applies to type: array items: type: string example: - Example Name PromotionDetails: $ref: '#/components/schemas/PromotionDetails' CreditNoteDetails: $ref: '#/components/schemas/CreditNoteDetails' LumpDiscountDetails: $ref: '#/components/schemas/LumpDiscountDetails' PercentDiscountDetails: $ref: '#/components/schemas/PercentDiscountDetails' Code: description: Voucher Code type: string example: string Description: description: Voucher Description (Visible on printout) type: string example: string Stores: description: Stores that this voucher applies to type: array items: format: int32 type: integer example: - 1 ValidOnOrdersOver: format: double description: Valid on orders on or above type: number example: 1.0 TakesPriority: description: Takes priority type: boolean example: true IsEnabled: description: Is voucher enabled type: boolean example: true IsAutomaticallyApplied: description: Is voucher automatically applied type: boolean example: true IncludeDeliveryFee: description: Include delivery fees type: boolean example: true IsValidForDeliveryOrders: description: Valid for delivery orders type: boolean example: true IsValidForPickupOrders: description: Valid for pickup orders type: boolean example: true IsValidForOrdersPayedOnline: description: Valid for orders payed online type: boolean example: true IsValidForOrdersPayedByCash: description: Valid for orders payed in cash type: boolean example: true IsValidForFirstOrderOnly: description: Valid only on the first order by the customer type: boolean example: true IsValidOncePerCustomer: description: Valid once per customer type: boolean example: true IsValidOnlyOnce: description: Valid only once, by any customer (once used cannot be used again by any other customer) type: boolean example: true IsDiscoverable: description: Enables the voucher to be offered in the Voucher Discoverability feature type: boolean example: true ForceDiscount: description: Force the discount to be applied which bypasses some menu restrictions type: boolean example: true StartDate: format: date-time description: Voucher Starts On (Time in UTC) type: string example: '2026-06-02T12:00:00Z' ExpiryDate: format: date-time description: Voucher Expires On (Time in UTC) type: string example: '2026-06-02T12:00:00Z' ChannelRestrictions: description: Limit the channels this voucher can be used on type: array items: enum: - Ios - Android - Web - Kiosk - Pos - Google type: string example: - Ios ValidityPeriods: description: "Periods in which the voucher is valid.\r\nAn empty list means the voucher is valid at all times.\r\nWhen updating the voucher, if this is set to null, the validity periods won't be updated." type: array items: $ref: '#/components/schemas/ValidityPeriod' example: [] VoucherSubType: description: Voucher Subtype enum: - None - SignUp - Loyalty - Loyalty25 - Retention - SecondaryRetention - Custom type: string example: None CustomerId: format: int32 description: Customer UserID type: integer nullable: true example: 500123 MaxRedemptions: format: int32 description: Maximum number of times the voucher can be redeemed (used) type: integer nullable: true example: 1 StoreLogoDeletedEvent: description: Store logo deleted type: object properties: EventName: description: The event name type: string example: Example Name OrgId: description: Organisation Id type: string example: '500123' StoreId: format: int32 description: ID of store that the logo has been added to type: integer example: 500123 Description: description: Description type: string example: string User: $ref: '#/components/schemas/UserEventInfo' FlipdishEventId: format: uuid description: The identitfier of the event type: string example: 00000000-0000-0000-0000-000000000000 CreateTime: format: date-time description: The time of creation of the event type: string example: '2026-06-02T12:00:00Z' Position: format: int32 description: Position type: integer example: 1 AppId: description: App id type: string example: '500123' IpAddress: description: Ip Address type: string example: string ActivityId: description: Activity Id type: string example: '500123' ActivityType: description: Activity Type type: string example: string WebhookSubscriptionEventInfo: description: '' type: object properties: OwnerUserId: format: int32 description: Webhook subscription owner user identifier type: integer example: 500123 WebhookSubscriptionId: format: int32 description: Webhook subscription identifier type: integer example: 500123 ClientId: description: Oauth client identifier type: string example: '500123' CallbackUrl: description: Webhook callback url type: string example: https://api.flipdish.co/example securitySchemes: oauth2: type: oauth2 description: OAuth 2.0. Implicit grant for first-party portal apps; client credentials grant for server-to-server App Store apps (exchange Client ID + Secret Key for a bearer access token). flows: implicit: authorizationUrl: https://api.flipdish.co/identity/connect/authorize scopes: api: Access to the Flipdish API clientCredentials: tokenUrl: https://api.flipdish.co/identity/connect/token scopes: api: Access to the Flipdish API