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.

Otter publishes 19 APIs on the APIs.io network, including Account Pairing Endpoints API, Auth Endpoints API, Callback Endpoints API, and 16 more. Tagged areas include Restaurant, Order Management, Delivery, Online Ordering, and Menu Management.

The Otter catalog on APIs.io includes 1 JSON-LD context and 2 Spectral governance rulesets.

Otter’s developer surface includes authentication, documentation, support, engineering blog, pricing, and 13 more developer resources.

🌐 Visit website 📡 Source on GitHub

49.4/100 developing ▼ -8.8 Agent 37/100 agent ready Full breakdown ↓
scored 2026-07-28 · rubric v0.6

AccessPaidSelf serve

19 APIs 9 Features 5 Use Cases

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Kin Score

Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6

Composite quality — 49.4/100 · developing

Contract Quality 14.5 / 25

Developer Ergonomics 5.2 / 20

Commercial Clarity 10.0 / 20

Operational Transparency 4.1 / 13

Governance 8.3 / 12

Discoverability 7.4 / 10

Agent readiness — 37/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 0 / 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/otter: 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 19

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 for all 19

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Public API

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Otter Plans Pricing

4 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Otter Rate Limits

6 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Otter Finops

FINOPS

Features 9

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 for all 9

JSON Schema 319

Standalone JSON Schema definitions for this provider's data models.

Scroll for all 319

JSON Structure 319

JSON Structure definitions describing this provider's data shapes.

Public Api Accept Delivery Callback Request Structure

9 properties

JSON STRUCTURE

Public Api Accept Delivery Event Structure

24 properties

JSON STRUCTURE

Public Api Account Holder Type Structure

0 properties

JSON STRUCTURE

Public Api Account Type Structure

0 properties

JSON STRUCTURE

Public Api Additional Charge Structure

4 properties

JSON STRUCTURE

Public Api Address Structure

8 properties

JSON STRUCTURE

Public Api Allergen Classification Structure

2 properties

JSON STRUCTURE

Public Api Application Id Structure

0 properties

JSON STRUCTURE

Public Api Bootstrap Menu Request Structure

5 properties

JSON STRUCTURE

Public Api Brand Info Structure

3 properties

JSON STRUCTURE

Public Api Brand Structure

2 properties

JSON STRUCTURE

Public Api Bulk Update Item Status Structure

1 properties

JSON STRUCTURE

Public Api Cancel Delivery Callback Request Structure

1 properties

JSON STRUCTURE

Public Api Cancel Delivery Event Structure

1 properties

JSON STRUCTURE

Public Api Card Brand Type Structure

0 properties

JSON STRUCTURE

Public Api Card Funding Type Structure

0 properties

JSON STRUCTURE

Public Api Card Info Structure

2 properties

JSON STRUCTURE

Public Api Card Wallet Type Structure

0 properties

JSON STRUCTURE

Public Api Category Structure

6 properties

JSON STRUCTURE

Public Api Composite Finance Line Structure

1 properties

JSON STRUCTURE

Public Api Compute Applicable Rewards Request Structure

2 properties

JSON STRUCTURE

Public Api Compute Applicable Rewards Response Structure

1 properties

JSON STRUCTURE

Public Api Connection Structure

1 properties

JSON STRUCTURE

Public Api Courier Service Delivery Info Structure

0 properties

JSON STRUCTURE

Public Api Courier Structure

5 properties

JSON STRUCTURE

Public Api Create Connection Request Structure

1 properties

JSON STRUCTURE

Public Api Create Shipment Line Item Structure

6 properties

JSON STRUCTURE

Public Api Create Shipment Request Structure

2 properties

JSON STRUCTURE

Public Api Create Shipment Response Structure

1 properties

JSON STRUCTURE

Public Api Create User Request Structure

1 properties

JSON STRUCTURE

Public Api Create User Response Structure

1 properties

JSON STRUCTURE

Public Api Credentials Schema Version Structure

0 properties

JSON STRUCTURE

Public Api Custom Bulk Resolution Options Structure

15 properties

JSON STRUCTURE

Public Api Customer Item Modification Structure

3 properties

JSON STRUCTURE

Public Api Customer Payment Structure

8 properties

JSON STRUCTURE

Public Api Customer Payment V2 Structure

4 properties

JSON STRUCTURE

Public Api Customer Tip Structure

1 properties

JSON STRUCTURE

Public Api Default Modifier Selection Data Structure

1 properties

JSON STRUCTURE

Public Api Default Modifier Selection Structure

2 properties

JSON STRUCTURE

Public Api Delivery Cost Structure

2 properties

JSON STRUCTURE

Public Api Delivery Fee Structure

1 properties

JSON STRUCTURE

Public Api Delivery Info Structure

7 properties

JSON STRUCTURE

Public Api Delivery Metadata Structure

2 properties

JSON STRUCTURE

Public Api Delivery Status Structure

0 properties

JSON STRUCTURE

Public Api Delivery Status Update Event Structure

14 properties

JSON STRUCTURE

Public Api Delivery Status Update Request Structure

12 properties

JSON STRUCTURE

Public Api Delivery Window Structure

2 properties

JSON STRUCTURE

Public Api Dietary Classification Structure

1 properties

JSON STRUCTURE

Public Api Discover Stores Event Result Structure

2 properties

JSON STRUCTURE

Public Api Discovered Store Structure

2 properties

JSON STRUCTURE

Public Api Distance Structure

2 properties

JSON STRUCTURE

Public Api Dropoff Info Structure

2 properties

JSON STRUCTURE

Public Api Dropoff Instructions Structure

2 properties

JSON STRUCTURE

Public Api Eater Order History Request Structure

4 properties

JSON STRUCTURE

Public Api Eater Order History Response Structure

2 properties

JSON STRUCTURE

Public Api Eater Order Structure

9 properties

JSON STRUCTURE

Public Api Energy Kcal Structure

2 properties

JSON STRUCTURE

Public Api Enrollment Field Structure

4 properties

JSON STRUCTURE

Public Api Entity Path Override Rule Structure

0 properties

JSON STRUCTURE

Public Api Error Detail Structure

2 properties

JSON STRUCTURE

Public Api Error Message Structure

2 properties

JSON STRUCTURE

Public Api Event Callback Error Structure

2 properties

JSON STRUCTURE

Public Api Event Notification Base Structure

3 properties

JSON STRUCTURE

Public Api Event Notification Structure

4 properties

JSON STRUCTURE

Public Api Event Result Metadata Structure

3 properties

JSON STRUCTURE

Public Api Existing Credential Structure

2 properties

JSON STRUCTURE

Public Api Exposed Third Party Info Structure

2 properties

JSON STRUCTURE

Public Api Fetch Credentials Event Structure

1 properties

JSON STRUCTURE

Public Api Financial Data Structure

19 properties

JSON STRUCTURE

Public Api Financial Invoice Structure

4 properties

JSON STRUCTURE

Public Api Financial Transaction Structure

12 properties

JSON STRUCTURE

Public Api Fulfilled Credential Structure

2 properties

JSON STRUCTURE

Public Api Fulfillment Info Structure

7 properties

JSON STRUCTURE

Public Api Fulfillment Mode Override Rule Structure

0 properties

JSON STRUCTURE

Public Api Fulfillment Path Entity Structure

2 properties

JSON STRUCTURE

Public Api Generate Report Multi Request Structure

6 properties

JSON STRUCTURE

Public Api Generate Report Response Structure

1 properties

JSON STRUCTURE

Public Api Get Enrollment Config Response Structure

1 properties

JSON STRUCTURE

Public Api Get Report Status Response Structure

2 properties

JSON STRUCTURE

Public Api Get Store Details Event Result Structure

2 properties

JSON STRUCTURE

Public Api Get User Response Structure

1 properties

JSON STRUCTURE

Public Api Gtin Structure

0 properties

JSON STRUCTURE

Public Api Hour Interval Structure

5 properties

JSON STRUCTURE

Public Api Hours Data Structure

3 properties

JSON STRUCTURE

Public Api Hours Structure

1 properties

JSON STRUCTURE

Public Api Hydra Token Structure

4 properties

JSON STRUCTURE

Public Api Intent To Cancel Event Structure

2 properties

JSON STRUCTURE

Public Api Inventory Summaries Response Structure

2 properties

JSON STRUCTURE

Public Api Inventory Summary Structure

8 properties

JSON STRUCTURE

Public Api Invoice Payout Info Structure

4 properties

JSON STRUCTURE

Public Api Item 2 Structure

5 properties

JSON STRUCTURE

Public Api Item 3 Structure

3 properties

JSON STRUCTURE

Public Api Item 4 Structure

5 properties

JSON STRUCTURE

Public Api Item Added Modification Structure

1 properties

JSON STRUCTURE

Public Api Item Modifier Structure

11 properties

JSON STRUCTURE

Public Api Item Price Override Structure

3 properties

JSON STRUCTURE

Public Api Item Selector Structure

2 properties

JSON STRUCTURE

Public Api Item Status Structure

2 properties

JSON STRUCTURE

Public Api Item Structure

14 properties

JSON STRUCTURE

Public Api Item Tax Structure

2 properties

JSON STRUCTURE

Public Api Item Update Request Structure

9 properties

JSON STRUCTURE

Public Api Job Id Structure

0 properties

JSON STRUCTURE

Public Api Job Reference Structure

2 properties

JSON STRUCTURE

Public Api List Brands Response Structure

2 properties

JSON STRUCTURE

Public Api List Shipments Response Structure

2 properties

JSON STRUCTURE

Public Api List Stores Response Structure

2 properties

JSON STRUCTURE

Public Api Location Structure

2 properties

JSON STRUCTURE

Public Api Loyalty Info Structure

1 properties

JSON STRUCTURE

Public Api Manager Cancel Order Request Structure

2 properties

JSON STRUCTURE

Public Api Manager Confirm Order Request Structure

1 properties

JSON STRUCTURE

Public Api Manager Item Issue Structure

2 properties

JSON STRUCTURE

Public Api Manager Item Issues Structure

2 properties

JSON STRUCTURE

Public Api Manager Order Cancel Details Structure

1 properties

JSON STRUCTURE

Public Api Manager Order Issue Structure

2 properties

JSON STRUCTURE

Public Api Manager Order Issues Structure

2 properties

JSON STRUCTURE

Public Api Mandate Status Structure

0 properties

JSON STRUCTURE

Public Api Marketintel Coordinates Structure

2 properties

JSON STRUCTURE

Public Api Marketintel Geo Location Information Structure

5 properties

JSON STRUCTURE

Public Api Marketintel Hours Data Structure

3 properties

JSON STRUCTURE

Public Api Marketintel Location Based Information Structure

2 properties

JSON STRUCTURE

Public Api Marketintel Regular Hours Structure

2 properties

JSON STRUCTURE

Public Api Marketintel Special Hours Structure

3 properties

JSON STRUCTURE

Public Api Marketintel Store Chain Structure

2 properties

JSON STRUCTURE

Public Api Marketintel Store Delivery Information Structure

4 properties

JSON STRUCTURE

Public Api Marketintel Store Details Structure

21 properties

JSON STRUCTURE

Public Api Marketintel Store Listing Structure

3 properties

JSON STRUCTURE

Public Api Marketintel Store Menu Structure

3 properties

JSON STRUCTURE

Public Api Marketintel Store Price Level Structure

2 properties

JSON STRUCTURE

Public Api Marketintel Store Promotion Structure

4 properties

JSON STRUCTURE

Public Api Marketintel Store Rating Structure

3 properties

JSON STRUCTURE

Public Api Marketintel Store Sales Structure

3 properties

JSON STRUCTURE

Public Api Marketintel Time Range Structure

2 properties

JSON STRUCTURE

Public Api Menu 3 Pd Structure

8 properties

JSON STRUCTURE

Public Api Menu Async Job Type Structure

0 properties

JSON STRUCTURE

Public Api Menu Async Latest Job For Store Response Structure

1 properties

JSON STRUCTURE

Public Api Menu Asynchronous Job Structure

3 properties

JSON STRUCTURE

Public Api Menu Data Structure

5 properties

JSON STRUCTURE

Public Api Menu Item 3 Pd Structure

12 properties

JSON STRUCTURE

Public Api Menu Item Pos Structure

11 properties

JSON STRUCTURE

Public Api Menu Job Publish State Structure

0 properties

JSON STRUCTURE

Public Api Menu Job Type Structure

0 properties

JSON STRUCTURE

Public Api Menu Pos Structure

7 properties

JSON STRUCTURE

Public Api Menu Publish Event Structure

1 properties

JSON STRUCTURE

Public Api Menu Publish Job State Structure

2 properties

JSON STRUCTURE

Public Api Menu Publish Request Structure

1 properties

JSON STRUCTURE

Public Api Menu Publish Response Menu Publish Targets Structure

1 properties

JSON STRUCTURE

Public Api Menu Publish Response Structure

3 properties

JSON STRUCTURE

Public Api Menu Publish Target Structure

1 properties

JSON STRUCTURE

Public Api Menu Publish Targets Structure

1 properties

JSON STRUCTURE

Public Api Menus Reward Structure

3 properties

JSON STRUCTURE

Public Api Menus Structure

5 properties

JSON STRUCTURE

Public Api Menus Upsert Request Structure

4 properties

JSON STRUCTURE

Public Api Metadata Object Structure

5 properties

JSON STRUCTURE

Public Api Modifier Group Structure

10 properties

JSON STRUCTURE

Public Api Modifier Group Update Request Structure

9 properties

JSON STRUCTURE

Public Api Modifier Item Structure

5 properties

JSON STRUCTURE

Public Api Money Structure

2 properties

JSON STRUCTURE

Public Api Null Event Structure

0 properties

JSON STRUCTURE

Public Api Nutrition Content Structure

22 properties

JSON STRUCTURE

Public Api Nutritional Info Structure

2 properties

JSON STRUCTURE

Public Api Oauth Token Generation Request Structure

7 properties

JSON STRUCTURE

Public Api Operation Type Structure

0 properties

JSON STRUCTURE

Public Api Optional Store Id In Metadata Structure

1 properties

JSON STRUCTURE

Public Api Order 2 Structure

4 properties

JSON STRUCTURE

Public Api Order Component Id Structure

2 properties

JSON STRUCTURE

Public Api Order Confirm Event Structure

1 properties

JSON STRUCTURE

Public Api Order Customer Items Update Request Structure

2 properties

JSON STRUCTURE

Public Api Order Customer Payment Update Request Structure

4 properties

JSON STRUCTURE

Public Api Order Delivery Info Update Request Structure

1 properties

JSON STRUCTURE

Public Api Order External Identifiers Structure

5 properties

JSON STRUCTURE

Public Api Order Feed Structure

2 properties

JSON STRUCTURE

Public Api Order Fulfilled Event Structure

1 properties

JSON STRUCTURE

Public Api Order Handed Off Event Structure

4 properties

JSON STRUCTURE

Public Api Order Identifier Finance Structure

2 properties

JSON STRUCTURE

Public Api Order Identifier Structure

2 properties

JSON STRUCTURE

Public Api Order Issue Structure

1 properties

JSON STRUCTURE

Public Api Order Item Information Structure

3 properties

JSON STRUCTURE

Public Api Order Prep Time Update Request Structure

1 properties

JSON STRUCTURE

Public Api Order Price Adjusted Modification Structure

1 properties

JSON STRUCTURE

Public Api Order Ready Event Structure

1 properties

JSON STRUCTURE

Public Api Order Reference Structure

2 properties

JSON STRUCTURE

Public Api Order Status Event Structure

2 properties

JSON STRUCTURE

Public Api Order Status History Structure

2 properties

JSON STRUCTURE

Public Api Order Status Update Request Structure

1 properties

JSON STRUCTURE

Public Api Order Structure

14 properties

JSON STRUCTURE

Public Api Order Total Structure

8 properties

JSON STRUCTURE

Public Api Order Total V2 Structure

3 properties

JSON STRUCTURE

Public Api Order With Manager Info Structure

5 properties

JSON STRUCTURE

Public Api Org Info Structure

2 properties

JSON STRUCTURE

Public Api Organization Structure

2 properties

JSON STRUCTURE

Public Api Override Rule 3 Pd Structure

1 properties

JSON STRUCTURE

Public Api Override Rule Structure

1 properties

JSON STRUCTURE

Public Api Parcel Carrier Delivery Info Structure

0 properties

JSON STRUCTURE

Public Api Pause Reason Structure

0 properties

JSON STRUCTURE

Public Api Pause Request Structure

4 properties

JSON STRUCTURE

Public Api Pause Response Structure

1 properties

JSON STRUCTURE

Public Api Pause Store Event Result Structure

2 properties

JSON STRUCTURE

Public Api Payment Details Ach Structure

7 properties

JSON STRUCTURE

Public Api Payment Details Acss Structure

9 properties

JSON STRUCTURE

Public Api Payment Details Bacs Structure

6 properties

JSON STRUCTURE

Public Api Payment Details Becs Structure

5 properties

JSON STRUCTURE

Public Api Payment Details Card Structure

10 properties

JSON STRUCTURE

Public Api Payment Details Sepa Structure

8 properties

JSON STRUCTURE

Public Api Payment Record Structure

7 properties

JSON STRUCTURE

Public Api Payout Info Structure

2 properties

JSON STRUCTURE

Public Api Payout Structure

3 properties

JSON STRUCTURE

Public Api Percentage Value Structure

1 properties

JSON STRUCTURE

Public Api Person Structure

5 properties

JSON STRUCTURE

Public Api Personal Identifiers Structure

2 properties

JSON STRUCTURE

Public Api Photo Structure

4 properties

JSON STRUCTURE

Public Api Pick Up Info Structure

1 properties

JSON STRUCTURE

Public Api Picture Proof Structure

1 properties

JSON STRUCTURE

Public Api Picture Requirement Structure

1 properties

JSON STRUCTURE

Public Api Ping Event Structure

1 properties

JSON STRUCTURE

Public Api Pong Object Structure

2 properties

JSON STRUCTURE

Public Api Pos Injection State Update Event Structure

4 properties

JSON STRUCTURE

Public Api Pos Menu Sync Request Structure

3 properties

JSON STRUCTURE

Public Api Pos Menu Sync Response Structure

1 properties

JSON STRUCTURE

Public Api Posorder Status Update Request Structure

2 properties

JSON STRUCTURE

Public Api Preparation Time Structure

1 properties

JSON STRUCTURE

Public Api Price Override Structure

2 properties

JSON STRUCTURE

Public Api Process Store Service Provider Status Structure

7 properties

JSON STRUCTURE

Public Api Processing Status Response Structure

1 properties

JSON STRUCTURE

Public Api Promotion Details Structure

3 properties

JSON STRUCTURE

Public Api Quantity Updated Modification Structure

3 properties

JSON STRUCTURE

Public Api Record Payment Type Structure

0 properties

JSON STRUCTURE

Public Api Record Provider Type Structure

0 properties

JSON STRUCTURE

Public Api Redeem And Accumulate Rewards Request Structure

3 properties

JSON STRUCTURE

Public Api Redeem And Accumulate Rewards Response Structure

3 properties

JSON STRUCTURE

Public Api Refund Rewards Request Structure

2 properties

JSON STRUCTURE

Public Api Refund Rewards Response Structure

1 properties

JSON STRUCTURE

Public Api Regular Hours Structure

2 properties

JSON STRUCTURE

Public Api Remove Storelink Event Structure

1 properties

JSON STRUCTURE

Public Api Report Generated Event Structure

2 properties

JSON STRUCTURE

Public Api Request Action Structure

4 properties

JSON STRUCTURE

Public Api Request Delivery Quote Callback Request Structure

9 properties

JSON STRUCTURE

Public Api Request Delivery Quote Event Structure

12 properties

JSON STRUCTURE

Public Api Request State Info Structure

6 properties

JSON STRUCTURE

Public Api Request State Structure

0 properties

JSON STRUCTURE

Public Api Required Address Structure

8 properties

JSON STRUCTURE

Public Api Required Delivery Info Structure

7 properties

JSON STRUCTURE

Public Api Required Event Result Metadata Structure

3 properties

JSON STRUCTURE

Public Api Required Person Structure

5 properties

JSON STRUCTURE

Public Api Review Reply Request Structure

5 properties

JSON STRUCTURE

Public Api Review Reply Response Structure

1 properties

JSON STRUCTURE

Public Api Reward Effect Structure

1 properties

JSON STRUCTURE

Public Api Reward Structure

7 properties

JSON STRUCTURE

Public Api Search Users Response Structure

2 properties

JSON STRUCTURE

Public Api Selected Menu Reward Structure

1 properties

JSON STRUCTURE

Public Api Selected Reward Structure

3 properties

JSON STRUCTURE

Public Api Self Drop Delivery Info Structure

0 properties

JSON STRUCTURE

Public Api Send Menu Event Callback Structure

1 properties

JSON STRUCTURE

Public Api Service Override Rule Structure

0 properties

JSON STRUCTURE

Public Api Servings Structure

2 properties

JSON STRUCTURE

Public Api Shipment Delivery Info Structure

0 properties

JSON STRUCTURE

Public Api Shipment Line Item Structure

4 properties

JSON STRUCTURE

Public Api Shipment State Change Structure

2 properties

JSON STRUCTURE

Public Api Shipment State Structure

0 properties

JSON STRUCTURE

Public Api Shipment Structure

4 properties

JSON STRUCTURE

Public Api Signature Proof Structure

3 properties

JSON STRUCTURE

Public Api Signature Requirement Structure

3 properties

JSON STRUCTURE

Public Api Simple Finance Line Structure

3 properties

JSON STRUCTURE

Public Api Simple Financial Transaction Structure

9 properties

JSON STRUCTURE

Public Api Simple Order Identifier Finance Structure

1 properties

JSON STRUCTURE

Public Api Simulate Rewards Request Structure

3 properties

JSON STRUCTURE

Public Api Simulate Rewards Response Structure

2 properties

JSON STRUCTURE

Public Api Sku Barcode Structure

2 properties

JSON STRUCTURE

Public Api Sku Details Structure

13 properties

JSON STRUCTURE

Public Api Source External Identifiers Structure

5 properties

JSON STRUCTURE

Public Api Special Hours Structure

3 properties

JSON STRUCTURE

Public Api Status Structure

0 properties

JSON STRUCTURE

Public Api Storage Requirement Structure

1 properties

JSON STRUCTURE

Public Api Store 2 Structure

6 properties

JSON STRUCTURE

Public Api Store 3 Structure

2 properties

JSON STRUCTURE

Public Api Store Availability Event Result Structure

3 properties

JSON STRUCTURE

Public Api Store Hours Configuration Event Result Structure

3 properties

JSON STRUCTURE

Public Api Store Hours Configuration Structure

3 properties

JSON STRUCTURE

Public Api Store Hours Structure

2 properties

JSON STRUCTURE

Public Api Store Id Structure

0 properties

JSON STRUCTURE

Public Api Store Info 2 Structure

5 properties

JSON STRUCTURE

Public Api Store Info Structure

6 properties

JSON STRUCTURE

Public Api Store Structure

3 properties

JSON STRUCTURE

Public Api Storefront Error Structure

2 properties

JSON STRUCTURE

Public Api Storefront Regular Hours Structure

2 properties

JSON STRUCTURE

Public Api Storefront Special Hours Structure

3 properties

JSON STRUCTURE

Public Api Storefront Time Range Structure

2 properties

JSON STRUCTURE

Public Api Subtotal Reward Structure

2 properties

JSON STRUCTURE

Public Api Subtotal Structure

1 properties

JSON STRUCTURE

Public Api Suspend Items Request Structure

3 properties

JSON STRUCTURE

Public Api Suspension Status Structure

2 properties

JSON STRUCTURE

Public Api Time Range Structure

2 properties

JSON STRUCTURE

Public Api Totals Structure

4 properties

JSON STRUCTURE

Public Api Trigger Menu Structure

3 properties

JSON STRUCTURE

Public Api Trigger Structure

1 properties

JSON STRUCTURE

Public Api Unit Price And Count Structure

2 properties

JSON STRUCTURE

Public Api Unpause Request Structure

1 properties

JSON STRUCTURE

Public Api Unpause Response Structure

1 properties

JSON STRUCTURE

Public Api Unpause Store Event Result Structure

1 properties

JSON STRUCTURE

Public Api Unpause Store Event Structure

0 properties

JSON STRUCTURE

Public Api Unsuspend Items Request Structure

2 properties

JSON STRUCTURE

Public Api Update Delivery Request Callback Request Structure

2 properties

JSON STRUCTURE

Public Api Update Delivery Request Event Structure

6 properties

JSON STRUCTURE

Public Api Update Item Status Entry Structure

2 properties

JSON STRUCTURE

Public Api Update Storelink Status Request Structure

2 properties

JSON STRUCTURE

Public Api Upload Past Orders Request Structure

1 properties

JSON STRUCTURE

Public Api Upload Past Orders Response Structure

1 properties

JSON STRUCTURE

Public Api Upsert Full Menu Event Callback Structure

1 properties

JSON STRUCTURE

Public Api Upsert Hours Event Structure

1 properties

JSON STRUCTURE

Public Api Upsert Storelink Event Result Request Structure

3 properties

JSON STRUCTURE

Public Api Upsert Storelink Event Structure

3 properties

JSON STRUCTURE

Public Api User Account Structure

3 properties

JSON STRUCTURE

Public Api User Balance Structure

2 properties

JSON STRUCTURE

Public Api User Field Structure

2 properties

JSON STRUCTURE

Public Api User Structure

2 properties

JSON STRUCTURE

Public Api Vehicle Information Structure

3 properties

JSON STRUCTURE

Public Api Verification Proof Structure

2 properties

JSON STRUCTURE

Public Api Verification Requirements Structure

2 properties

JSON STRUCTURE

Public Api View Credential Structure

5 properties

JSON STRUCTURE

Public Api View Credentials Array Structure

2 properties

JSON STRUCTURE

Scroll for all 319

Examples 293

Example request and response payloads for these APIs.

Public Api Accept Delivery Callback Request Example

9 fields

EXAMPLE

Public Api Accept Delivery Event Example

24 fields

EXAMPLE

Public Api Additional Charge Example

4 fields

EXAMPLE

Public Api Address Example

8 fields

EXAMPLE

Public Api Allergen Classification Example

2 fields

EXAMPLE

Public Api Bootstrap Menu Request Example

5 fields

EXAMPLE

Public Api Brand Example

2 fields

EXAMPLE

Public Api Brand Info Example

3 fields

EXAMPLE

Public Api Bulk Update Item Status Example

1 fields

EXAMPLE

Public Api Cancel Delivery Callback Request Example

1 fields

EXAMPLE

Public Api Cancel Delivery Event Example

1 fields

EXAMPLE

Public Api Card Info Example

2 fields

EXAMPLE

Public Api Category Example

6 fields

EXAMPLE

Public Api Composite Finance Line Example

1 fields

EXAMPLE

Public Api Compute Applicable Rewards Request Example

2 fields

EXAMPLE

Public Api Compute Applicable Rewards Response Example

1 fields

EXAMPLE

Public Api Connection Example

1 fields

EXAMPLE

Public Api Courier Example

5 fields

EXAMPLE

Public Api Courier Service Delivery Info Example

2 fields

EXAMPLE

Public Api Create Connection Request Example

1 fields

EXAMPLE

Public Api Create Shipment Line Item Example

6 fields

EXAMPLE

Public Api Create Shipment Request Example

2 fields

EXAMPLE

Public Api Create Shipment Response Example

1 fields

EXAMPLE

Public Api Create User Request Example

1 fields

EXAMPLE

Public Api Create User Response Example

1 fields

EXAMPLE

Public Api Custom Bulk Resolution Options Example

15 fields

EXAMPLE

Public Api Customer Payment Example

8 fields

EXAMPLE

Public Api Customer Payment V2 Example

4 fields

EXAMPLE

Public Api Customer Tip Example

1 fields

EXAMPLE

Public Api Default Modifier Selection Data Example

1 fields

EXAMPLE

Public Api Default Modifier Selection Example

2 fields

EXAMPLE

Public Api Delivery Cost Example

2 fields

EXAMPLE

Public Api Delivery Fee Example

1 fields

EXAMPLE

Public Api Delivery Info Example

7 fields

EXAMPLE

Public Api Delivery Metadata Example

2 fields

EXAMPLE

Public Api Delivery Status Update Event Example

14 fields

EXAMPLE

Public Api Delivery Status Update Request Example

12 fields

EXAMPLE

Public Api Delivery Window Example

2 fields

EXAMPLE

Public Api Dietary Classification Example

1 fields

EXAMPLE

Public Api Discover Stores Event Result Example

2 fields

EXAMPLE

Public Api Discovered Store Example

2 fields

EXAMPLE

Public Api Distance Example

2 fields

EXAMPLE

Public Api Dropoff Info Example

2 fields

EXAMPLE

Public Api Dropoff Instructions Example

2 fields

EXAMPLE

Public Api Eater Order Example

9 fields

EXAMPLE

Public Api Eater Order History Request Example

4 fields

EXAMPLE

Public Api Eater Order History Response Example

2 fields

EXAMPLE

Public Api Energy Kcal Example

2 fields

EXAMPLE

Public Api Enrollment Field Example

4 fields

EXAMPLE

Public Api Entity Path Override Rule Example

1 fields

EXAMPLE

Public Api Error Detail Example

2 fields

EXAMPLE

Public Api Error Message Example

2 fields

EXAMPLE

Public Api Event Callback Error Example

2 fields

EXAMPLE

Public Api Event Notification Base Example

3 fields

EXAMPLE

Public Api Event Notification Example

4 fields

EXAMPLE

Public Api Event Result Metadata Example

3 fields

EXAMPLE

Public Api Existing Credential Example

2 fields

EXAMPLE

Public Api Exposed Third Party Info Example

2 fields

EXAMPLE

Public Api Fetch Credentials Event Example

1 fields

EXAMPLE

Public Api Financial Data Example

19 fields

EXAMPLE

Public Api Financial Invoice Example

4 fields

EXAMPLE

Public Api Financial Transaction Example

12 fields

EXAMPLE

Public Api Fulfilled Credential Example

2 fields

EXAMPLE

Public Api Fulfillment Info Example

7 fields

EXAMPLE

Public Api Fulfillment Mode Override Rule Example

1 fields

EXAMPLE

Public Api Fulfillment Path Entity Example

2 fields

EXAMPLE

Public Api Generate Report Multi Request Example

6 fields

EXAMPLE

Public Api Generate Report Response Example

1 fields

EXAMPLE

Public Api Get Enrollment Config Response Example

1 fields

EXAMPLE

Public Api Get Report Status Response Example

2 fields

EXAMPLE

Public Api Get Store Details Event Result Example

2 fields

EXAMPLE

Public Api Get User Response Example

1 fields

EXAMPLE

Public Api Hour Interval Example

5 fields

EXAMPLE

Public Api Hours Data Example

3 fields

EXAMPLE

Public Api Hours Example

1 fields

EXAMPLE

Public Api Hydra Token Example

4 fields

EXAMPLE

Public Api Intent To Cancel Event Example

2 fields

EXAMPLE

Public Api Inventory Summaries Response Example

2 fields

EXAMPLE

Public Api Inventory Summary Example

8 fields

EXAMPLE

Public Api Invoice Payout Info Example

4 fields

EXAMPLE

Public Api Item 2 Example

5 fields

EXAMPLE

Public Api Item 3 Example

3 fields

EXAMPLE

Public Api Item 4 Example

5 fields

EXAMPLE

Public Api Item Added Modification Example

1 fields

EXAMPLE

Public Api Item Example

14 fields

EXAMPLE

Public Api Item Modifier Example

11 fields

EXAMPLE

Public Api Item Price Override Example

3 fields

EXAMPLE

Public Api Item Selector Example

2 fields

EXAMPLE

Public Api Item Status Example

2 fields

EXAMPLE

Public Api Item Tax Example

2 fields

EXAMPLE

Public Api Item Update Request Example

9 fields

EXAMPLE

Public Api Job Reference Example

2 fields

EXAMPLE

Public Api List Brands Response Example

2 fields

EXAMPLE

Public Api List Shipments Response Example

2 fields

EXAMPLE

Public Api List Stores Response Example

2 fields

EXAMPLE

Public Api Location Example

2 fields

EXAMPLE

Public Api Loyalty Info Example

1 fields

EXAMPLE

Public Api Manager Cancel Order Request Example

2 fields

EXAMPLE

Public Api Manager Confirm Order Request Example

1 fields

EXAMPLE

Public Api Manager Item Issue Example

2 fields

EXAMPLE

Public Api Manager Item Issues Example

2 fields

EXAMPLE

Public Api Manager Order Cancel Details Example

1 fields

EXAMPLE

Public Api Manager Order Issue Example

2 fields

EXAMPLE

Public Api Manager Order Issues Example

2 fields

EXAMPLE

Public Api Marketintel Coordinates Example

2 fields

EXAMPLE

Public Api Marketintel Geo Location Information Example

5 fields

EXAMPLE

Public Api Marketintel Hours Data Example

3 fields

EXAMPLE

Public Api Marketintel Location Based Information Example

2 fields

EXAMPLE

Public Api Marketintel Regular Hours Example

2 fields

EXAMPLE

Public Api Marketintel Special Hours Example

3 fields

EXAMPLE

Public Api Marketintel Store Chain Example

2 fields

EXAMPLE

Public Api Marketintel Store Delivery Information Example

4 fields

EXAMPLE

Public Api Marketintel Store Details Example

21 fields

EXAMPLE

Public Api Marketintel Store Listing Example

3 fields

EXAMPLE

Public Api Marketintel Store Menu Example

3 fields

EXAMPLE

Public Api Marketintel Store Price Level Example

2 fields

EXAMPLE

Public Api Marketintel Store Promotion Example

4 fields

EXAMPLE

Public Api Marketintel Store Rating Example

3 fields

EXAMPLE

Public Api Marketintel Store Sales Example

3 fields

EXAMPLE

Public Api Marketintel Time Range Example

2 fields

EXAMPLE

Public Api Menu 3 Pd Example

8 fields

EXAMPLE

Public Api Menu Async Latest Job For Store Response Example

1 fields

EXAMPLE

Public Api Menu Asynchronous Job Example

3 fields

EXAMPLE

Public Api Menu Data Example

5 fields

EXAMPLE

Public Api Menu Item 3 Pd Example

12 fields

EXAMPLE

Public Api Menu Item Pos Example

11 fields

EXAMPLE

Public Api Menu Job Publish State Example

1 fields

EXAMPLE

Public Api Menu Pos Example

7 fields

EXAMPLE

Public Api Menu Publish Event Example

1 fields

EXAMPLE

Public Api Menu Publish Job State Example

2 fields

EXAMPLE

Public Api Menu Publish Request Example

1 fields

EXAMPLE

Public Api Menu Publish Response Example

3 fields

EXAMPLE

Public Api Menu Publish Response Menu Publish Targets Example

1 fields

EXAMPLE

Public Api Menu Publish Target Example

1 fields

EXAMPLE

Public Api Menu Publish Targets Example

1 fields

EXAMPLE

Public Api Menus Example

5 fields

EXAMPLE

Public Api Menus Reward Example

3 fields

EXAMPLE

Public Api Menus Upsert Request Example

4 fields

EXAMPLE

Public Api Metadata Object Example

5 fields

EXAMPLE

Public Api Modifier Group Example

10 fields

EXAMPLE

Public Api Modifier Group Update Request Example

9 fields

EXAMPLE

Public Api Modifier Item Example

5 fields

EXAMPLE

Public Api Null Event Example

0 fields

EXAMPLE

Public Api Nutrition Content Example

22 fields

EXAMPLE

Public Api Nutritional Info Example

2 fields

EXAMPLE

Public Api Oauth Token Generation Request Example

7 fields

EXAMPLE

Public Api Optional Store Id In Metadata Example

1 fields

EXAMPLE

Public Api Order 2 Example

4 fields

EXAMPLE

Public Api Order Component Id Example

2 fields

EXAMPLE

Public Api Order Confirm Event Example

1 fields

EXAMPLE

Public Api Order Customer Items Update Request Example

2 fields

EXAMPLE

Public Api Order Customer Payment Update Request Example

4 fields

EXAMPLE

Public Api Order Delivery Info Update Request Example

1 fields

EXAMPLE

Public Api Order Example

14 fields

EXAMPLE

Public Api Order External Identifiers Example

5 fields

EXAMPLE

Public Api Order Feed Example

2 fields

EXAMPLE

Public Api Order Fulfilled Event Example

1 fields

EXAMPLE

Public Api Order Handed Off Event Example

4 fields

EXAMPLE

Public Api Order Identifier Example

2 fields

EXAMPLE

Public Api Order Identifier Finance Example

2 fields

EXAMPLE

Public Api Order Issue Example

1 fields

EXAMPLE

Public Api Order Item Information Example

3 fields

EXAMPLE

Public Api Order Prep Time Update Request Example

1 fields

EXAMPLE

Public Api Order Price Adjusted Modification Example

1 fields

EXAMPLE

Public Api Order Ready Event Example

1 fields

EXAMPLE

Public Api Order Reference Example

2 fields

EXAMPLE

Public Api Order Status Event Example

2 fields

EXAMPLE

Public Api Order Status History Example

2 fields

EXAMPLE

Public Api Order Status Update Request Example

1 fields

EXAMPLE

Public Api Order Total Example

8 fields

EXAMPLE

Public Api Order Total V2 Example

3 fields

EXAMPLE

Public Api Order With Manager Info Example

5 fields

EXAMPLE

Public Api Org Info Example

2 fields

EXAMPLE

Public Api Organization Example

2 fields

EXAMPLE

Public Api Override Rule 3 Pd Example

1 fields

EXAMPLE

Public Api Override Rule Example

1 fields

EXAMPLE

Public Api Parcel Carrier Delivery Info Example

2 fields

EXAMPLE

Public Api Pause Request Example

4 fields

EXAMPLE

Public Api Pause Response Example

1 fields

EXAMPLE

Public Api Pause Store Event Result Example

2 fields

EXAMPLE

Public Api Payment Details Ach Example

7 fields

EXAMPLE

Public Api Payment Details Acss Example

9 fields

EXAMPLE

Public Api Payment Details Bacs Example

6 fields

EXAMPLE

Public Api Payment Details Becs Example

5 fields

EXAMPLE

Public Api Payment Details Card Example

10 fields

EXAMPLE

Public Api Payment Details Sepa Example

8 fields

EXAMPLE

Public Api Payment Record Example

7 fields

EXAMPLE

Public Api Payout Example

3 fields

EXAMPLE

Public Api Payout Info Example

2 fields

EXAMPLE

Public Api Person Example

5 fields

EXAMPLE

Public Api Personal Identifiers Example

2 fields

EXAMPLE

Public Api Photo Example

4 fields

EXAMPLE

Public Api Pick Up Info Example

1 fields

EXAMPLE

Public Api Picture Proof Example

1 fields

EXAMPLE

Public Api Picture Requirement Example

1 fields

EXAMPLE

Public Api Ping Event Example

1 fields

EXAMPLE

Public Api Pong Object Example

2 fields

EXAMPLE

Public Api Pos Injection State Update Event Example

4 fields

EXAMPLE

Public Api Pos Menu Sync Request Example

3 fields

EXAMPLE

Public Api Pos Menu Sync Response Example

1 fields

EXAMPLE

Public Api Posorder Status Update Request Example

2 fields

EXAMPLE

Public Api Preparation Time Example

1 fields

EXAMPLE

Public Api Price Override Example

2 fields

EXAMPLE

Public Api Process Store Service Provider Status Example

7 fields

EXAMPLE

Public Api Processing Status Response Example

1 fields

EXAMPLE

Public Api Promotion Details Example

3 fields

EXAMPLE

Public Api Quantity Updated Modification Example

3 fields

EXAMPLE

Public Api Redeem And Accumulate Rewards Request Example

3 fields

EXAMPLE

Public Api Redeem And Accumulate Rewards Response Example

3 fields

EXAMPLE

Public Api Refund Rewards Request Example

2 fields

EXAMPLE

Public Api Refund Rewards Response Example

1 fields

EXAMPLE

Public Api Regular Hours Example

2 fields

EXAMPLE

Public Api Remove Storelink Event Example

1 fields

EXAMPLE

Public Api Report Generated Event Example

2 fields

EXAMPLE

Public Api Request Action Example

4 fields

EXAMPLE

Public Api Request Delivery Quote Callback Request Example

9 fields

EXAMPLE

Public Api Request Delivery Quote Event Example

12 fields

EXAMPLE

Public Api Request State Info Example

6 fields

EXAMPLE

Public Api Required Address Example

8 fields

EXAMPLE

Public Api Required Delivery Info Example

7 fields

EXAMPLE

Public Api Required Event Result Metadata Example

3 fields

EXAMPLE

Public Api Required Person Example

5 fields

EXAMPLE

Public Api Review Reply Request Example

5 fields

EXAMPLE

Public Api Review Reply Response Example

1 fields

EXAMPLE

Public Api Reward Effect Example

1 fields

EXAMPLE

Public Api Reward Example

7 fields

EXAMPLE

Public Api Search Users Response Example

2 fields

EXAMPLE

Public Api Selected Menu Reward Example

1 fields

EXAMPLE

Public Api Selected Reward Example

3 fields

EXAMPLE

Public Api Self Drop Delivery Info Example

2 fields

EXAMPLE

Public Api Send Menu Event Callback Example

1 fields

EXAMPLE

Public Api Service Override Rule Example

1 fields

EXAMPLE

Public Api Servings Example

2 fields

EXAMPLE

Public Api Shipment Delivery Info Example

0 fields

EXAMPLE

Public Api Shipment Example

4 fields

EXAMPLE

Public Api Shipment Line Item Example

4 fields

EXAMPLE

Public Api Shipment State Change Example

2 fields

EXAMPLE

Public Api Signature Proof Example

3 fields

EXAMPLE

Public Api Signature Requirement Example

3 fields

EXAMPLE

Public Api Simple Finance Line Example

3 fields

EXAMPLE

Public Api Simple Financial Transaction Example

9 fields

EXAMPLE

Public Api Simple Order Identifier Finance Example

1 fields

EXAMPLE

Public Api Simulate Rewards Request Example

3 fields

EXAMPLE

Public Api Simulate Rewards Response Example

2 fields

EXAMPLE

Public Api Sku Barcode Example

2 fields

EXAMPLE

Public Api Sku Details Example

13 fields

EXAMPLE

Public Api Source External Identifiers Example

5 fields

EXAMPLE

Public Api Special Hours Example

3 fields

EXAMPLE

Public Api Storage Requirement Example

1 fields

EXAMPLE

Public Api Store 2 Example

6 fields

EXAMPLE

Public Api Store 3 Example

2 fields

EXAMPLE

Public Api Store Availability Event Result Example

3 fields

EXAMPLE

Public Api Store Example

3 fields

EXAMPLE

Public Api Store Hours Configuration Event Result Example

3 fields

EXAMPLE

Public Api Store Hours Configuration Example

3 fields

EXAMPLE

Public Api Store Hours Example

2 fields

EXAMPLE

Public Api Store Info 2 Example

5 fields

EXAMPLE

Public Api Store Info Example

6 fields

EXAMPLE

Public Api Storefront Error Example

2 fields

EXAMPLE

Public Api Storefront Regular Hours Example

2 fields

EXAMPLE

Public Api Storefront Special Hours Example

3 fields

EXAMPLE

Public Api Storefront Time Range Example

2 fields

EXAMPLE

Public Api Subtotal Example

1 fields

EXAMPLE

Public Api Subtotal Reward Example

2 fields

EXAMPLE

Public Api Suspend Items Request Example

3 fields

EXAMPLE

Public Api Suspension Status Example

2 fields

EXAMPLE

Public Api Time Range Example

2 fields

EXAMPLE

Public Api Totals Example

4 fields

EXAMPLE

Public Api Trigger Example

1 fields

EXAMPLE

Public Api Trigger Menu Example

3 fields

EXAMPLE

Public Api Unpause Request Example

1 fields

EXAMPLE

Public Api Unpause Response Example

1 fields

EXAMPLE

Public Api Unpause Store Event Result Example

1 fields

EXAMPLE

Public Api Unsuspend Items Request Example

2 fields

EXAMPLE

Public Api Update Delivery Request Callback Request Example

2 fields

EXAMPLE

Public Api Update Delivery Request Event Example

6 fields

EXAMPLE

Public Api Update Item Status Entry Example

2 fields

EXAMPLE

Public Api Update Storelink Status Request Example

2 fields

EXAMPLE

Public Api Upload Past Orders Request Example

1 fields

EXAMPLE

Public Api Upload Past Orders Response Example

1 fields

EXAMPLE

Public Api Upsert Full Menu Event Callback Example

1 fields

EXAMPLE

Public Api Upsert Hours Event Example

1 fields

EXAMPLE

Public Api Upsert Storelink Event Example

3 fields

EXAMPLE

Public Api Upsert Storelink Event Result Request Example

3 fields

EXAMPLE

Public Api User Account Example

3 fields

EXAMPLE

Public Api User Balance Example

2 fields

EXAMPLE

Public Api User Example

2 fields

EXAMPLE

Public Api User Field Example

2 fields

EXAMPLE

Public Api Vehicle Information Example

3 fields

EXAMPLE

Public Api Verification Proof Example

2 fields

EXAMPLE

Public Api Verification Requirements Example

2 fields

EXAMPLE

Public Api View Credential Example

5 fields

EXAMPLE

Public Api View Credentials Array Example

2 fields

EXAMPLE

Scroll for all 293

Scopes 1

OAuth scopes governing access to this provider's APIs.

Otter Scopes

31 scopes · clientCredentials/authorizationCode

31 scopes

SCOPES

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Otter Agentic Access

80 operations · 59 acting

AGENTIC

Use Cases 5

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 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

Documentation 1

Reference material describing how the API behaves

Documentation

Documentation

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

Design & Contract 3

Pagination, idempotency, versioning, errors, and events

SpectralRules

SpectralRules

JSONLD

JSONLD

Vocabulary

Vocabulary

Build 1

SDKs, sample code, and the tooling you integrate with

GitHubRepository

GitHubRepository

Access & Security 3

Authentication, authorization, and security posture

DomainSecurity

DomainSecurity

Authentication

Authentication

OAuthScopes

OAuthScopes

Operate 2

Status, limits, changes, and where to get help

Support

Support

RateLimits

RateLimits

Commercial 3

Pricing, plans, and the legal terms of use

Plans

Plans

FinOps

FinOps

Pricing

Pricing

Company 3

The organization behind the API

Website

Website

Blog

Blog

LinkedIn

Other 1

Properties that don't map to a standard resource type

Source (apis.yml)

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
accessModel:
  pricing: paid
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  label: Paid · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/otter.png
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:otter-account-pairing-endpoints-api
  name: Otter Account Pairing Endpoints API
  description: Endpoints to manage store onboarding and status
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Account Pairing Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-account-pairing-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-auth-endpoints-api
  name: Otter Auth Endpoints API
  description: Endpoints to handle token management.
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Auth Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-auth-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-callback-endpoints-api
  name: Otter Callback Endpoints API
  description: Endpoints for callback management.
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Callback Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-callback-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-delivery-endpoints-api
  name: Otter Delivery Endpoints API
  description: Endpoints to manage delivery.
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Delivery Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-delivery-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-direct-orders-endpoints-api
  name: Otter Direct Orders Endpoints API
  description: Endpoints to get orders directly.
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Direct Orders Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-direct-orders-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-finance-endpoints-api
  name: Otter Finance Endpoints API
  description: Endpoints to handle financial data.
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Finance Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-finance-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-inventory-endpoints-api
  name: Otter Inventory Endpoints API
  description: Endpoints to interact with product inventory.
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Inventory Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-inventory-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-manager-loyalty-endpoints-api
  name: Otter Manager Loyalty Endpoints API
  description: Endpoints to manage loyalty.
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Manager Loyalty Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-manager-loyalty-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-manager-menu-endpoints-api
  name: Otter Manager Menu Endpoints API
  description: Endpoints for applications managing menus related data and operations.
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Manager Menu Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-manager-menu-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-manager-order-endpoints-api
  name: Otter Manager Order Endpoints API
  description: Endpoints for applications managing order related data and operations.
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Manager Order Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-manager-order-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-manager-storefront-endpoints-api
  name: Otter Manager Storefront Endpoints API
  description: Endpoints for applications managing storefront related data and operations.
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Manager Storefront Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-manager-storefront-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-market-intel-endpoints-api
  name: Otter Market Intel Endpoints API
  description: The Market Intel Endpoints API from Otter — 1 operation(s) for market intel endpoints.
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Market Intel Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-market-intel-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-menus-endpoints-api
  name: Otter Menus Endpoints API
  description: Endpoints to manage menus.
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Menus Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-menus-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-orders-endpoints-api
  name: Otter Orders Endpoints API
  description: Endpoints to manage orders for a store.
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Orders Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-orders-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-organization-endpoints-api
  name: Otter Organization Endpoints API
  description: Endpoints to interact with with organizations/brands/stores and with integration connections.
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Organization Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-organization-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-ping-endpoints-api
  name: Otter Ping Endpoints API
  description: Endpoints to ping and test system authentication.
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Ping Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-ping-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-reports-endpoints-api
  name: Otter Reports Endpoints API
  description: Endpoints to reports generation operations
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Reports Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-reports-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-reviews-endpoints-api
  name: Otter Reviews Endpoints API
  description: Endpoints for review operations
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Reviews Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-reviews-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
- aid: otter:otter-storefront-endpoints-api
  name: Otter Storefront Endpoints API
  description: Endpoints to manage storefront state
  humanURL: https://developer-guides.tryotter.com/docs/
  baseURL: https://{public-api-url}
  tags:
  - Storefront Endpoints
  properties:
  - type: OpenAPI
    url: openapi/otter-storefront-endpoints-api-openapi.yml
  - type: Documentation
    url: https://developer-guides.tryotter.com/docs/
  - type: GettingStarted
    url: https://developer-guides.tryotter.com/docs/
  - 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: JSONSchema
    url: json-schema/
  - type: JSONStructure
    url: json-structure/
  - type: Examples
    url: examples/
common:
- type: AgenticAccess
  url: agentic-access/otter-agentic-access.yml
- type: DomainSecurity
  url: security/otter-domain-security.yml
- type: Authentication
  url: authentication/otter-authentication.yml
- type: OAuthScopes
  url: scopes/otter-scopes.yml
- 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

Otter

APIs 19

Open Collections 1

Pricing Plans 1

Rate Limits 1

FinOps 1

Features 9

Order Aggregation

Menu Management

Delivery Orchestration

Finance & Payouts

Reports

Reviews & Loyalty

Storefront Control

Account Pairing & Organization

Webhooks

Semantic Vocabularies 1

Spectral Rules 2

JSON Schema 319