Otter
Otter (TryOtter) is a Restaurant Operating System used by hundreds of thousands of restaurants worldwide to aggregate delivery and online orders, consolidate menus, analyze sales, and control third-party delivery services from one place. For developers and integration partners, Otter publishes a Public API (OpenAPI 3.0, OAuth 2.0) and developer guides spanning account pairing, orders, menus, delivery, finance, reports, reviews, storefront, loyalty, organization, and inventory — with HMAC-signed webhooks for event-driven integration. Onboarding begins by registering an application, configuring webhooks, and onboarding stores; authentication and the account-specific base URL are provisioned through an Otter account representative.
Real signal across most facets with visible, nameable gaps — the contract exists but is thin, or the portal is good while governance and commercial terms are absent.
API Evangelist profiles Otter the way a machine reads it — 978 machine-readable artifacts across 19 APIs, pulled from the provider's own public surface and indexed so a developer, an analyst, or an AI agent can evaluate it against every other provider on the network.
Every provider in the network is reduced to the same set of machine-readable artifacts — OpenAPI contracts, event specifications, GraphQL schemas, runnable collections, pricing and rate-limit signals, security posture, OAuth scopes, and the agent surfaces (MCP servers and skills) that let software drive the API on its own. We profile them because the interface is the part of a company you can actually inspect: it is a truer signal of what a provider does than any marketing page. From those artifacts we compute the Kin Score — Otter scores 58.2/100 (developing), with a separate agent-readiness read of 48/100 (agent ready). The full breakdown is below, followed by every artifact we hold — each card links through to its machine-readable definition on apis.io.
Kin Score
This is the API Evangelist rating — a single, repeatable read computed from the artifacts on this page. Green fill is points earned; the red track is points possible, so every bar shows earned-versus-possible at a glance.
Kin Score
How this is scored →scored 2026-07-27 · rubric v0.5
How we profile Otter
Each block below is one kind of artifact we hold for Otter. For each we say what it is and why it earns a place in the profile, then list every one we've indexed — capped at two rows, scroll within the panel for the rest.
APIs 19
Each API is captured as its own OpenAPI definition — every operation, parameter, and response. This is the single most useful machine-readable description of what an API does, and it's what lets us score, lint, mock, and generate against it without asking the provider for anything.
Individual APIs this provider publishes, each with its own machine-readable definition.
Otter Account Pairing Endpoints API
Endpoints to manage store onboarding and status
Otter Auth Endpoints API
Endpoints to handle token management.
Otter Callback Endpoints API
Endpoints for callback management.
Otter Delivery Endpoints API
Endpoints to manage delivery.
Otter Direct Orders Endpoints API
Endpoints to get orders directly.
Otter Finance Endpoints API
Endpoints to handle financial data.
Otter Inventory Endpoints API
Endpoints to interact with product inventory.
Otter Manager Loyalty Endpoints API
Endpoints to manage loyalty.
Otter Manager Menu Endpoints API
Endpoints for applications managing menus related data and operations.
Otter Manager Order Endpoints API
Endpoints for applications managing order related data and operations.
Otter Manager Storefront Endpoints API
Endpoints for applications managing storefront related data and operations.
Otter Market Intel Endpoints API
The Market Intel Endpoints API from Otter — 1 operation(s) for market intel endpoints.
Otter Menus Endpoints API
Endpoints to manage menus.
Otter Orders Endpoints API
Endpoints to manage orders for a store.
Otter Organization Endpoints API
Endpoints to interact with with organizations/brands/stores and with integration connections.
Otter Ping Endpoints API
Endpoints to ping and test system authentication.
Otter Reports Endpoints API
Endpoints to reports generation operations
Otter Reviews Endpoints API
Endpoints for review operations
Otter Storefront Endpoints API
Endpoints to manage storefront state
Scroll within the panel for all 19 ·
Open Collections 1
Open, tool-agnostic collections carry the same runnable value as Postman without locking you to one client — the portable, forkable form of the same exercise.
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
Public API
OPEN COLLECTIONPricing Plans 1
Pricing is part of the interface. Machine-readable plans tell you what a tier costs and includes before you commit — one of the six things the Kin Score reads for commercial clarity.
Published pricing tiers and plan structures.
Otter Plans Pricing
PLANSRate Limits 1
Rate limits are the difference between a demo that works and a production integration that doesn't fall over. Publishing them is an operational-transparency signal — and a hard requirement for any agent that plans its own throughput.
Documented rate limits and quota policies.
Otter Rate Limits
RATE LIMITSFinOps 1
Cost, billing, and metering signals let a buyer model the financial operations of an API before it's live. We profile them for the same reason we profile pricing: the money is part of the contract.
Cost, billing, and metering signals for API financial operations.
Otter Finops
FINOPSFeatures 9
The notable capabilities this provider advertises, captured as structured features so they can be searched and compared instead of read one landing page at a time.
Notable capabilities this provider offers.
Order Aggregation
Receive, confirm, update, and fulfill orders from multiple delivery and online-ordering channels through a single Public API.
Menu Management
Upsert, publish, and synchronize menus, hours, and item availability across connected storefronts and channels.
Delivery Orchestration
Request delivery quotes, create and update delivery requests, and track courier status via webhooks.
Finance & Payouts
Post financial transactions and invoices and retrieve payout and order-total data.
Reports
Generate orders, items, payouts, and ratings/reviews reports for stores over a time period.
Reviews & Loyalty
Reply to customer reviews and compute, redeem, accumulate, refund, and simulate loyalty rewards.
Storefront Control
Pause and unpause storefronts and report store availability and hours configuration.
Account Pairing & Organization
Onboard stores, manage store links, and read organization, brand, and store data via OAuth authorization-code flow.
Webhooks
Subscribe to order, menu, delivery, storefront, reports, and account-pairing events signed with HMAC-SHA256.
Scroll within the panel for all 9 ·
Semantic Vocabularies 1
JSON-LD contexts give the data shared meaning across APIs. We profile them because semantics are what let a machine reconcile 'customer' here with 'customer' somewhere else.
JSON-LD contexts and semantic vocabularies used across these APIs.
Otter Public Api Context
JSON-LDSpectral Rules 2
Governance rulesets we run against this provider's specs — the automated checks behind parts of the score. Profiling them makes the quality bar explicit and re-runnable, not a matter of opinion.
Otter API Rules
SPECTRALOtter API Rules
SPECTRALJSON Schema 319
Standalone JSON Schema definitions describe the data models behind the API. We profile them so the shapes are validatable on their own — useful long after a single request is forgotten.
Standalone JSON Schema definitions for this provider's data models.
AcceptDeliveryCallbackRequest
JSON SCHEMAAcceptDeliveryEvent
JSON SCHEMAAccountHolderType
JSON SCHEMAAccountType
JSON SCHEMAAdditionalCharge
JSON SCHEMAAddress
JSON SCHEMAAllergenClassification
JSON SCHEMAApplicationId
JSON SCHEMABootstrapMenuRequest
JSON SCHEMABrandInfo
JSON SCHEMABrand
JSON SCHEMABulkUpdateItemStatus
JSON SCHEMACancelDeliveryCallbackRequest
JSON SCHEMACancelDeliveryEvent
JSON SCHEMACardBrandType
JSON SCHEMACardFundingType
JSON SCHEMACardInfo
JSON SCHEMACardWalletType
JSON SCHEMACategory
JSON SCHEMACompositeFinanceLine
JSON SCHEMAComputeApplicableRewardsRequest
JSON SCHEMAComputeApplicableRewardsResponse
JSON SCHEMAConnection
JSON SCHEMACourier
JSON SCHEMACourierServiceDeliveryInfo
JSON SCHEMACreateConnectionRequest
JSON SCHEMACreateShipmentLineItem
JSON SCHEMACreateShipmentRequest
JSON SCHEMACreateShipmentResponse
JSON SCHEMACreateUserRequest
JSON SCHEMACreateUserResponse
JSON SCHEMACredentialsSchemaVersion
JSON SCHEMACustomBulkResolutionOptions
JSON SCHEMACustomerItemModification
JSON SCHEMACustomerPayment
JSON SCHEMACustomerPaymentV2
JSON SCHEMACustomerTip
JSON SCHEMADefaultModifierSelectionData
JSON SCHEMADefaultModifierSelection
JSON SCHEMADeliveryCost
JSON SCHEMADeliveryFee
JSON SCHEMADeliveryInfo
JSON SCHEMADeliveryMetadata
JSON SCHEMADeliveryStatus
JSON SCHEMADeliveryStatusUpdateEvent
JSON SCHEMADeliveryStatusUpdateRequest
JSON SCHEMADeliveryWindow
JSON SCHEMADietaryClassification
JSON SCHEMADiscoverStoresEventResult
JSON SCHEMADiscoveredStore
JSON SCHEMADistance
JSON SCHEMADropoffInfo
JSON SCHEMADropoffInstructions
JSON SCHEMAEaterOrderHistoryRequest
JSON SCHEMAEaterOrderHistoryResponse
JSON SCHEMAEaterOrder
JSON SCHEMAEnergyKcal
JSON SCHEMAEnrollmentField
JSON SCHEMAEntityPathOverrideRule
JSON SCHEMAErrorDetail
JSON SCHEMAErrorMessage
JSON SCHEMAEventCallbackError
JSON SCHEMAEventNotificationBase
JSON SCHEMAEventNotification
JSON SCHEMAEventResultMetadata
JSON SCHEMAExistingCredential
JSON SCHEMAExposedThirdPartyInfo
JSON SCHEMAFetchCredentialsEvent
JSON SCHEMAFinancialData
JSON SCHEMAFinancialInvoice
JSON SCHEMAFinancialTransaction
JSON SCHEMAFulfilledCredential
JSON SCHEMAFulfillmentInfo
JSON SCHEMAFulfillmentModeOverrideRule
JSON SCHEMAFulfillmentPathEntity
JSON SCHEMAGenerateReportMultiRequest
JSON SCHEMAGenerateReportResponse
JSON SCHEMAGetEnrollmentConfigResponse
JSON SCHEMAGetReportStatusResponse
JSON SCHEMAGetStoreDetailsEventResult
JSON SCHEMAGetUserResponse
JSON SCHEMAGtin
JSON SCHEMAHourInterval
JSON SCHEMAHoursData
JSON SCHEMAHours
JSON SCHEMAHydraToken
JSON SCHEMAIntentToCancelEvent
JSON SCHEMAInventorySummariesResponse
JSON SCHEMAInventorySummary
JSON SCHEMAInvoicePayoutInfo
JSON SCHEMAItem-2
JSON SCHEMAItem-3
JSON SCHEMAItem-4
JSON SCHEMAItemAddedModification
JSON SCHEMAItemModifier
JSON SCHEMAItemPriceOverride
JSON SCHEMAItem
JSON SCHEMAItemSelector
JSON SCHEMAItemStatus
JSON SCHEMAItemTax
JSON SCHEMAItemUpdateRequest
JSON SCHEMAJobId
JSON SCHEMAJobReference
JSON SCHEMAListBrandsResponse
JSON SCHEMAListShipmentsResponse
JSON SCHEMAListStoresResponse
JSON SCHEMALocation
JSON SCHEMALoyaltyInfo
JSON SCHEMAManagerCancelOrderRequest
JSON SCHEMAManagerConfirmOrderRequest
JSON SCHEMAManagerItemIssue
JSON SCHEMAManagerItemIssues
JSON SCHEMAManagerOrderCancelDetails
JSON SCHEMAManagerOrderIssue
JSON SCHEMAManagerOrderIssues
JSON SCHEMAMandateStatus
JSON SCHEMAMarketintel_Coordinates
JSON SCHEMAMarketintel_GeoLocationInformation
JSON SCHEMAMarketintel_HoursData
JSON SCHEMAMarketintel_LocationBasedInformation
JSON SCHEMAMarketintel_RegularHours
JSON SCHEMAMarketintel_SpecialHours
JSON SCHEMAMarketintel_StoreChain
JSON SCHEMAMarketintel_StoreDeliveryInformation
JSON SCHEMAMarketintel_StoreDetails
JSON SCHEMAMarketintel_StoreListing
JSON SCHEMAMarketintel_StoreMenu
JSON SCHEMAMarketintel_StorePriceLevel
JSON SCHEMAMarketintel_StorePromotion
JSON SCHEMAMarketintel_StoreRating
JSON SCHEMAMarketintel_StoreSales
JSON SCHEMAMarketintel_TimeRange
JSON SCHEMAMenu_3PD
JSON SCHEMAMenuAsyncJobType
JSON SCHEMAMenuAsyncLatestJobForStoreResponse
JSON SCHEMAMenuAsynchronousJob
JSON SCHEMAMenuData
JSON SCHEMAMenuItem_3PD
JSON SCHEMAMenuItem_POS
JSON SCHEMAMenuJobPublishState
JSON SCHEMAMenuJobType
JSON SCHEMAMenu_POS
JSON SCHEMAMenuPublishEvent
JSON SCHEMAMenuPublishJobState
JSON SCHEMAMenuPublishRequest
JSON SCHEMAMenuPublishResponseMenuPublishTargets
JSON SCHEMAMenuPublishResponse
JSON SCHEMAMenuPublishTarget
JSON SCHEMAMenuPublishTargets
JSON SCHEMAMenusReward
JSON SCHEMAMenus
JSON SCHEMAMenusUpsertRequest
JSON SCHEMAMetadataObject
JSON SCHEMAModifierGroup
JSON SCHEMAModifierGroupUpdateRequest
JSON SCHEMAModifierItem
JSON SCHEMAMoney
JSON SCHEMANullEvent
JSON SCHEMANutritionContent
JSON SCHEMANutritionalInfo
JSON SCHEMAOAuthTokenGenerationRequest
JSON SCHEMAOperationType
JSON SCHEMAOptionalStoreIdInMetadata
JSON SCHEMAOrder-2
JSON SCHEMAOrderComponentId
JSON SCHEMAOrderConfirmEvent
JSON SCHEMAOrderCustomerItemsUpdateRequest
JSON SCHEMAOrderCustomerPaymentUpdateRequest
JSON SCHEMAOrderDeliveryInfoUpdateRequest
JSON SCHEMAOrderExternalIdentifiers
JSON SCHEMAOrderFeed
JSON SCHEMAOrderFulfilledEvent
JSON SCHEMAOrderHandedOffEvent
JSON SCHEMAOrderIdentifierFinance
JSON SCHEMAOrderIdentifier
JSON SCHEMAOrderIssue
JSON SCHEMAOrderItemInformation
JSON SCHEMAOrderPrepTimeUpdateRequest
JSON SCHEMAOrderPriceAdjustedModification
JSON SCHEMAOrderReadyEvent
JSON SCHEMAOrderReference
JSON SCHEMAOrder
JSON SCHEMAOrderStatusEvent
JSON SCHEMAOrderStatusHistory
JSON SCHEMAOrderStatusUpdateRequest
JSON SCHEMAOrderTotal
JSON SCHEMAOrderTotalV2
JSON SCHEMAOrderWithManagerInfo
JSON SCHEMAOrgInfo
JSON SCHEMAOrganization
JSON SCHEMAOverrideRule_3PD
JSON SCHEMAOverrideRule
JSON SCHEMAParcelCarrierDeliveryInfo
JSON SCHEMAPauseReason
JSON SCHEMAPauseRequest
JSON SCHEMAPauseResponse
JSON SCHEMAPauseStoreEventResult
JSON SCHEMAPaymentDetailsAch
JSON SCHEMAPaymentDetailsAcss
JSON SCHEMAPaymentDetailsBacs
JSON SCHEMAPaymentDetailsBecs
JSON SCHEMAPaymentDetailsCard
JSON SCHEMAPaymentDetailsSepa
JSON SCHEMAPaymentRecord
JSON SCHEMAPayoutInfo
JSON SCHEMAPayout
JSON SCHEMAPercentageValue
JSON SCHEMAPerson
JSON SCHEMAPersonalIdentifiers
JSON SCHEMAPhoto
JSON SCHEMAPickUpInfo
JSON SCHEMAPictureProof
JSON SCHEMAPictureRequirement
JSON SCHEMAPingEvent
JSON SCHEMAPongObject
JSON SCHEMAPosInjectionStateUpdateEvent
JSON SCHEMAPosMenuSyncRequest
JSON SCHEMAPosMenuSyncResponse
JSON SCHEMAPOSOrderStatusUpdateRequest
JSON SCHEMAPreparationTime
JSON SCHEMAPriceOverride
JSON SCHEMAProcessStoreServiceProviderStatus
JSON SCHEMAProcessingStatusResponse
JSON SCHEMAPromotionDetails
JSON SCHEMAQuantityUpdatedModification
JSON SCHEMARecordPaymentType
JSON SCHEMARecordProviderType
JSON SCHEMARedeemAndAccumulateRewardsRequest
JSON SCHEMARedeemAndAccumulateRewardsResponse
JSON SCHEMARefundRewardsRequest
JSON SCHEMARefundRewardsResponse
JSON SCHEMARegularHours
JSON SCHEMARemoveStorelinkEvent
JSON SCHEMAReportGeneratedEvent
JSON SCHEMARequestAction
JSON SCHEMARequestDeliveryQuoteCallbackRequest
JSON SCHEMARequestDeliveryQuoteEvent
JSON SCHEMARequestStateInfo
JSON SCHEMARequestState
JSON SCHEMARequiredAddress
JSON SCHEMARequiredDeliveryInfo
JSON SCHEMARequiredEventResultMetadata
JSON SCHEMARequiredPerson
JSON SCHEMAReviewReplyRequest
JSON SCHEMAReviewReplyResponse
JSON SCHEMARewardEffect
JSON SCHEMAReward
JSON SCHEMASearchUsersResponse
JSON SCHEMASelectedMenuReward
JSON SCHEMASelectedReward
JSON SCHEMASelfDropDeliveryInfo
JSON SCHEMASendMenuEventCallback
JSON SCHEMAServiceOverrideRule
JSON SCHEMAServings
JSON SCHEMAShipmentDeliveryInfo
JSON SCHEMAShipmentLineItem
JSON SCHEMAShipment
JSON SCHEMAShipmentStateChange
JSON SCHEMAShipmentState
JSON SCHEMASignatureProof
JSON SCHEMASignatureRequirement
JSON SCHEMASimpleFinanceLine
JSON SCHEMASimpleFinancialTransaction
JSON SCHEMASimpleOrderIdentifierFinance
JSON SCHEMASimulateRewardsRequest
JSON SCHEMASimulateRewardsResponse
JSON SCHEMASkuBarcode
JSON SCHEMASkuDetails
JSON SCHEMASourceExternalIdentifiers
JSON SCHEMASpecialHours
JSON SCHEMAStatus
JSON SCHEMAStorageRequirement
JSON SCHEMAStore-2
JSON SCHEMAStore-3
JSON SCHEMAStoreAvailabilityEventResult
JSON SCHEMAStoreHoursConfigurationEventResult
JSON SCHEMAStoreHoursConfiguration
JSON SCHEMAStoreHours
JSON SCHEMAStoreId
JSON SCHEMAStoreInfo-2
JSON SCHEMAStoreInfo
JSON SCHEMAStore
JSON SCHEMAStorefrontError
JSON SCHEMAStorefront_RegularHours
JSON SCHEMAStorefront_SpecialHours
JSON SCHEMAStorefront_TimeRange
JSON SCHEMASubtotalReward
JSON SCHEMASubtotal
JSON SCHEMASuspendItemsRequest
JSON SCHEMASuspensionStatus
JSON SCHEMATimeRange
JSON SCHEMATotals
JSON SCHEMATriggerMenu
JSON SCHEMATrigger
JSON SCHEMAUnitPriceAndCount
JSON SCHEMAUnpauseRequest
JSON SCHEMAUnpauseResponse
JSON SCHEMAUnpauseStoreEventResult
JSON SCHEMAUnpauseStoreEvent
JSON SCHEMAUnsuspendItemsRequest
JSON SCHEMAUpdateDeliveryRequestCallbackRequest
JSON SCHEMAUpdateDeliveryRequestEvent
JSON SCHEMAUpdateItemStatusEntry
JSON SCHEMAUpdateStorelinkStatusRequest
JSON SCHEMAUploadPastOrdersRequest
JSON SCHEMAUploadPastOrdersResponse
JSON SCHEMAUpsertFullMenuEventCallback
JSON SCHEMAUpsertHoursEvent
JSON SCHEMAUpsertStorelinkEventResultRequest
JSON SCHEMAUpsertStorelinkEvent
JSON SCHEMAUserAccount
JSON SCHEMAUserBalance
JSON SCHEMAUserField
JSON SCHEMAUser
JSON SCHEMAVehicleInformation
JSON SCHEMAVerificationProof
JSON SCHEMAVerificationRequirements
JSON SCHEMAViewCredential
JSON SCHEMAViewCredentialsArray
JSON SCHEMAScroll within the panel for all 319 ·
JSON Structure 319
JSON Structure captures the data shapes in a form built for tooling — a complement to JSON Schema that keeps the model machine-legible.
JSON Structure definitions describing this provider's data shapes.
Public Api Accept Delivery Callback Request Structure
JSON STRUCTUREPublic Api Accept Delivery Event Structure
JSON STRUCTUREPublic Api Account Holder Type Structure
JSON STRUCTUREPublic Api Account Type Structure
JSON STRUCTUREPublic Api Additional Charge Structure
JSON STRUCTUREPublic Api Address Structure
JSON STRUCTUREPublic Api Allergen Classification Structure
JSON STRUCTUREPublic Api Application Id Structure
JSON STRUCTUREPublic Api Bootstrap Menu Request Structure
JSON STRUCTUREPublic Api Brand Info Structure
JSON STRUCTUREPublic Api Brand Structure
JSON STRUCTUREPublic Api Bulk Update Item Status Structure
JSON STRUCTUREPublic Api Cancel Delivery Callback Request Structure
JSON STRUCTUREPublic Api Cancel Delivery Event Structure
JSON STRUCTUREPublic Api Card Brand Type Structure
JSON STRUCTUREPublic Api Card Funding Type Structure
JSON STRUCTUREPublic Api Card Info Structure
JSON STRUCTUREPublic Api Card Wallet Type Structure
JSON STRUCTUREPublic Api Category Structure
JSON STRUCTUREPublic Api Composite Finance Line Structure
JSON STRUCTUREPublic Api Compute Applicable Rewards Request Structure
JSON STRUCTUREPublic Api Compute Applicable Rewards Response Structure
JSON STRUCTUREPublic Api Connection Structure
JSON STRUCTUREPublic Api Courier Service Delivery Info Structure
JSON STRUCTUREPublic Api Courier Structure
JSON STRUCTUREPublic Api Create Connection Request Structure
JSON STRUCTUREPublic Api Create Shipment Line Item Structure
JSON STRUCTUREPublic Api Create Shipment Request Structure
JSON STRUCTUREPublic Api Create Shipment Response Structure
JSON STRUCTUREPublic Api Create User Request Structure
JSON STRUCTUREPublic Api Create User Response Structure
JSON STRUCTUREPublic Api Credentials Schema Version Structure
JSON STRUCTUREPublic Api Custom Bulk Resolution Options Structure
JSON STRUCTUREPublic Api Customer Item Modification Structure
JSON STRUCTUREPublic Api Customer Payment Structure
JSON STRUCTUREPublic Api Customer Payment V2 Structure
JSON STRUCTUREPublic Api Customer Tip Structure
JSON STRUCTUREPublic Api Default Modifier Selection Data Structure
JSON STRUCTUREPublic Api Default Modifier Selection Structure
JSON STRUCTUREPublic Api Delivery Cost Structure
JSON STRUCTUREPublic Api Delivery Fee Structure
JSON STRUCTUREPublic Api Delivery Info Structure
JSON STRUCTUREPublic Api Delivery Metadata Structure
JSON STRUCTUREPublic Api Delivery Status Structure
JSON STRUCTUREPublic Api Delivery Status Update Event Structure
JSON STRUCTUREPublic Api Delivery Status Update Request Structure
JSON STRUCTUREPublic Api Delivery Window Structure
JSON STRUCTUREPublic Api Dietary Classification Structure
JSON STRUCTUREPublic Api Discover Stores Event Result Structure
JSON STRUCTUREPublic Api Discovered Store Structure
JSON STRUCTUREPublic Api Distance Structure
JSON STRUCTUREPublic Api Dropoff Info Structure
JSON STRUCTUREPublic Api Dropoff Instructions Structure
JSON STRUCTUREPublic Api Eater Order History Request Structure
JSON STRUCTUREPublic Api Eater Order History Response Structure
JSON STRUCTUREPublic Api Eater Order Structure
JSON STRUCTUREPublic Api Energy Kcal Structure
JSON STRUCTUREPublic Api Enrollment Field Structure
JSON STRUCTUREPublic Api Entity Path Override Rule Structure
JSON STRUCTUREPublic Api Error Detail Structure
JSON STRUCTUREPublic Api Error Message Structure
JSON STRUCTUREPublic Api Event Callback Error Structure
JSON STRUCTUREPublic Api Event Notification Base Structure
JSON STRUCTUREPublic Api Event Notification Structure
JSON STRUCTUREPublic Api Event Result Metadata Structure
JSON STRUCTUREPublic Api Existing Credential Structure
JSON STRUCTUREPublic Api Exposed Third Party Info Structure
JSON STRUCTUREPublic Api Fetch Credentials Event Structure
JSON STRUCTUREPublic Api Financial Data Structure
JSON STRUCTUREPublic Api Financial Invoice Structure
JSON STRUCTUREPublic Api Financial Transaction Structure
JSON STRUCTUREPublic Api Fulfilled Credential Structure
JSON STRUCTUREPublic Api Fulfillment Info Structure
JSON STRUCTUREPublic Api Fulfillment Mode Override Rule Structure
JSON STRUCTUREPublic Api Fulfillment Path Entity Structure
JSON STRUCTUREPublic Api Generate Report Multi Request Structure
JSON STRUCTUREPublic Api Generate Report Response Structure
JSON STRUCTUREPublic Api Get Enrollment Config Response Structure
JSON STRUCTUREPublic Api Get Report Status Response Structure
JSON STRUCTUREPublic Api Get Store Details Event Result Structure
JSON STRUCTUREPublic Api Get User Response Structure
JSON STRUCTUREPublic Api Gtin Structure
JSON STRUCTUREPublic Api Hour Interval Structure
JSON STRUCTUREPublic Api Hours Data Structure
JSON STRUCTUREPublic Api Hours Structure
JSON STRUCTUREPublic Api Hydra Token Structure
JSON STRUCTUREPublic Api Intent To Cancel Event Structure
JSON STRUCTUREPublic Api Inventory Summaries Response Structure
JSON STRUCTUREPublic Api Inventory Summary Structure
JSON STRUCTUREPublic Api Invoice Payout Info Structure
JSON STRUCTUREPublic Api Item 2 Structure
JSON STRUCTUREPublic Api Item 3 Structure
JSON STRUCTUREPublic Api Item 4 Structure
JSON STRUCTUREPublic Api Item Added Modification Structure
JSON STRUCTUREPublic Api Item Modifier Structure
JSON STRUCTUREPublic Api Item Price Override Structure
JSON STRUCTUREPublic Api Item Selector Structure
JSON STRUCTUREPublic Api Item Status Structure
JSON STRUCTUREPublic Api Item Structure
JSON STRUCTUREPublic Api Item Tax Structure
JSON STRUCTUREPublic Api Item Update Request Structure
JSON STRUCTUREPublic Api Job Id Structure
JSON STRUCTUREPublic Api Job Reference Structure
JSON STRUCTUREPublic Api List Brands Response Structure
JSON STRUCTUREPublic Api List Shipments Response Structure
JSON STRUCTUREPublic Api List Stores Response Structure
JSON STRUCTUREPublic Api Location Structure
JSON STRUCTUREPublic Api Loyalty Info Structure
JSON STRUCTUREPublic Api Manager Cancel Order Request Structure
JSON STRUCTUREPublic Api Manager Confirm Order Request Structure
JSON STRUCTUREPublic Api Manager Item Issue Structure
JSON STRUCTUREPublic Api Manager Item Issues Structure
JSON STRUCTUREPublic Api Manager Order Cancel Details Structure
JSON STRUCTUREPublic Api Manager Order Issue Structure
JSON STRUCTUREPublic Api Manager Order Issues Structure
JSON STRUCTUREPublic Api Mandate Status Structure
JSON STRUCTUREPublic Api Marketintel Coordinates Structure
JSON STRUCTUREPublic Api Marketintel Hours Data Structure
JSON STRUCTUREPublic Api Marketintel Regular Hours Structure
JSON STRUCTUREPublic Api Marketintel Special Hours Structure
JSON STRUCTUREPublic Api Marketintel Store Chain Structure
JSON STRUCTUREPublic Api Marketintel Store Details Structure
JSON STRUCTUREPublic Api Marketintel Store Listing Structure
JSON STRUCTUREPublic Api Marketintel Store Menu Structure
JSON STRUCTUREPublic Api Marketintel Store Price Level Structure
JSON STRUCTUREPublic Api Marketintel Store Promotion Structure
JSON STRUCTUREPublic Api Marketintel Store Rating Structure
JSON STRUCTUREPublic Api Marketintel Store Sales Structure
JSON STRUCTUREPublic Api Marketintel Time Range Structure
JSON STRUCTUREPublic Api Menu 3 Pd Structure
JSON STRUCTUREPublic Api Menu Async Job Type Structure
JSON STRUCTUREPublic Api Menu Asynchronous Job Structure
JSON STRUCTUREPublic Api Menu Data Structure
JSON STRUCTUREPublic Api Menu Item 3 Pd Structure
JSON STRUCTUREPublic Api Menu Item Pos Structure
JSON STRUCTUREPublic Api Menu Job Publish State Structure
JSON STRUCTUREPublic Api Menu Job Type Structure
JSON STRUCTUREPublic Api Menu Pos Structure
JSON STRUCTUREPublic Api Menu Publish Event Structure
JSON STRUCTUREPublic Api Menu Publish Job State Structure
JSON STRUCTUREPublic Api Menu Publish Request Structure
JSON STRUCTUREPublic Api Menu Publish Response Structure
JSON STRUCTUREPublic Api Menu Publish Target Structure
JSON STRUCTUREPublic Api Menu Publish Targets Structure
JSON STRUCTUREPublic Api Menus Reward Structure
JSON STRUCTUREPublic Api Menus Structure
JSON STRUCTUREPublic Api Menus Upsert Request Structure
JSON STRUCTUREPublic Api Metadata Object Structure
JSON STRUCTUREPublic Api Modifier Group Structure
JSON STRUCTUREPublic Api Modifier Group Update Request Structure
JSON STRUCTUREPublic Api Modifier Item Structure
JSON STRUCTUREPublic Api Money Structure
JSON STRUCTUREPublic Api Null Event Structure
JSON STRUCTUREPublic Api Nutrition Content Structure
JSON STRUCTUREPublic Api Nutritional Info Structure
JSON STRUCTUREPublic Api Oauth Token Generation Request Structure
JSON STRUCTUREPublic Api Operation Type Structure
JSON STRUCTUREPublic Api Optional Store Id In Metadata Structure
JSON STRUCTUREPublic Api Order 2 Structure
JSON STRUCTUREPublic Api Order Component Id Structure
JSON STRUCTUREPublic Api Order Confirm Event Structure
JSON STRUCTUREPublic Api Order Customer Items Update Request Structure
JSON STRUCTUREPublic Api Order Delivery Info Update Request Structure
JSON STRUCTUREPublic Api Order External Identifiers Structure
JSON STRUCTUREPublic Api Order Feed Structure
JSON STRUCTUREPublic Api Order Fulfilled Event Structure
JSON STRUCTUREPublic Api Order Handed Off Event Structure
JSON STRUCTUREPublic Api Order Identifier Finance Structure
JSON STRUCTUREPublic Api Order Identifier Structure
JSON STRUCTUREPublic Api Order Issue Structure
JSON STRUCTUREPublic Api Order Item Information Structure
JSON STRUCTUREPublic Api Order Prep Time Update Request Structure
JSON STRUCTUREPublic Api Order Price Adjusted Modification Structure
JSON STRUCTUREPublic Api Order Ready Event Structure
JSON STRUCTUREPublic Api Order Reference Structure
JSON STRUCTUREPublic Api Order Status Event Structure
JSON STRUCTUREPublic Api Order Status History Structure
JSON STRUCTUREPublic Api Order Status Update Request Structure
JSON STRUCTUREPublic Api Order Structure
JSON STRUCTUREPublic Api Order Total Structure
JSON STRUCTUREPublic Api Order Total V2 Structure
JSON STRUCTUREPublic Api Order With Manager Info Structure
JSON STRUCTUREPublic Api Org Info Structure
JSON STRUCTUREPublic Api Organization Structure
JSON STRUCTUREPublic Api Override Rule 3 Pd Structure
JSON STRUCTUREPublic Api Override Rule Structure
JSON STRUCTUREPublic Api Parcel Carrier Delivery Info Structure
JSON STRUCTUREPublic Api Pause Reason Structure
JSON STRUCTUREPublic Api Pause Request Structure
JSON STRUCTUREPublic Api Pause Response Structure
JSON STRUCTUREPublic Api Pause Store Event Result Structure
JSON STRUCTUREPublic Api Payment Details Ach Structure
JSON STRUCTUREPublic Api Payment Details Acss Structure
JSON STRUCTUREPublic Api Payment Details Bacs Structure
JSON STRUCTUREPublic Api Payment Details Becs Structure
JSON STRUCTUREPublic Api Payment Details Card Structure
JSON STRUCTUREPublic Api Payment Details Sepa Structure
JSON STRUCTUREPublic Api Payment Record Structure
JSON STRUCTUREPublic Api Payout Info Structure
JSON STRUCTUREPublic Api Payout Structure
JSON STRUCTUREPublic Api Percentage Value Structure
JSON STRUCTUREPublic Api Person Structure
JSON STRUCTUREPublic Api Personal Identifiers Structure
JSON STRUCTUREPublic Api Photo Structure
JSON STRUCTUREPublic Api Pick Up Info Structure
JSON STRUCTUREPublic Api Picture Proof Structure
JSON STRUCTUREPublic Api Picture Requirement Structure
JSON STRUCTUREPublic Api Ping Event Structure
JSON STRUCTUREPublic Api Pong Object Structure
JSON STRUCTUREPublic Api Pos Injection State Update Event Structure
JSON STRUCTUREPublic Api Pos Menu Sync Request Structure
JSON STRUCTUREPublic Api Pos Menu Sync Response Structure
JSON STRUCTUREPublic Api Posorder Status Update Request Structure
JSON STRUCTUREPublic Api Preparation Time Structure
JSON STRUCTUREPublic Api Price Override Structure
JSON STRUCTUREPublic Api Processing Status Response Structure
JSON STRUCTUREPublic Api Promotion Details Structure
JSON STRUCTUREPublic Api Quantity Updated Modification Structure
JSON STRUCTUREPublic Api Record Payment Type Structure
JSON STRUCTUREPublic Api Record Provider Type Structure
JSON STRUCTUREPublic Api Refund Rewards Request Structure
JSON STRUCTUREPublic Api Refund Rewards Response Structure
JSON STRUCTUREPublic Api Regular Hours Structure
JSON STRUCTUREPublic Api Remove Storelink Event Structure
JSON STRUCTUREPublic Api Report Generated Event Structure
JSON STRUCTUREPublic Api Request Action Structure
JSON STRUCTUREPublic Api Request Delivery Quote Event Structure
JSON STRUCTUREPublic Api Request State Info Structure
JSON STRUCTUREPublic Api Request State Structure
JSON STRUCTUREPublic Api Required Address Structure
JSON STRUCTUREPublic Api Required Delivery Info Structure
JSON STRUCTUREPublic Api Required Event Result Metadata Structure
JSON STRUCTUREPublic Api Required Person Structure
JSON STRUCTUREPublic Api Review Reply Request Structure
JSON STRUCTUREPublic Api Review Reply Response Structure
JSON STRUCTUREPublic Api Reward Effect Structure
JSON STRUCTUREPublic Api Reward Structure
JSON STRUCTUREPublic Api Search Users Response Structure
JSON STRUCTUREPublic Api Selected Menu Reward Structure
JSON STRUCTUREPublic Api Selected Reward Structure
JSON STRUCTUREPublic Api Self Drop Delivery Info Structure
JSON STRUCTUREPublic Api Send Menu Event Callback Structure
JSON STRUCTUREPublic Api Service Override Rule Structure
JSON STRUCTUREPublic Api Servings Structure
JSON STRUCTUREPublic Api Shipment Delivery Info Structure
JSON STRUCTUREPublic Api Shipment Line Item Structure
JSON STRUCTUREPublic Api Shipment State Change Structure
JSON STRUCTUREPublic Api Shipment State Structure
JSON STRUCTUREPublic Api Shipment Structure
JSON STRUCTUREPublic Api Signature Proof Structure
JSON STRUCTUREPublic Api Signature Requirement Structure
JSON STRUCTUREPublic Api Simple Finance Line Structure
JSON STRUCTUREPublic Api Simple Financial Transaction Structure
JSON STRUCTUREPublic Api Simple Order Identifier Finance Structure
JSON STRUCTUREPublic Api Simulate Rewards Request Structure
JSON STRUCTUREPublic Api Simulate Rewards Response Structure
JSON STRUCTUREPublic Api Sku Barcode Structure
JSON STRUCTUREPublic Api Sku Details Structure
JSON STRUCTUREPublic Api Source External Identifiers Structure
JSON STRUCTUREPublic Api Special Hours Structure
JSON STRUCTUREPublic Api Status Structure
JSON STRUCTUREPublic Api Storage Requirement Structure
JSON STRUCTUREPublic Api Store 2 Structure
JSON STRUCTUREPublic Api Store 3 Structure
JSON STRUCTUREPublic Api Store Availability Event Result Structure
JSON STRUCTUREPublic Api Store Hours Configuration Structure
JSON STRUCTUREPublic Api Store Hours Structure
JSON STRUCTUREPublic Api Store Id Structure
JSON STRUCTUREPublic Api Store Info 2 Structure
JSON STRUCTUREPublic Api Store Info Structure
JSON STRUCTUREPublic Api Store Structure
JSON STRUCTUREPublic Api Storefront Error Structure
JSON STRUCTUREPublic Api Storefront Regular Hours Structure
JSON STRUCTUREPublic Api Storefront Special Hours Structure
JSON STRUCTUREPublic Api Storefront Time Range Structure
JSON STRUCTUREPublic Api Subtotal Reward Structure
JSON STRUCTUREPublic Api Subtotal Structure
JSON STRUCTUREPublic Api Suspend Items Request Structure
JSON STRUCTUREPublic Api Suspension Status Structure
JSON STRUCTUREPublic Api Time Range Structure
JSON STRUCTUREPublic Api Totals Structure
JSON STRUCTUREPublic Api Trigger Menu Structure
JSON STRUCTUREPublic Api Trigger Structure
JSON STRUCTUREPublic Api Unit Price And Count Structure
JSON STRUCTUREPublic Api Unpause Request Structure
JSON STRUCTUREPublic Api Unpause Response Structure
JSON STRUCTUREPublic Api Unpause Store Event Result Structure
JSON STRUCTUREPublic Api Unpause Store Event Structure
JSON STRUCTUREPublic Api Unsuspend Items Request Structure
JSON STRUCTUREPublic Api Update Delivery Request Event Structure
JSON STRUCTUREPublic Api Update Item Status Entry Structure
JSON STRUCTUREPublic Api Update Storelink Status Request Structure
JSON STRUCTUREPublic Api Upload Past Orders Request Structure
JSON STRUCTUREPublic Api Upload Past Orders Response Structure
JSON STRUCTUREPublic Api Upsert Full Menu Event Callback Structure
JSON STRUCTUREPublic Api Upsert Hours Event Structure
JSON STRUCTUREPublic Api Upsert Storelink Event Structure
JSON STRUCTUREPublic Api User Account Structure
JSON STRUCTUREPublic Api User Balance Structure
JSON STRUCTUREPublic Api User Field Structure
JSON STRUCTUREPublic Api User Structure
JSON STRUCTUREPublic Api Vehicle Information Structure
JSON STRUCTUREPublic Api Verification Proof Structure
JSON STRUCTUREPublic Api Verification Requirements Structure
JSON STRUCTUREPublic Api View Credential Structure
JSON STRUCTUREPublic Api View Credentials Array Structure
JSON STRUCTUREScroll within the panel for all 319 ·
Examples 293
Real request and response payloads are what turn a spec from abstract into obvious — and they're one of the twelve things an agent needs to call an API correctly on the first try.
Example request and response payloads for these APIs.
Public Api Address Example
EXAMPLEPublic Api Brand Example
EXAMPLEPublic Api Card Info Example
EXAMPLEPublic Api Category Example
EXAMPLEPublic Api Courier Example
EXAMPLEPublic Api Distance Example
EXAMPLEPublic Api Hours Example
EXAMPLEPublic Api Item 2 Example
EXAMPLEPublic Api Item 3 Example
EXAMPLEPublic Api Item 4 Example
EXAMPLEPublic Api Item Example
EXAMPLEPublic Api Item Tax Example
EXAMPLEPublic Api Location Example
EXAMPLEPublic Api Menu 3 Pd Example
EXAMPLEPublic Api Menu Data Example
EXAMPLEPublic Api Menu Pos Example
EXAMPLEPublic Api Menus Example
EXAMPLEPublic Api Order 2 Example
EXAMPLEPublic Api Order Example
EXAMPLEPublic Api Org Info Example
EXAMPLEPublic Api Payout Example
EXAMPLEPublic Api Person Example
EXAMPLEPublic Api Photo Example
EXAMPLEPublic Api Reward Example
EXAMPLEPublic Api Servings Example
EXAMPLEPublic Api Shipment Example
EXAMPLEPublic Api Store 2 Example
EXAMPLEPublic Api Store 3 Example
EXAMPLEPublic Api Store Example
EXAMPLEPublic Api Subtotal Example
EXAMPLEPublic Api Totals Example
EXAMPLEPublic Api Trigger Example
EXAMPLEPublic Api User Example
EXAMPLEScroll within the panel for all 293 ·
Security Posture 2
Authentication, domain security, vulnerability disclosure, and trust-center signals — the evidence that a provider takes security seriously enough to document it. We profile it because you can't govern what you can't see.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Scopes 1
OAuth scopes are the vocabulary of least-privilege access. Profiling them shows exactly what an integration — or an agent acting on a user's behalf — is allowed to do.
OAuth scopes governing access to this provider's APIs.
Agentic Access 1
An x-agentic-access contract marks which operations are safe for an agent to run on its own and which need a human in the loop. It is the difference between an API an agent can use and one it can use safely.
Recommended x-agentic-access execution contracts for AI agents.
Use Cases 5
What developers actually build with this provider — captured so the catalogue answers 'what is this for', not just 'what does this expose'.
What developers build with this provider.
POS Integration
Sync orders and menus between a third-party point-of-sale system and Otter-connected channels.
Delivery Provider Integration
Provide delivery services by responding to quote and delivery-request webhooks and posting status updates.
Menu Aggregator
Centrally manage and publish menus and availability across many stores and storefronts.
Financial Reconciliation
Pull payout, order-total, and transaction data to reconcile restaurant finances.
Loyalty Program
Power a loyalty program by computing and redeeming rewards against Otter orders.
Integrations 3
Pre-built integrations with other platforms tell you where this provider already fits in a stack.
Pre-built integrations with other platforms and tools.
Delivery Service Providers
Third-party delivery marketplaces and on-demand courier networks.
Point of Sale Platforms
Restaurant POS systems exchanging orders and menus with Otter.
Online Ordering Channels
Branded and third-party online ordering storefronts aggregated by Otter.
Resources
Every other property we hold for Otter — documentation, portals, status pages, policies, and corporate surface — grouped by the job it does, following the integrator's arc from getting started to running in production.
Documentation 1
Reference material describing how the API behaves
Agent Surfaces 1
MCP servers, agent skills, and machine-readable catalogs
Design & Contract 3
Pagination, idempotency, versioning, errors, and events
Build 1
SDKs, sample code, and the tooling you integrate with
Access & Security 3
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
← All providers · Data indexed from github.com/api-evangelist/otter · machine-readable index on apis.io