Flipdish
Flipdish is an online ordering and branded-app platform that gives restaurants and takeaways their own websites, mobile apps, kiosks, and order-management tools to take direct, commission-friendly orders. For developers and integration partners, Flipdish exposes a REST API (Flipdish Open API v1.0, base URL https://api.flipdish.co) documented in its Developer Hub, covering stores, orders, menus, catalog, customers, vouchers and campaigns, payouts and payments, apps and channels, devices, and platform resources, plus webhook/event subscriptions. Authentication uses OAuth 2.0 (implicit grant for first-party portal apps; client-credentials for server-to-server App Store apps). A Swagger specification at https://api.flipdish.co/swagger/docs/v1.0 and pre-generated SDKs (C#, Java, PHP, JavaScript, TypeScript, plus a SignalR realtime client) are published from the flipdishbytes GitHub org.
Flipdish publishes 85 APIs on the APIs.io network, including Accounts API, Address API, Apm API, and 82 more. Tagged areas include Restaurant, Online Ordering, Mobile Apps, Point of Sale, and Orders.
The Flipdish catalog on APIs.io includes 10 JSON-LD contexts and 2 Spectral governance rulesets.
Flipdish’s developer surface includes authentication, documentation, API reference, getting-started guide, pricing, signup flow, support, and 28 more developer resources.
59.1/100
strong
▼ -5.5
Agent
44/100
agent ready
AccessPaidApproval
85 APIs
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks
Kin Score
Kin Score
How this is scored →scored 2026-07-28 · rubric v0.6
Composite quality — 59.1/100 · strong
Contract Quality
17.7 / 25
Developer Ergonomics
12.6 / 20
Commercial Clarity
12.6 / 20
Operational Transparency
3.4 / 13
Governance
8.3 / 12
Discoverability
7.4 / 10
Agent readiness — 44/100 · agent ready
Machine-Readable Contract
18 / 18
Agentic Access Contract
10 / 10
MCP Server
0 / 12
Machine-Readable Auth
10 / 10
Idempotency
0 / 9
Stable Error Semantics
8 / 8
Request/Response Examples
7 / 7
Rate-Limit Signaling
7 / 7
Typed Event Surface
0 / 6
Agent Skills
0 / 5
Well-Known Catalog
0 / 4
Consent & Bot Identity
0 / 3
A2A Agent Card
0 / 8
Dry-Run / Simulate Mode
0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/flipdish: open an issue to ask a question, or submit a pull request to add artifacts.
Want it done for you? Prioritized profiling — $2,500 →
APIs 85
Individual APIs this provider publishes, each with its own machine-readable definition.
Flipdish Accounts API
Operations for Accounts.
Flipdish Address API
Operations for Address.
Flipdish Apm API
Operations for Apm.
Flipdish Apps API
Operations for Apps.
Flipdish AppStore API
Operations for App Store.
Flipdish AppStoreConfigurations API
Operations for App Store Configurations.
Flipdish AppStoreDeveloper API
Operations for App Store Developer.
Flipdish AppStoreEntitlements API
Operations for App Store Entitlements.
Flipdish AuditLogs API
Operations for Audit Logs.
Flipdish AuthorizationTokens API
Operations for Authorization Tokens.
Flipdish BankAccount API
Operations for Bank Account.
Flipdish Campaigns API
Operations for Campaigns.
Flipdish CardReaders API
Operations for Card Readers.
Flipdish CatalogChanges API
Operations for Catalog Changes.
Flipdish CatalogGroups API
Operations for Catalog Groups.
Flipdish CatalogImages API
Operations for Catalog Images.
Flipdish CatalogItems API
Operations for Catalog Items.
Flipdish CatalogProducts API
Operations for Catalog Products.
Flipdish Channels API
Operations for Channels.
Flipdish Clients API
Operations for Clients.
Flipdish ContentSecurityPolicy API
Operations for Content Security Policy.
Flipdish CrossSell API
Operations for Cross Sell.
Flipdish Customers API
Operations for Customers.
Flipdish DeliveryZone API
Operations for Delivery Zone.
Flipdish Device API
Operations for Device.
Flipdish Drivers API
Operations for Drivers.
Flipdish Events API
Operations for Events.
Flipdish Features API
Operations for Features.
Flipdish Files API
Operations for Files.
Flipdish FirebaseApps API
Operations for Firebase Apps.
Flipdish Fpm API
Operations for Fpm.
Flipdish FulfillmentStateConfiguration API
Operations for Fulfillment State Configuration.
Flipdish Heartbeat API
Operations for Heartbeat.
Flipdish Home API
Operations for Home.
Flipdish Hydra API
Operations for Hydra.
Flipdish Intercom API
Operations for Intercom.
Flipdish Invoices API
Operations for Invoices.
Flipdish KioskEntitlements API
Operations for Kiosk Entitlements.
Flipdish KioskIot API
Operations for Kiosk Iot.
Flipdish Lightspeed API
Operations for Lightspeed.
Flipdish Location API
Operations for Location.
Flipdish LocationAreas API
Operations for Location Areas.
Flipdish LookerDashboard API
Operations for Looker Dashboard.
Flipdish LookerSingleSignOn API
Operations for Looker Single Sign On.
Flipdish MenuOptionSetItems API
Operations for Menu Option Set Items.
Flipdish MenuOptionSets API
Operations for Menu Option Sets.
Flipdish Menus API
Operations for Menus.
Flipdish MenuSectionItems API
Operations for Menu Section Items.
Flipdish MenuSections API
Operations for Menu Sections.
Flipdish MenusNutritionInfo API
Operations for Menus Nutrition Info.
Flipdish MenusNutritionInfoV2 API
Operations for Menus Nutrition Info V2.
Flipdish MenuZones API
Operations for Menu Zones.
Flipdish MetafieldDefinitions API
Operations for Metafield Definitions.
Flipdish MobileApps API
Operations for Mobile Apps.
Flipdish OAuthClients API
Operations for OAuth Clients.
Flipdish Onboarding API
Operations for Onboarding.
Flipdish OrderBatches API
Operations for Order Batches.
Flipdish OrderBatchingConfiguration API
Operations for Order Batching Configuration.
Flipdish Orders API
Operations for Orders.
Flipdish PaymentIntents API
Operations for Payment Intents.
Flipdish Payments API
Operations for Payments.
Flipdish PayoutReports API
Operations for Payout Reports.
Flipdish Payouts API
Operations for Payouts.
Flipdish PayoutsExport API
Operations for Payouts Export.
Flipdish ProcessingFeeConfigs API
Operations for Processing Fee Configs.
Flipdish PushNotifications API
Operations for Push Notifications.
Flipdish Receipts API
Operations for Receipts.
Flipdish RestaurantVouchersPayGreen API
Operations for Restaurant Vouchers Pay Green.
Flipdish Search API
Operations for Search.
Flipdish SmsProviderCredentials API
Operations for Sms Provider Credentials.
Flipdish StoreGroups API
Operations for Store Groups.
Flipdish StoreOrderCapacity API
Operations for Store Order Capacity.
Flipdish Stores API
Operations for Stores.
Flipdish StripeCustomConnect API
Operations for Stripe Custom Connect.
Flipdish Stuart API
Operations for Stuart.
Flipdish Subscriptions API
Operations for Subscriptions.
Flipdish Teammates API
Operations for Teammates.
Flipdish TerminalIot API
Operations for Terminal Iot.
Flipdish Tips API
Operations for Tips.
Flipdish Users API
Operations for Users.
Flipdish Vouchers API
Operations for Vouchers.
Flipdish Webhooks API
Operations for Webhooks.
Flipdish Website API
Operations for Website.
Flipdish WhiteLabelBuilds API
Operations for White Label Builds.
Flipdish WhiteLabelConfig API
Operations for White Label Config.
Scroll for all 85
Postman Collections 85
Ready-to-run Postman collections for exercising this provider's APIs.
Scroll for all 85
Open Collections 10
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
Flipdish API - Apps
OPEN COLLECTIONFlipdish API - Catalog
OPEN COLLECTIONFlipdish API - Customers
OPEN COLLECTIONFlipdish API - Devices
OPEN COLLECTIONFlipdish API - Marketing
OPEN COLLECTIONFlipdish API - Menus
OPEN COLLECTIONFlipdish API - Orders
OPEN COLLECTIONFlipdish API - Payments
OPEN COLLECTIONFlipdish API - Platform
OPEN COLLECTIONFlipdish API - Stores
OPEN COLLECTIONScroll for all 10
Pricing Plans 1
Published pricing tiers and plan structures.
Rate Limits 1
Documented rate limits and quota policies.
Flipdish Rate Limits
RATE LIMITSFinOps 1
Cost, billing, and metering signals for API financial operations.
Flipdish Finops
FINOPSSemantic Vocabularies 10
JSON-LD contexts and semantic vocabularies used across these APIs.
Flipdish Apps Context
JSON-LDFlipdish Catalog Context
JSON-LDFlipdish Customers Context
JSON-LDFlipdish Devices Context
JSON-LDFlipdish Marketing Context
JSON-LDFlipdish Menus Context
JSON-LDFlipdish Orders Context
JSON-LDFlipdish Payments Context
JSON-LDFlipdish Platform Context
JSON-LDFlipdish Stores Context
JSON-LDScroll for all 10
Spectral Rules 2
Spectral governance rulesets for linting and validating these APIs.
Flipdish API Rules
SPECTRALFlipdish API Rules
SPECTRALJSON Schema 278
Standalone JSON Schema definitions for this provider's data models.
AppConfigSalesChannel
JSON SCHEMAAppConfigUpdateModel
JSON SCHEMAAppGeneralConfigModel
JSON SCHEMAApp
JSON SCHEMAAppStoreAppConfiguration
JSON SCHEMAAppStoreAppConfigurationSummary
JSON SCHEMAAppStoreApp
JSON SCHEMAAppStoreAppSummary
JSON SCHEMAAppStoreAppSupportInfo
JSON SCHEMAAppStoreConfigModel
JSON SCHEMAChannel
JSON SCHEMACreateAppStoreApp
JSON SCHEMAExecuteConfigurationActionResult
JSON SCHEMAFieldGroup
JSON SCHEMAField
JSON SCHEMAFirebaseApp
JSON SCHEMAIndexPageBase
JSON SCHEMAIndexPage
JSON SCHEMAMobileAppsStatistics
JSON SCHEMAMobileAppsSubmissionDetails
JSON SCHEMAMobileAppsSubmission
JSON SCHEMAMobileAppsSubmissionStatus
JSON SCHEMAPlayStoreConfigModel
JSON SCHEMAStream
JSON SCHEMASupportedCountry
JSON SCHEMAUpdateAppStoreApp
JSON SCHEMAUpdateMobileAppsSubmissionStatus
JSON SCHEMAWhiteLabelAssetModel
JSON SCHEMAWhiteLabelColorSchemeModel
JSON SCHEMAWhiteLabelConfigModel
JSON SCHEMACatalogGroupReference
JSON SCHEMACatalogItem
JSON SCHEMACreateCatalogGroupReference
JSON SCHEMACreateCatalogItem
JSON SCHEMACreateGroupReference
JSON SCHEMACreateGroup
JSON SCHEMACreateMetafieldDefinition
JSON SCHEMACreateProductReference
JSON SCHEMACreateProduct
JSON SCHEMAGroupReference
JSON SCHEMAGroup
JSON SCHEMAMetafieldDefinitionRecommendation
JSON SCHEMAMetafieldDefinition
JSON SCHEMAMetafield
JSON SCHEMAOwnerEntityConfiguration
JSON SCHEMAPendingMenuChanges
JSON SCHEMAPendingMenuChangesSummaries
JSON SCHEMAProductReference
JSON SCHEMAProduct
JSON SCHEMAPublishMenuChanges
JSON SCHEMAUpdateCatalogGroupReference
JSON SCHEMAUpdateCatalogItem
JSON SCHEMAUpdateGroupReference
JSON SCHEMAUpdateGroup
JSON SCHEMAUpdateMetafieldDefinition
JSON SCHEMAUpdateProductReference
JSON SCHEMAUpdateProduct
JSON SCHEMAAccountDetailBase
JSON SCHEMAAccountDetail
JSON SCHEMAAppInstall
JSON SCHEMAChannel
JSON SCHEMACreateAccountModel
JSON SCHEMACreateUserDeliveryLocationRequest
JSON SCHEMACustomer
JSON SCHEMACustomerSummary
JSON SCHEMADeliveryLocation
JSON SCHEMALanguage
JSON SCHEMAOrderBatchSummary
JSON SCHEMAOrderDropOffLocation
JSON SCHEMAOrderItemOption
JSON SCHEMAOrderItem
JSON SCHEMAOrder
JSON SCHEMAOrderVoucherSummary
JSON SCHEMAPasswordResetModel
JSON SCHEMAPaymentAccount
JSON SCHEMAPendingInvitation
JSON SCHEMAStoreSummary
JSON SCHEMATeammateBase
JSON SCHEMATeammate
JSON SCHEMAUserDeliveryLocationAdmin
JSON SCHEMAUserInfo
JSON SCHEMAUserMonthlyCommission
JSON SCHEMAUserNote
JSON SCHEMAUserOrderSummary
JSON SCHEMAUserSearch
JSON SCHEMAUserSmsChatItem
JSON SCHEMAUserWhiteLabelConfig
JSON SCHEMABluetoothTerminalStatus
JSON SCHEMACardReaderRegistrationRequest
JSON SCHEMACardReader
JSON SCHEMAClientDeviceAssignEnrolledDevice
JSON SCHEMAClientDeviceEnroll
JSON SCHEMAClientDevice
JSON SCHEMAClientDeviceSummary
JSON SCHEMAGeoPointRequest
JSON SCHEMAKioskEntitlementsResult
JSON SCHEMAReaderActionStateInfo
JSON SCHEMATelemetrySeriesProperty
JSON SCHEMATelemetrySeriesQueryParameters
JSON SCHEMATelemetrySeriesResult
JSON SCHEMAUnRegisterCardReaderRequest
JSON SCHEMACampaignStatistics
JSON SCHEMACreatePayGreenConfigurationRequest
JSON SCHEMACreatePromotion
JSON SCHEMACreateVoucher
JSON SCHEMALoyaltyCampaign
JSON SCHEMAPercentDiscountDetails
JSON SCHEMAPromotionAward
JSON SCHEMAPromotionDetails
JSON SCHEMAPushNotificationResponse
JSON SCHEMARestaurantVoucherAssignedStore
JSON SCHEMARestaurantVoucherEligibleStore
JSON SCHEMARestaurantVoucherPayGreenConfiguration
JSON SCHEMARestaurantVoucherPayGreenStoreConfiguration
JSON SCHEMARetentionCampaign
JSON SCHEMASetVoucherValidityPeriodsSimplifiedRequest
JSON SCHEMAStoreCampaignStartTime
JSON SCHEMAStoreListItem
JSON SCHEMAUpdatePayGreenConfigurationRequest
JSON SCHEMAUpdateStorePayGreenConfigurationRequest
JSON SCHEMAUpdateVoucher
JSON SCHEMAUpdateVoucherUsage
JSON SCHEMAValidityPeriod
JSON SCHEMAVoucherDataPoint
JSON SCHEMAVoucher
JSON SCHEMAVoucherSummary
JSON SCHEMAVoucherWithStats
JSON SCHEMAAllergen
JSON SCHEMABusinessHoursPeriodBase
JSON SCHEMABusinessHoursPeriod
JSON SCHEMACreateFullMenuItemOptionSetItem
JSON SCHEMACreateFullMenuItemOptionSet
JSON SCHEMACreateFullMenu
JSON SCHEMACreateFullMenuSectionItem
JSON SCHEMACreateFullMenuSection
JSON SCHEMACreateMetadata
JSON SCHEMAHttpPostedFileBase
JSON SCHEMAMenuBase
JSON SCHEMAMenuCheckpoint
JSON SCHEMAMenuElementEditResponse
JSON SCHEMAMenuElementListResponse
JSON SCHEMAMenuItemOptionSetBase
JSON SCHEMAMenuItemOptionSetItemBase
JSON SCHEMAMenuItemOptionSetItem
JSON SCHEMAMenuItemOptionSet
JSON SCHEMAMenuNutritionInfoHeader
JSON SCHEMAMenu
JSON SCHEMAMenuSectionBase
JSON SCHEMAMenuSectionItemBase
JSON SCHEMAMenuSectionItem
JSON SCHEMAMenuSection
JSON SCHEMAMenuSummary
JSON SCHEMAMenuTaxDetails
JSON SCHEMAMenuTaxRate
JSON SCHEMAMenuZone
JSON SCHEMAMetadata
JSON SCHEMAStream
JSON SCHEMAChannel
JSON SCHEMACoordinates
JSON SCHEMACreateFulfillmentStatesConfiguration
JSON SCHEMACustomerSummary
JSON SCHEMADeliveryLocation
JSON SCHEMAFeeSummary
JSON SCHEMAFulfillentStatusActionItem
JSON SCHEMAFulfillmentStatesConfiguration
JSON SCHEMAFulfillmentStatesConfigurationSummary
JSON SCHEMAFulfillmentStatusConfigurationItem
JSON SCHEMAMaskedPhoneNumber
JSON SCHEMAOrderBatch
JSON SCHEMAOrderBatchSummary
JSON SCHEMAOrderDeliveryInformationBase
JSON SCHEMAOrderDeliveryInformation
JSON SCHEMAOrderDropOffLocation
JSON SCHEMAOrderFulfillmentStatusBase
JSON SCHEMAOrderFulfillmentStatus
JSON SCHEMAOrderItemOption
JSON SCHEMAOrderItem
JSON SCHEMAOrder
JSON SCHEMAOrderSummary
JSON SCHEMAOrderVoucherSummary
JSON SCHEMARefund
JSON SCHEMAStoreSummary
JSON SCHEMATaxItem
JSON SCHEMATipConfiguration
JSON SCHEMAUpdateFulfillmentStatesConfiguration
JSON SCHEMAUpdateTipConfiguration
JSON SCHEMAAccountFieldDefinition
JSON SCHEMABankAccountDetail
JSON SCHEMABankAccountDetailsUpdateRequest
JSON SCHEMABankAccountSummary
JSON SCHEMAFlipdishFeesDetails
JSON SCHEMAGetReceiptByOrderIdQueryResponse
JSON SCHEMAPayoutChargeback
JSON SCHEMAPayoutDetail
JSON SCHEMAPayoutOrder
JSON SCHEMAPayoutOtherCharge
JSON SCHEMAPayoutRefund
JSON SCHEMAPayoutReport3DetailsAdjustments
JSON SCHEMAPayoutReport3DetailsFlipdishFees
JSON SCHEMAPayoutReport3DetailsRevenue
JSON SCHEMAPayoutReport3DetailsSummary
JSON SCHEMAPayoutReport3OverviewHeader
JSON SCHEMAPayoutReport3RefundedOrder
JSON SCHEMAPayoutReport3StorePayout
JSON SCHEMAPayout
JSON SCHEMAPayoutStore
JSON SCHEMAPreviousOrderItem
JSON SCHEMAPreviousOrder
JSON SCHEMARevenueAdjustmentsDetails
JSON SCHEMARevenueDetail
JSON SCHEMAStripeConnectedAccountInfo
JSON SCHEMAStripeConnectedAccount
JSON SCHEMASubscriptionInvoice
JSON SCHEMASubscription
JSON SCHEMASubscriptionSummary
JSON SCHEMAUpcomingInvoice
JSON SCHEMAAnalyticsClientEvent
JSON SCHEMAAppCreatedEvent
JSON SCHEMAApp
JSON SCHEMAAppUpdatedEvent
JSON SCHEMABankAccount
JSON SCHEMACustomerDeliveryTrackingOrder
JSON SCHEMADeliveryZoneCreatedEvent
JSON SCHEMADeliveryZoneDeletedEvent
JSON SCHEMADeliveryZoneUpdatedEvent
JSON SCHEMAEmvNotificationEvent
JSON SCHEMAEventSearchResult
JSON SCHEMAExternalStoreEvent
JSON SCHEMAJobResponse
JSON SCHEMAKioskBluetoothTerminalUpdatedEvent
JSON SCHEMALightspeedSettings
JSON SCHEMALocationCreatedEvent
JSON SCHEMALoyaltyCampaign
JSON SCHEMAMenuBulkEditEvent
JSON SCHEMAMenuItemOptionSetItem
JSON SCHEMAMenuSectionItem
JSON SCHEMAOrder
JSON SCHEMARetentionCampaign
JSON SCHEMAStoreFeeConfig
JSON SCHEMAStoreFeeConfigUpdatedEvent
JSON SCHEMAStoreOpeningHoursUpdatedEvent
JSON SCHEMAStore
JSON SCHEMAVoucher
JSON SCHEMAWebhookLog
JSON SCHEMAAddressFormResponse
JSON SCHEMABusinessHoursOverrideBase
JSON SCHEMABusinessHoursOverride
JSON SCHEMABusinessHoursPeriodBase
JSON SCHEMABusinessHoursPeriod
JSON SCHEMACreateLocation
JSON SCHEMADeliveryZone
JSON SCHEMADynamicFormField
JSON SCHEMADynamicFormRule
JSON SCHEMADynamicFormRules
JSON SCHEMAGoogleAddressResult
JSON SCHEMAGoogleAddress
JSON SCHEMALocationArea_Location
JSON SCHEMALocationAreaWithLocations
JSON SCHEMAPreOrderConfig
JSON SCHEMAProcessingFeeConfig
JSON SCHEMAServiceCharge
JSON SCHEMAStoreAddressBase
JSON SCHEMAStoreAddress
JSON SCHEMAStoreBase
JSON SCHEMAStoreCollectionSettings
JSON SCHEMAStoreConfig
JSON SCHEMAStoreEndOfDayReport
JSON SCHEMAStoreFeeConfig
JSON SCHEMAStoreGroupExtended
JSON SCHEMAStoreGroup
JSON SCHEMAStoreOrderCapacityConfig
JSON SCHEMAStoreOrderCapacityPeriod
JSON SCHEMAStore
JSON SCHEMAStoreValidationConfig
JSON SCHEMAScroll for all 278
JSON Structure 278
JSON Structure definitions describing this provider's data shapes.
Apps App Config Sales Channel Structure
JSON STRUCTUREApps App Config Update Model Structure
JSON STRUCTUREApps App General Config Model Structure
JSON STRUCTUREApps App Store App Configuration Structure
JSON STRUCTUREApps App Store App Configuration Summary Structure
JSON STRUCTUREApps App Store App Structure
JSON STRUCTUREApps App Store App Summary Structure
JSON STRUCTUREApps App Store App Support Info Structure
JSON STRUCTUREApps App Store Config Model Structure
JSON STRUCTUREApps App Structure
JSON STRUCTUREApps Channel Structure
JSON STRUCTUREApps Create App Store App Structure
JSON STRUCTUREApps Execute Configuration Action Result Structure
JSON STRUCTUREApps Field Group Structure
JSON STRUCTUREApps Field Structure
JSON STRUCTUREApps Firebase App Structure
JSON STRUCTUREApps Index Page Base Structure
JSON STRUCTUREApps Index Page Structure
JSON STRUCTUREApps Mobile Apps Statistics Structure
JSON STRUCTUREApps Mobile Apps Submission Details Structure
JSON STRUCTUREApps Mobile Apps Submission Status Structure
JSON STRUCTUREApps Mobile Apps Submission Structure
JSON STRUCTUREApps Play Store Config Model Structure
JSON STRUCTUREApps Stream Structure
JSON STRUCTUREApps Supported Country Structure
JSON STRUCTUREApps Update App Store App Structure
JSON STRUCTUREApps Update Mobile Apps Submission Status Structure
JSON STRUCTUREApps White Label Asset Model Structure
JSON STRUCTUREApps White Label Color Scheme Model Structure
JSON STRUCTUREApps White Label Config Model Structure
JSON STRUCTURECatalog Catalog Group Reference Structure
JSON STRUCTURECatalog Catalog Item Structure
JSON STRUCTURECatalog Create Catalog Group Reference Structure
JSON STRUCTURECatalog Create Catalog Item Structure
JSON STRUCTURECatalog Create Group Reference Structure
JSON STRUCTURECatalog Create Group Structure
JSON STRUCTURECatalog Create Metafield Definition Structure
JSON STRUCTURECatalog Create Product Reference Structure
JSON STRUCTURECatalog Create Product Structure
JSON STRUCTURECatalog Group Reference Structure
JSON STRUCTURECatalog Group Structure
JSON STRUCTURECatalog Metafield Definition Recommendation Structure
JSON STRUCTURECatalog Metafield Definition Structure
JSON STRUCTURECatalog Metafield Structure
JSON STRUCTURECatalog Owner Entity Configuration Structure
JSON STRUCTURECatalog Pending Menu Changes Structure
JSON STRUCTURECatalog Pending Menu Changes Summaries Structure
JSON STRUCTURECatalog Product Reference Structure
JSON STRUCTURECatalog Product Structure
JSON STRUCTURECatalog Publish Menu Changes Structure
JSON STRUCTURECatalog Update Catalog Group Reference Structure
JSON STRUCTURECatalog Update Catalog Item Structure
JSON STRUCTURECatalog Update Group Reference Structure
JSON STRUCTURECatalog Update Group Structure
JSON STRUCTURECatalog Update Metafield Definition Structure
JSON STRUCTURECatalog Update Product Reference Structure
JSON STRUCTURECatalog Update Product Structure
JSON STRUCTURECustomers Account Detail Base Structure
JSON STRUCTURECustomers Account Detail Structure
JSON STRUCTURECustomers App Install Structure
JSON STRUCTURECustomers Channel Structure
JSON STRUCTURECustomers Create Account Model Structure
JSON STRUCTURECustomers Customer Structure
JSON STRUCTURECustomers Customer Summary Structure
JSON STRUCTURECustomers Delivery Location Structure
JSON STRUCTURECustomers Language Structure
JSON STRUCTURECustomers Order Batch Summary Structure
JSON STRUCTURECustomers Order Drop Off Location Structure
JSON STRUCTURECustomers Order Item Option Structure
JSON STRUCTURECustomers Order Item Structure
JSON STRUCTURECustomers Order Structure
JSON STRUCTURECustomers Order Voucher Summary Structure
JSON STRUCTURECustomers Password Reset Model Structure
JSON STRUCTURECustomers Payment Account Structure
JSON STRUCTURECustomers Pending Invitation Structure
JSON STRUCTURECustomers Store Summary Structure
JSON STRUCTURECustomers Teammate Base Structure
JSON STRUCTURECustomers Teammate Structure
JSON STRUCTURECustomers User Delivery Location Admin Structure
JSON STRUCTURECustomers User Info Structure
JSON STRUCTURECustomers User Monthly Commission Structure
JSON STRUCTURECustomers User Note Structure
JSON STRUCTURECustomers User Order Summary Structure
JSON STRUCTURECustomers User Search Structure
JSON STRUCTURECustomers User Sms Chat Item Structure
JSON STRUCTURECustomers User White Label Config Structure
JSON STRUCTUREDevices Bluetooth Terminal Status Structure
JSON STRUCTUREDevices Card Reader Registration Request Structure
JSON STRUCTUREDevices Card Reader Structure
JSON STRUCTUREDevices Client Device Assign Enrolled Device Structure
JSON STRUCTUREDevices Client Device Enroll Structure
JSON STRUCTUREDevices Client Device Structure
JSON STRUCTUREDevices Client Device Summary Structure
JSON STRUCTUREDevices Geo Point Request Structure
JSON STRUCTUREDevices Kiosk Entitlements Result Structure
JSON STRUCTUREDevices Reader Action State Info Structure
JSON STRUCTUREDevices Telemetry Series Property Structure
JSON STRUCTUREDevices Telemetry Series Query Parameters Structure
JSON STRUCTUREDevices Telemetry Series Result Structure
JSON STRUCTUREDevices Un Register Card Reader Request Structure
JSON STRUCTUREMarketing Campaign Statistics Structure
JSON STRUCTUREMarketing Create Promotion Structure
JSON STRUCTUREMarketing Create Voucher Structure
JSON STRUCTUREMarketing Loyalty Campaign Structure
JSON STRUCTUREMarketing Percent Discount Details Structure
JSON STRUCTUREMarketing Promotion Award Structure
JSON STRUCTUREMarketing Promotion Details Structure
JSON STRUCTUREMarketing Push Notification Response Structure
JSON STRUCTUREMarketing Restaurant Voucher Assigned Store Structure
JSON STRUCTUREMarketing Restaurant Voucher Eligible Store Structure
JSON STRUCTUREMarketing Retention Campaign Structure
JSON STRUCTUREMarketing Store Campaign Start Time Structure
JSON STRUCTUREMarketing Store List Item Structure
JSON STRUCTUREMarketing Update Voucher Structure
JSON STRUCTUREMarketing Update Voucher Usage Structure
JSON STRUCTUREMarketing Validity Period Structure
JSON STRUCTUREMarketing Voucher Data Point Structure
JSON STRUCTUREMarketing Voucher Structure
JSON STRUCTUREMarketing Voucher Summary Structure
JSON STRUCTUREMarketing Voucher With Stats Structure
JSON STRUCTUREMenus Allergen Structure
JSON STRUCTUREMenus Business Hours Period Base Structure
JSON STRUCTUREMenus Business Hours Period Structure
JSON STRUCTUREMenus Create Full Menu Item Option Set Item Structure
JSON STRUCTUREMenus Create Full Menu Item Option Set Structure
JSON STRUCTUREMenus Create Full Menu Section Item Structure
JSON STRUCTUREMenus Create Full Menu Section Structure
JSON STRUCTUREMenus Create Full Menu Structure
JSON STRUCTUREMenus Create Metadata Structure
JSON STRUCTUREMenus Http Posted File Base Structure
JSON STRUCTUREMenus Menu Base Structure
JSON STRUCTUREMenus Menu Checkpoint Structure
JSON STRUCTUREMenus Menu Element Edit Response Structure
JSON STRUCTUREMenus Menu Element List Response Structure
JSON STRUCTUREMenus Menu Item Option Set Base Structure
JSON STRUCTUREMenus Menu Item Option Set Item Base Structure
JSON STRUCTUREMenus Menu Item Option Set Item Structure
JSON STRUCTUREMenus Menu Item Option Set Structure
JSON STRUCTUREMenus Menu Nutrition Info Header Structure
JSON STRUCTUREMenus Menu Section Base Structure
JSON STRUCTUREMenus Menu Section Item Base Structure
JSON STRUCTUREMenus Menu Section Item Structure
JSON STRUCTUREMenus Menu Section Structure
JSON STRUCTUREMenus Menu Structure
JSON STRUCTUREMenus Menu Summary Structure
JSON STRUCTUREMenus Menu Tax Details Structure
JSON STRUCTUREMenus Menu Tax Rate Structure
JSON STRUCTUREMenus Menu Zone Structure
JSON STRUCTUREMenus Metadata Structure
JSON STRUCTUREMenus Stream Structure
JSON STRUCTUREOrders Channel Structure
JSON STRUCTUREOrders Coordinates Structure
JSON STRUCTUREOrders Create Fulfillment States Configuration Structure
JSON STRUCTUREOrders Customer Summary Structure
JSON STRUCTUREOrders Delivery Location Structure
JSON STRUCTUREOrders Fee Summary Structure
JSON STRUCTUREOrders Fulfillent Status Action Item Structure
JSON STRUCTUREOrders Fulfillment States Configuration Structure
JSON STRUCTUREOrders Fulfillment Status Configuration Item Structure
JSON STRUCTUREOrders Masked Phone Number Structure
JSON STRUCTUREOrders Order Batch Structure
JSON STRUCTUREOrders Order Batch Summary Structure
JSON STRUCTUREOrders Order Delivery Information Base Structure
JSON STRUCTUREOrders Order Delivery Information Structure
JSON STRUCTUREOrders Order Drop Off Location Structure
JSON STRUCTUREOrders Order Fulfillment Status Base Structure
JSON STRUCTUREOrders Order Fulfillment Status Structure
JSON STRUCTUREOrders Order Item Option Structure
JSON STRUCTUREOrders Order Item Structure
JSON STRUCTUREOrders Order Structure
JSON STRUCTUREOrders Order Summary Structure
JSON STRUCTUREOrders Order Voucher Summary Structure
JSON STRUCTUREOrders Refund Structure
JSON STRUCTUREOrders Store Summary Structure
JSON STRUCTUREOrders Tax Item Structure
JSON STRUCTUREOrders Tip Configuration Structure
JSON STRUCTUREOrders Update Fulfillment States Configuration Structure
JSON STRUCTUREOrders Update Tip Configuration Structure
JSON STRUCTUREPayments Account Field Definition Structure
JSON STRUCTUREPayments Bank Account Detail Structure
JSON STRUCTUREPayments Bank Account Details Update Request Structure
JSON STRUCTUREPayments Bank Account Summary Structure
JSON STRUCTUREPayments Flipdish Fees Details Structure
JSON STRUCTUREPayments Payout Chargeback Structure
JSON STRUCTUREPayments Payout Detail Structure
JSON STRUCTUREPayments Payout Order Structure
JSON STRUCTUREPayments Payout Other Charge Structure
JSON STRUCTUREPayments Payout Refund Structure
JSON STRUCTUREPayments Payout Report3 Details Adjustments Structure
JSON STRUCTUREPayments Payout Report3 Details Flipdish Fees Structure
JSON STRUCTUREPayments Payout Report3 Details Revenue Structure
JSON STRUCTUREPayments Payout Report3 Details Summary Structure
JSON STRUCTUREPayments Payout Report3 Overview Header Structure
JSON STRUCTUREPayments Payout Report3 Refunded Order Structure
JSON STRUCTUREPayments Payout Report3 Store Payout Structure
JSON STRUCTUREPayments Payout Store Structure
JSON STRUCTUREPayments Payout Structure
JSON STRUCTUREPayments Previous Order Item Structure
JSON STRUCTUREPayments Previous Order Structure
JSON STRUCTUREPayments Revenue Adjustments Details Structure
JSON STRUCTUREPayments Revenue Detail Structure
JSON STRUCTUREPayments Stripe Connected Account Info Structure
JSON STRUCTUREPayments Stripe Connected Account Structure
JSON STRUCTUREPayments Subscription Invoice Structure
JSON STRUCTUREPayments Subscription Structure
JSON STRUCTUREPayments Subscription Summary Structure
JSON STRUCTUREPayments Upcoming Invoice Structure
JSON STRUCTUREPlatform Analytics Client Event Structure
JSON STRUCTUREPlatform App Created Event Structure
JSON STRUCTUREPlatform App Structure
JSON STRUCTUREPlatform App Updated Event Structure
JSON STRUCTUREPlatform Bank Account Structure
JSON STRUCTUREPlatform Customer Delivery Tracking Order Structure
JSON STRUCTUREPlatform Delivery Zone Created Event Structure
JSON STRUCTUREPlatform Delivery Zone Deleted Event Structure
JSON STRUCTUREPlatform Delivery Zone Updated Event Structure
JSON STRUCTUREPlatform Emv Notification Event Structure
JSON STRUCTUREPlatform Event Search Result Structure
JSON STRUCTUREPlatform External Store Event Structure
JSON STRUCTUREPlatform Job Response Structure
JSON STRUCTUREPlatform Lightspeed Settings Structure
JSON STRUCTUREPlatform Location Created Event Structure
JSON STRUCTUREPlatform Loyalty Campaign Structure
JSON STRUCTUREPlatform Menu Bulk Edit Event Structure
JSON STRUCTUREPlatform Menu Item Option Set Item Structure
JSON STRUCTUREPlatform Menu Section Item Structure
JSON STRUCTUREPlatform Order Structure
JSON STRUCTUREPlatform Retention Campaign Structure
JSON STRUCTUREPlatform Store Fee Config Structure
JSON STRUCTUREPlatform Store Fee Config Updated Event Structure
JSON STRUCTUREPlatform Store Opening Hours Updated Event Structure
JSON STRUCTUREPlatform Store Structure
JSON STRUCTUREPlatform Voucher Structure
JSON STRUCTUREPlatform Webhook Log Structure
JSON STRUCTUREStores Address Form Response Structure
JSON STRUCTUREStores Business Hours Override Base Structure
JSON STRUCTUREStores Business Hours Override Structure
JSON STRUCTUREStores Business Hours Period Base Structure
JSON STRUCTUREStores Business Hours Period Structure
JSON STRUCTUREStores Create Location Structure
JSON STRUCTUREStores Delivery Zone Structure
JSON STRUCTUREStores Dynamic Form Field Structure
JSON STRUCTUREStores Dynamic Form Rule Structure
JSON STRUCTUREStores Dynamic Form Rules Structure
JSON STRUCTUREStores Google Address Result Structure
JSON STRUCTUREStores Google Address Structure
JSON STRUCTUREStores Location Area Location Structure
JSON STRUCTUREStores Location Area With Locations Structure
JSON STRUCTUREStores Pre Order Config Structure
JSON STRUCTUREStores Processing Fee Config Structure
JSON STRUCTUREStores Service Charge Structure
JSON STRUCTUREStores Store Address Base Structure
JSON STRUCTUREStores Store Address Structure
JSON STRUCTUREStores Store Base Structure
JSON STRUCTUREStores Store Collection Settings Structure
JSON STRUCTUREStores Store Config Structure
JSON STRUCTUREStores Store End Of Day Report Structure
JSON STRUCTUREStores Store Fee Config Structure
JSON STRUCTUREStores Store Group Extended Structure
JSON STRUCTUREStores Store Group Structure
JSON STRUCTUREStores Store Order Capacity Config Structure
JSON STRUCTUREStores Store Order Capacity Period Structure
JSON STRUCTUREStores Store Structure
JSON STRUCTUREStores Store Validation Config Structure
JSON STRUCTUREScroll for all 278
Examples 278
Example request and response payloads for these APIs.
Apps App Example
EXAMPLEApps App Store App Example
EXAMPLEApps Channel Example
EXAMPLEApps Field Example
EXAMPLEApps Field Group Example
EXAMPLEApps Firebase App Example
EXAMPLEApps Index Page Base Example
EXAMPLEApps Index Page Example
EXAMPLEApps Stream Example
EXAMPLECatalog Catalog Item Example
EXAMPLECatalog Create Group Example
EXAMPLECatalog Group Example
EXAMPLECatalog Metafield Example
EXAMPLECatalog Product Example
EXAMPLECatalog Update Group Example
EXAMPLECustomers Channel Example
EXAMPLECustomers Customer Example
EXAMPLECustomers Language Example
EXAMPLECustomers Order Example
EXAMPLECustomers Order Item Example
EXAMPLECustomers Teammate Example
EXAMPLECustomers User Info Example
EXAMPLECustomers User Note Example
EXAMPLEDevices Card Reader Example
EXAMPLEMarketing Voucher Example
EXAMPLEMenus Allergen Example
EXAMPLEMenus Menu Base Example
EXAMPLEMenus Menu Example
EXAMPLEMenus Menu Section Example
EXAMPLEMenus Menu Summary Example
EXAMPLEMenus Menu Tax Rate Example
EXAMPLEMenus Menu Zone Example
EXAMPLEMenus Metadata Example
EXAMPLEMenus Stream Example
EXAMPLEOrders Channel Example
EXAMPLEOrders Coordinates Example
EXAMPLEOrders Fee Summary Example
EXAMPLEOrders Order Batch Example
EXAMPLEOrders Order Example
EXAMPLEOrders Order Item Example
EXAMPLEOrders Order Summary Example
EXAMPLEOrders Refund Example
EXAMPLEOrders Store Summary Example
EXAMPLEOrders Tax Item Example
EXAMPLEPayments Payout Example
EXAMPLEPlatform App Example
EXAMPLEPlatform Order Example
EXAMPLEPlatform Store Example
EXAMPLEPlatform Voucher Example
EXAMPLEPlatform Webhook Log Example
EXAMPLEStores Delivery Zone Example
EXAMPLEStores Store Address Example
EXAMPLEStores Store Base Example
EXAMPLEStores Store Config Example
EXAMPLEStores Store Example
EXAMPLEStores Store Group Example
EXAMPLEScroll for all 278
Security Posture 2
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Scopes 1
OAuth scopes governing access to this provider's APIs.
Agentic Access 1
Recommended x-agentic-access execution contracts for AI agents.
Resources
Get Started 3
Portal, sign-up, and the first successful call
Documentation 3
Reference material describing how the API behaves
Agent Surfaces 2
MCP servers, agent skills, and machine-readable catalogs
Design & Contract 2
Pagination, idempotency, versioning, errors, and events
Build 12
SDKs, sample code, and the tooling you integrate with
PostmanWorkspace
PostmanWorkspace
GitHubOrganization
GitHubOrganization
SDK Organization
GitHubOrganization
.NET SDK
SDKs
.NET Core SDK
SDKs
Java SDK
SDKs
PHP SDK
SDKs
JavaScript SDK
SDKs
TypeScript SDK
SDKs
TypeScript SignalR Realtime Client
SDKs
Integration Examples
CodeExamples
Flipdish Spectral Ruleset (API Design Guide)
Tools
Scroll for all 12
Access & Security 4
Authentication, authorization, and security posture
Operate 2
Status, limits, changes, and where to get help
Commercial 3
Pricing, plans, and the legal terms of use
Company 3
The organization behind the API
Other 1
Properties that don't map to a standard resource type