# Flipdish Documentation > Documentation for Flipdish ## Guides - [API Overview](https://developers.flipdish.com/docs/api-overview.md): Integrate with Flipdish: manage orgs, menus, sales, webhooks, and more via REST APIs with OAuth2 authentication. - [Error Handling](https://developers.flipdish.com/docs/error-handling.md): Details on how the Flipdish API will handle errors - [Webhooks](https://developers.flipdish.com/docs/webhooks-overview.md): Receive real-time HTTP notifications when events occur in your Flipdish account. New integrations should use Flipdish Webhooks (v3.0). - [Subscribe to Flipdish Events (v3)](https://developers.flipdish.com/docs/webhooks-v3.md): Configure webhook subscriptions to receive real-time HTTP POST notifications for events in your Flipdish account. - [Flipdish events (v3) overview](https://developers.flipdish.com/docs/flipdish-events-v3-overview.md): A catalog of every Flipdish Webhooks (v3) event type, what triggers it, and when to use it, with links to the full schema for each. - [Connect the Flipdish MCP Server to Claude](https://developers.flipdish.com/docs/connect-flipdish-mcp-server-to-claude.md) - [add-connector-dialog](https://developers.flipdish.com/docs/add-connector-dialog.md) - [add-custom-connector](https://developers.flipdish.com/docs/add-custom-connector.md) - [claude-settings-connectors](https://developers.flipdish.com/docs/claude-settings-connectors.md) - [connector-not-connected](https://developers.flipdish.com/docs/connector-not-connected.md) - [flipdish-login](https://developers.flipdish.com/docs/flipdish-login.md) - [permission-request](https://developers.flipdish.com/docs/permission-request.md) - [tool-permissions](https://developers.flipdish.com/docs/tool-permissions.md) - [Sales Management API](https://developers.flipdish.com/docs/sales-management-api.md): How to create, cancel, and query sales using the v3.0 Sales Management API — including the new org-wide query endpoints - [Sale webhook events](https://developers.flipdish.com/docs/sale-events.md): The sale.* event family delivers full sale payloads inline for every sale recorded on Flipdish, regardless of channel. - [Getting Started with Flipdish API](https://developers.flipdish.com/docs/getting-started.md): Set up your Flipdish App, get an access token, and make your first API call. ## API Reference - [Get all orgs](https://developers.flipdish.com/reference/getallorgs.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Retrieve a list of all orgs - [Create a new org](https://developers.flipdish.com/reference/createorg.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Create a new org in the system - [Get org by orgId](https://developers.flipdish.com/reference/getorgbyid.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Retrieve details of an org by its orgId - [Update org by orgId](https://developers.flipdish.com/reference/updateorgbyid.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Update the details of an org by its orgId - [Clear the org switcher cache](https://developers.flipdish.com/reference/clearorgswitchercache.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Clear the org switcher cache - [Clear the recent orgs object from get orgs response](https://developers.flipdish.com/reference/clearrecentorgs.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Clear the recent orgs object from get orgs response - [Get all brands](https://developers.flipdish.com/reference/getallbrands.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Retrieve a list of all brands - [Get all brands for an org](https://developers.flipdish.com/reference/getbrandsbyorgid.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Retrieve a list of all brands for a specific org - [Create a new brand for an org](https://developers.flipdish.com/reference/createbrandfororg.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Create a new brand under a specific org - [Get brand by ID](https://developers.flipdish.com/reference/getbrandbyid.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Retrieve details of a brand by its ID under a specific org - [Update brand by ID](https://developers.flipdish.com/reference/updatebrandbyid.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Update the details of a brand by its ID under a specific org - [Get all properties for an org](https://developers.flipdish.com/reference/getpropertiesbyorgid.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Retrieve a list of all properties for a specific org - [Create a new property for an org](https://developers.flipdish.com/reference/createpropertyfororg.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Create a new property under a specific org - [Get property by ID](https://developers.flipdish.com/reference/getpropertybyid.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Retrieve details of a property by its ID under a specific org - [Update property by ID](https://developers.flipdish.com/reference/updatepropertybyid.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Update the details of a property by its ID under a specific org - [Get opening hours for a property](https://developers.flipdish.com/reference/getopeninghoursbypropertyid.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Retrieve a list of all opening hours for a specific property - [Update opening hours for a property](https://developers.flipdish.com/reference/updateopeninghoursforproperty.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Update opening hours for a specific property - [Archive a property](https://developers.flipdish.com/reference/archiveproperty.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Archive a specific property and all its associated sales channels under a given org - [Unarchive a property](https://developers.flipdish.com/reference/unarchiveproperty.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Unarchive a specific property under a given org. Note: This does not unarchive associated sales channels. - [Get VAT info for a property](https://developers.flipdish.com/reference/getpropertyvatinfobyorgidandpropertyid.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Retrieve a list of all sales channels for a specific org and property - [Get all sales channels for a property and an org](https://developers.flipdish.com/reference/getsaleschannelsbyorgidandpropertyid.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Retrieve a list of all sales channels for a specific org and property - [Create a new sales channel for an org and property](https://developers.flipdish.com/reference/createsaleschannelfororgandproperty.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Create a new sales channel under a specific org and linked to a property and brand - [Get sales channel by ID](https://developers.flipdish.com/reference/getsaleschannelbyid.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Retrieve details of a sales channel by its ID under a specific org and a specific property - [Update sales channel by ID](https://developers.flipdish.com/reference/updatesaleschannelbyid.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Update the details of a sales channel by its ID under a specific org and property - [Archive a sales channel](https://developers.flipdish.com/reference/archivesaleschannel.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Archive a specific sales channel under a given property and org. - [Unarchive a sales channel](https://developers.flipdish.com/reference/unarchivesaleschannel.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Unarchive a specific sales channel under a given property and org. - [Publish a sales channel](https://developers.flipdish.com/reference/publishsaleschannel.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Publish a specific sales channel under a given property and org. - [Unpublish a sales channel](https://developers.flipdish.com/reference/unpublishsaleschannel.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Unpublish a specific sales channel under a given property and org. - [Clone a sales channel](https://developers.flipdish.com/reference/clonesaleschannel.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Clone a specific sales channel under a given property and org. - [Create a linked sales channel to a sales channel](https://developers.flipdish.com/reference/createlinkedsaleschannel.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Create a linked sales channel to a sales channel under a given property and org. - [Get opening hours for a sales channel](https://developers.flipdish.com/reference/getopeninghoursbysaleschannelid.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Retrieve a list of all opening hours for a specific sales channel - [Update opening hours for a sales channel](https://developers.flipdish.com/reference/updateopeninghoursforsaleschannel.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Update opening hours for a specific sales channel - [Get enabled dispatch types for a sales channel](https://developers.flipdish.com/reference/getdispatchtypesbysaleschannelid.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Retrieve a list of all enabled dispatch types for a specific sales channel - [Publish a menu to a sales channel](https://developers.flipdish.com/reference/publishmenutosaleschannel.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Publish a menu to a specific sales channel - [Create a direct integration order ingest for a sales channel](https://developers.flipdish.com/reference/createdirectintegrationorderingestforsaleschannel.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Create a direct integration order ingest for a specific sales channel - [Upload an image](https://developers.flipdish.com/reference/uploadimage.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Upload an image to the server - [Get address templates](https://developers.flipdish.com/reference/getaddresstemplates.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Get address templates obtained from the provided address - [Transfer a brand to a another org](https://developers.flipdish.com/reference/transferbrand.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Transfer a brand from one org to another. - [Get price bands for an org](https://developers.flipdish.com/reference/getpricebandsbyorgid.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Retrieve a list of all price bands for a specific org - [Get menu headers](https://developers.flipdish.com/reference/get__menumanagement_orgs__orgid_menus_headers_0.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Get menu headers - [Get menu headers for menus assigned to Flipdish online ordering sales channels](https://developers.flipdish.com/reference/get__menumanagement_orgs__orgid_menus_online_ordering_1.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Get menu headers for menus assigned to Flipdish online ordering sales channels - [Get all published menus](https://developers.flipdish.com/reference/get__menumanagement_orgs__orgid_menus_published_2.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Get all published menus - [Get all charges](https://developers.flipdish.com/reference/get__menumanagement_orgs__orgid_charges_3.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Get all charges - [Archive a menu](https://developers.flipdish.com/reference/delete__menumanagement_orgs__orgid_menus__menuid_4.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Archive a menu - [Update menu keeping the same revision](https://developers.flipdish.com/reference/put__menumanagement_orgs__orgid_menus__menuid_8.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Update menu keeping the same revision - [Get the latest published version of a menu. Uses the revision from the most recent publish event for this menu (across all sales channels). The response includes `menuPublishId` for the latest publish event tied to that revision. Returns 404 if the menu has never been published.](https://developers.flipdish.com/reference/get__menumanagement_orgs__orgid_menus__menuid_published_5.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Get the latest published version of a menu. Uses the revision from the most recent publish event for this menu (across all sales channels). The response includes `menuPublishId` for the latest publish event tied to that revision. Returns 404 if the menu has never been published. - [Get metadata for a specific menu item or modifier.](https://developers.flipdish.com/reference/get__menumanagement_orgs__orgid_menus__menuid__revisionid_items__itemid_metadata_6.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Get metadata for a specific menu item or modifier. - [Get current version of a menu](https://developers.flipdish.com/reference/get__menumanagement_orgs__orgid_menus__menuid_current_7.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Get current version of a menu - [Get all properties and sales channels referring to a menu](https://developers.flipdish.com/reference/get__menumanagement_orgs__orgid_menus__menuid_references_9.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Get all properties and sales channels referring to a menu - [Create new menu](https://developers.flipdish.com/reference/post__menumanagement_orgs__orgid_menus_10.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Create new menu - [Get itmes that are either snoozed or not at this moment (datetime.utcnow())](https://developers.flipdish.com/reference/get__menumanagement_orgs__orgid_menus__menuid_snoozes_11.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Get itmes that are either snoozed or not at this moment (datetime.utcnow()) - [Snooze items](https://developers.flipdish.com/reference/post__menumanagement_orgs__orgid_menus__menuid_snoozes_12.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Snooze items - [Un-Snooze items](https://developers.flipdish.com/reference/post__menumanagement_orgs__orgid_menus__menuid_un_snoozes_13.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Un-Snooze items - [Get all revisions of a menu](https://developers.flipdish.com/reference/get__menumanagement_orgs__orgid_menus__menuid_revisions_14.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Get all revisions of a menu - [Get specific revision of a menu](https://developers.flipdish.com/reference/get__menumanagement_orgs__orgid_menus__menuid_revisions__revisionid_15.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Get specific revision of a menu - [Export menu in specific format](https://developers.flipdish.com/reference/get__menumanagement_orgs__orgid_menus__menuid_revisions__revisionid_export__channel_16.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Export menu in specific format - [Check if menu can be published](https://developers.flipdish.com/reference/get__menumanagement_orgs__orgid_menus__menuid_revisions__revisionid_publishcheck_17.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Check if menu can be published - [Publish a specific revision of a menu](https://developers.flipdish.com/reference/post__menumanagement_orgs__orgid_menus__menuid_revisions__revisionid_publish_18.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Publish a specific revision of a menu - [menu published v1](https://developers.flipdish.com/reference/post_menu-published-v1.md): Emitted when an org publishes a menu (new or updated), making it available to sales channels and integrations. - [menu validation failed v1](https://developers.flipdish.com/reference/post_menu-validation-failed-v1.md): Emitted when a menu validation fails after a menu publish. - [menu item snoozed v1](https://developers.flipdish.com/reference/post_menu-item-snoozed-v1.md): Emitted when a menu item is snoozed - [menu item unsnoozed v1](https://developers.flipdish.com/reference/post_menu-item-unsnoozed-v1.md): Emitted when a menu item is unsnoozed - [sales_channel snoozed v1](https://developers.flipdish.com/reference/post_sales-channel-snoozed-v1.md): Emitted when a sales channel is snoozed - [sales_channel unsnoozed v1](https://developers.flipdish.com/reference/post_sales-channel-unsnoozed-v1.md): Emitted when a sales channel is un-snoozed - [sales_channel snoozed_menu_items updated v1](https://developers.flipdish.com/reference/post_sales-channel-snoozed-menu-items-updated-v1.md): Emitted whenever the set of snoozed menu items on a sales channel's published menu changes, i.e. an item is snoozed or un-snoozed. Carries the full current list of snoozed items for the sales channel in a single event, replacing the need to consume separate per-item snooze/unsnooze events. An empty items array means no items are currently snoozed. - [sale accepted v1](https://developers.flipdish.com/reference/post_sale-accepted-v1.md): Emitted when an accepted-first lifecycle sale has been accepted by the receiver. Carries the full sale payload at the moment of acceptance — the sale status is implied by the event name and is not included in the payload. Listen for this event when you need to act on sale acceptance. To track other lifecycle transitions, see `sale.status.updated.v1`. **Beta feature**: this event is in closed beta — request access by emailing [integrations@flipdish.com](mailto:integrations@flipdish.com). - [sale created v1](https://developers.flipdish.com/reference/post_sale-created-v1.md): Emitted when any order is ingested by Flipdish, regardless of channel (POS, kiosk, web, marketplace, or API). Carries the full sale payload inline, so no follow-up GET is required. Read the [Sale events guide](https://developers.flipdish.com/docs/sale-events) to understand the sale event family. **Beta feature**: this event is in closed beta — request access by emailing [integrations@flipdish.com](mailto:integrations@flipdish.com). - [sale updated v1](https://developers.flipdish.com/reference/post_sale-updated-v1.md): Emitted when any order ingested by Flipdish is materially updated (e.g. items, charges, or discounts changed). Carries the full post-update sale payload inline, so no follow-up GET is required. Read the [Sale events guide](https://developers.flipdish.com/docs/sale-events) to understand how `sale.updated.v1` differs from other sale events. **Beta feature**: this event is in closed beta — request access by emailing [integrations@flipdish.com](mailto:integrations@flipdish.com). - [sale status updated v1](https://developers.flipdish.com/reference/post_sale-status-updated-v1.md): Emitted when any Flipdish sale transitions to a new lifecycle status, regardless of channel (POS, kiosk, web, marketplace, or API). Read the [Sale events guide](https://developers.flipdish.com/docs/sale-events) to understand how `sale.status.updated.v1` differs from other sale events. **Beta feature**: this event is in closed beta — request access by emailing [integrations@flipdish.com](mailto:integrations@flipdish.com). - [List webhook subscriptions](https://developers.flipdish.com/reference/listwebhooksubscriptions.md): Retrieve all webhook subscriptions configured for a specific org. Webhook subscriptions define which business events (like orders, menu updates, customer registrations) your application wants to receive notifications about. Each subscription specifies: - **Event types**: Which business events to monitor (e.g., order.created, menu.published) - **Callback URL**: Where to send webhook notifications (must be HTTPS) - **Property scope**: Either all properties or a specific restaurant location - **Delivery preferences**: Retry settings and alert emails This endpoint returns a consolidated view where multiple event types for the same subscription are grouped together, making it easy to understand your webhook configuration at a glance. **Use cases:** - Dashboard displaying current webhook integrations - Audit webhook configurations across your org - Troubleshoot webhook delivery issues - Monitor which events your integration is subscribed to - [Create webhook subscription](https://developers.flipdish.com/reference/createwebhooksubscription.md): Create a new webhook subscription to start receiving real-time notifications about business events in your Flipdish org. **What is a webhook subscription?** A webhook subscription tells Flipdish which business events you want to monitor and where to send notifications when those events occur. For example, you might want to receive notifications whenever: - A new order is placed (order.created) - A menu is updated (menu.published) - A customer registers (customer.created) **How it works:** 1. **Choose events**: Select which business events matter to your integration 2. **Set destination**: Provide an HTTPS endpoint where we'll send notifications 3. **Configure scope**: Subscribe to events from all properties or specific ones 4. **Receive webhooks**: Get real-time HTTP POST requests with event data **Event delivery:** - Events are delivered as HTTP POST requests to your callback URL - Includes event data, and signature for verification - Automatic retries for failed deliveries - Alert emails for persistent delivery failures **Security:** - All webhook URLs must use HTTPS for security - Each subscription includes a secret for signature verification - Webhooks include timing and idempotency headers for deduplication - [Delete webhook subscription](https://developers.flipdish.com/reference/deletewebhooksubscription.md): Permanently delete a webhook subscription and stop receiving event notifications for the specified subscription. **What happens when you delete a subscription:** - **Immediate effect**: No new webhooks will be sent to the callback URL - **Event history**: Past webhook deliveries remain in logs for audit purposes - **Multi-event cleanup**: All event types associated with this subscription are removed - **No recovery**: Deleted subscriptions cannot be restored (you'll need to create a new one) **Before deleting:** - Ensure your application no longer needs these webhook notifications - Consider disabling the subscription temporarily instead if you're unsure - Review which event types will be affected by this deletion **Use cases:** - Removing outdated or unused webhook integrations - Cleaning up test subscriptions - Migrating to new webhook endpoints (delete old, create new) - Decommissioning applications that no longer need event notifications - [Update webhook subscription](https://developers.flipdish.com/reference/updatewebhooksubscription.md): Update an existing webhook subscription configuration including callback URL, event types, and delivery settings. **What you can update:** - **Callback URL**: Change where webhooks are delivered (must remain HTTPS) - **Event types**: Add new events to monitor or remove events you no longer need - **Property scope**: Change from specific properties to all properties or vice versa - **Status**: Enable or disable the subscription without deleting it **Update behavior:** - **Atomic operation**: All changes succeed or fail together - **Immediate effect**: Changes apply to new events immediately - **Event history**: Past webhook deliveries are not affected - **Validation**: New event types must exist in the event catalog and be enabled **Common update scenarios:** - **Expand monitoring**: Add new event types as your integration grows - **Change destination**: Update callback URL when moving to new infrastructure - **Maintenance mode**: Temporarily disable without losing configuration **Important notes:** - Removing event types stops future notifications for those events - URL changes take effect immediately for new events - Disabled subscriptions retain configuration but stop sending webhooks - [Trigger test webhook deliveries for a subscription](https://developers.flipdish.com/reference/triggerwebhooksubscriptiontest.md): Send synthetic test events to verify webhook subscription configuration and endpoint availability. **What this does:** - **Generates test events**: Creates synthetic events for all event types in the subscription - **Sends webhooks**: Delivers test webhooks to the configured callback URL - **Returns event IDs**: Provides unique identifiers to track and verify test deliveries - **Validates endpoint**: Tests that your webhook endpoint can receive and process events **Testing workflow:** 1. **Trigger**: Call this endpoint to send test events 2. **Track**: Use returned eventIds to monitor delivery status 3. **Verify**: Check your endpoint received the webhooks correctly 4. **Debug**: Use delivery records to troubleshoot issues **Test event characteristics:** - Contains sample data structure matching real events - Includes metadata indicating it's a test event - Follows same delivery flow as production webhooks - Can be verified using the delivery verification endpoint **Common use cases:** - **Integration testing**: Verify your webhook handler works correctly - **Endpoint validation**: Confirm callback URL is accessible and responds properly - **Development**: Test changes without waiting for real events - **Monitoring**: Verify subscription is active and functioning **Important notes:** - Test events are clearly marked as synthetic/test data - Delivery records expire after 7 days (TTL) - Use eventIds with GET /synthetic-delivery to verify delivery status - Does not affect production event delivery or subscription configuration - [Update menu publish status for a sales channel](https://developers.flipdish.com/reference/post__operations_updates_orgs__orgid_properties__propertyid_saleschannels__saleschannelid_menu_publish_status_0.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Update menu publish status for a sales channel - [Update menu item or store snooze status for a sales channel](https://developers.flipdish.com/reference/post__operations_updates_orgs__orgid_properties__propertyid_saleschannels__saleschannelid_item_snooze_status_1.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Update menu item or store snooze status for a sales channel - [Update store snooze status for a sales channel](https://developers.flipdish.com/reference/post__operations_updates_orgs__orgid_properties__propertyid_saleschannels__saleschannelid_store_snooze_status_2.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Update store snooze status for a sales channel - [Publish an audit log entry](https://developers.flipdish.com/reference/post__auditlogs_orgs__orgid_0.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Publish an audit log entry to the Org audit trail. This endpoint records user actions, system events, and operational changes with configurable severity levels and contextual metadata. Ideal for compliance requirements, security monitoring, debugging, and business intelligence reporting. - [Sales Management](https://developers.flipdish.com/reference/sales-management.md) - [Create a sale](https://developers.flipdish.com/reference/post__salesmanagement_orgs__orgid_sales_0.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Records a completed sale against an org. Use this endpoint to ingest sales from an external point-of-sale, ordering, or marketplace system into Flipdish so they appear in reporting, reconciliation, and the audit trail. Each request must include a unique `x-idempotency-key` header. Retries with the same key return the original response instead of producing a duplicate sale, which makes the call safe to retry on network failures. - [Cancel a sale](https://developers.flipdish.com/reference/post__salesmanagement_orgs__orgid_sales__saleid_cancel_1.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Marks an existing sale as cancelled on the specified sales channel. Use this endpoint when a customer cancels their order, the store is unable to fulfil it, or the sale was created in error. Supply a `cancellationReason` from the documented enum and, optionally, a free-text `cancellationNotes` value (max 255 characters) to record additional context for reporting and audit. Cancellation is final: a cancelled sale cannot be reactivated, so submit a new sale if the customer reorders. - [Update sale delivery status](https://developers.flipdish.com/reference/post__salesmanagement_orgs__orgid_sales__saleid_deliverystatus_2.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change or be deprecated at any time without notice. Records a delivery status transition for an existing sale so Flipdish stays in sync with the real-world fulfilment progress of the order. Set the status to `SALE_DISPATCHED` when the order leaves the kitchen with a driver, and to `SALE_DELIVERED` once the customer has received it. Updates surface in operational dashboards and downstream reporting, and are intended to be sent in order as the sale progresses through fulfilment. - [Sales](https://developers.flipdish.com/reference/sales.md) - [Get a sale](https://developers.flipdish.com/reference/getsale-1.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change without notice. Returns the projected sale for the given org/sale. Returns the projected sale for the given org and `saleId`. Unlike sales-channel-scoped GET endpoints on the main Sales Management API, this call does not require a `salesChannelId`. - [List sales](https://developers.flipdish.com/reference/listorgsales.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change without notice. Returns paginated full sale payloads for the org, sorted by creation time descending. Supports pagination via `pageSize` and `cursor`, and optional `after` / `before` UTC datetime filters on `createdAt`. Returns paginated full sale payloads including the nested `sale` object. Supports pagination via `pageSize` and `cursor`, and optional `after` / `before` UTC datetime filters on `createdAt`. - [List sales for a property](https://developers.flipdish.com/reference/listpropertysales.md): ⚠️ **Beta Notice:** This endpoint is currently in beta and may change without notice. Returns paginated full sale payloads for the given org and property, sorted by creation time descending. Supports pagination via `pageSize` and `cursor`, and optional `after` / `before` UTC datetime filters on `createdAt`. Returns paginated full sale payloads for the given org and property, including the nested `sale` object. Supports pagination via `pageSize` and `cursor`, and optional `after` / `before` UTC datetime filters on `createdAt`.