aid: otter name: Otter description: >- 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. type: Index image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg tags: - Restaurant - Order Management - Delivery - Online Ordering - Menu Management - Analytics url: https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/apis.yml created: '2026-06-02' modified: '2026-06-03' specificationVersion: '0.19' apis: - aid: otter:public-api name: Otter Public API description: >- The Otter Public API enables integrations across the digital food ecosystem, covering account pairing, orders, menus, delivery, finance, reports, reviews, storefront, loyalty, and store management. Integrations combine API endpoints with webhooks and configuration; onboarding starts by registering an application, configuring webhooks, and onboarding stores. Auth and base URL details are provided via an account representative and the OpenAPI reference. humanURL: https://developer-guides.tryotter.com/docs/ tags: - Orders - Menu - Delivery - Webhooks - Reports properties: - type: Documentation url: https://developer-guides.tryotter.com/docs/ - type: GettingStarted url: https://developer-guides.tryotter.com/docs/ - type: OpenAPI url: openapi/otter-public-api-openapi.yml - type: APIReference url: https://developer-guides.tryotter.com/api-reference/ - type: Authentication url: https://developer-guides.tryotter.com/api-reference/#operation/requestToken - type: Webhooks url: https://developer-guides.tryotter.com/docs/guides-webhook-authentication/ - type: RateLimits url: rate-limits/otter-rate-limits.yml - type: NaftikoCapability url: capabilities/public-api-account-pairing-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-account-pairing-webhooks.yaml - type: NaftikoCapability url: capabilities/public-api-auth-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-callback-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-delivery-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-delivery-webhooks.yaml - type: NaftikoCapability url: capabilities/public-api-direct-orders-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-finance-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-inventory-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-manager-loyalty-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-manager-menu-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-manager-order-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-manager-orders-webhooks.yaml - type: NaftikoCapability url: capabilities/public-api-manager-storefront-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-market-intel-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-menus-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-menus-webhooks.yaml - type: NaftikoCapability url: capabilities/public-api-orders-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-orders-webhooks.yaml - type: NaftikoCapability url: capabilities/public-api-organization-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-ping-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-ping-webhooks.yaml - type: NaftikoCapability url: capabilities/public-api-reports-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-reports-webhooks.yaml - type: NaftikoCapability url: capabilities/public-api-reviews-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-storefront-endpoints.yaml - type: NaftikoCapability url: capabilities/public-api-storefront-webhooks.yaml - type: JSONSchema url: json-schema/ - type: JSONStructure url: json-structure/ - type: Example url: examples/ baseURL: https://{public-api-url} common: - type: Website url: https://www.tryotter.com - type: Documentation url: https://developer-guides.tryotter.com/docs/ - type: Support url: https://helpdesk.tryotter.com/hc/en-us/articles/22694653065107-API-Documentation - type: Blog url: https://www.tryotter.com/blog - type: LinkedIn url: https://www.linkedin.com/company/try-otter - type: X url: https://twitter.com/try_otter - type: SpectralRules url: rules/otter-public-api-rules.yml - type: JSONLD url: json-ld/otter-public-api-context.jsonld - type: Vocabulary url: vocabulary/otter-vocabulary.yml - type: Plans url: plans/otter-plans-pricing.yml - type: RateLimits url: rate-limits/otter-rate-limits.yml - type: FinOps url: finops/otter-finops.yml - type: Pricing url: https://www.tryotter.com/pricing - type: GitHubRepository url: https://github.com/api-evangelist/otter - type: Features data: - name: Order Aggregation description: Receive, confirm, update, and fulfill orders from multiple delivery and online-ordering channels through a single Public API. - name: Menu Management description: Upsert, publish, and synchronize menus, hours, and item availability across connected storefronts and channels. - name: Delivery Orchestration description: Request delivery quotes, create and update delivery requests, and track courier status via webhooks. - name: Finance & Payouts description: Post financial transactions and invoices and retrieve payout and order-total data. - name: Reports description: Generate orders, items, payouts, and ratings/reviews reports for stores over a time period. - name: Reviews & Loyalty description: Reply to customer reviews and compute, redeem, accumulate, refund, and simulate loyalty rewards. - name: Storefront Control description: Pause and unpause storefronts and report store availability and hours configuration. - name: Account Pairing & Organization description: Onboard stores, manage store links, and read organization, brand, and store data via OAuth authorization-code flow. - name: Webhooks description: Subscribe to order, menu, delivery, storefront, reports, and account-pairing events signed with HMAC-SHA256. - type: UseCases data: - name: POS Integration description: Sync orders and menus between a third-party point-of-sale system and Otter-connected channels. - name: Delivery Provider Integration description: Provide delivery services by responding to quote and delivery-request webhooks and posting status updates. - name: Menu Aggregator description: Centrally manage and publish menus and availability across many stores and storefronts. - name: Financial Reconciliation description: Pull payout, order-total, and transaction data to reconcile restaurant finances. - name: Loyalty Program description: Power a loyalty program by computing and redeeming rewards against Otter orders. - type: Integrations data: - name: Delivery Service Providers description: Third-party delivery marketplaces and on-demand courier networks. - name: Point of Sale Platforms description: Restaurant POS systems exchanging orders and menus with Otter. - name: Online Ordering Channels description: Branded and third-party online ordering storefronts aggregated by Otter. maintainers: - FN: Kin Lane email: kin@apievangelist.com