How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Otter Menus Endpoints API

Endpoints to manage menus.

Otter Menus Endpoints API is one of 27 APIs that Otter publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Menus Endpoints. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, authentication docs, rate-limit docs, and 2 JSON Schemas.

This API exposes 6 operations across 6 paths, and defines 51 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://{public-api-url}/.

6 operations 6 paths 51 schemas 6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://{public-api-url}
Authentication
OAuth 2.0
Contact
License
Proprietary
Resource Areas
1

Authentication & Security 1

Otter Menus Endpoints API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2.0) using the clientCredentials and authorizationCode flows, exposing 29 scopes.

  • OAuth2.0 — The Authorization API is based on the [OAuth2.0 protocol](https://tools.ietf.org/html/rfc6749), supporting the (Client Credentials)[https://datatracker.ietf.or…

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 6 POST. Each is listed below with its method, path, parameters, and response codes.

Menus Endpoints 6

Endpoints to manage menus.

POST
/v1/menus
Otter Upsert Menus for a Store
upsertMenu 1 param body → 202400401403404422
POST
/v1/menus/publish
Otter Notify the Result of a Publish Menu Event
menuPublishCallback 2 params body → 204400401403404422
POST
/v1/menus/current
Otter Notify the Result of a Send Menu Event
menuSendCallback 2 params body → 204400401403404422
POST
/v1/menus/hours
Otter Notify the Receival of a Upsert Hours Menu Event
menuUpsertHours 2 params → 204400401403404422
POST
/v1/menus/menu-sync
Otter Synchronize Store Menu with POS Menu
posMenuSync 1 param body → 202400401403404422
POST
/v1/menus/entity/availability/bulk
Otter Notify the Result of an Update Menu Entities Availabilities Event
updateMenuEntitiesAvailabilitiesCallback 2 params → 204400401403404422

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are NutritionContent (22 properties), CustomBulkResolutionOptions (15 properties), SkuDetails (13 properties), MenuItem_3PD (12 properties). Each schema is shown below with its type and property counts.

DefaultModifierSelectionData
object
The default modifiers selections for a modifier group.
1 property 1 required
SendMenuEventCallback
object
1 property 1 required
UpsertFullMenuEventCallback
object
1 property 1 required
NutritionalInfo
object
The nutritional information of an item.
2 properties
OverrideRule
object
Override rule for when to apply price overrides
1 property 1 required
HoursData
object
Represents hours configuration with regular hours and special hours.
3 properties 3 required
OverrideRule_3PD
object
Specification for rules to apply overrides (e.g. PriceOverride).
1 property 1 required
PosMenuSyncResponse
object
1 property
StoreId
string
The unique identifier of the store in the partner application. This ID, along with the Application ID, will be used to match the correct store when performing…
DefaultModifierSelection
object
A default modifier selection consists of a reference to the modifier and the default selected quantity of that modifier.
2 properties 2 required
NutritionContent
object
The nutrition content of the item.
22 properties
CustomBulkResolutionOptions
objectnull
15 properties
ItemTax
object
The tax configuration.
2 properties 2 required
Menu_3PD
object
A Menu for a store.
8 properties 2 required
Menu_POS
object
A menu for a store.
7 properties 2 required
PosMenuSyncRequest
object
3 properties
DietaryClassification
object
Dietary classification information.
1 property
ItemStatus
object
Represents whether an Item is for sale, indefinitely not for sale, or not for sale until a specific time.
2 properties 1 required
SkuDetails
object
Details of the product being prepared or a pre-packaged good being sold. Includes information such as UPC barcode, unique identifiers, or classification inform…
13 properties
JobReference
object
The job reference.
2 properties
ErrorDetail
object
The error detail response object.
2 properties
ModifierGroupUpdateRequest
object
Items are sold on the menu. Modifiers to items are items themselves and their relationship is defined by ModifierGroup.
9 properties 2 required
PriceOverride
object
Price override for an item
2 properties 2 required
AdditionalCharge
object
Additional charge to apply. Exactly one of either flatCharge or percentageCharge should be provided.
4 properties 1 required
StorageRequirement
object
Storage requirements for the product.
1 property
ErrorMessage
object
The error response object.
2 properties
Category
object
Categories contain a list of Item references.
6 properties 2 required
MenuPublishJobState
object
Information about the menu publish target.
2 properties
ModifierGroup
object
Items are sold on the menu. Modifiers to items are items themselves and their relationship is defined by ModifierGroup.
10 properties 2 required
ItemPriceOverride
object
Price override for an item
3 properties 3 required
TimeRange
object
Time range in a given date.
2 properties 2 required
Money
object
Money amount.
2 properties 2 required
MenuData
object
MenuData contains all menu entities, and their relations.
5 properties 5 required
SkuBarcode
object
A barcode for the product which may be common types like UPC, GTIN, ASIN or an internal type.
2 properties
MenusUpsertRequest
object
All menus associated with a store.
4 properties 3 required
UnitPriceAndCount
object
Unit price and count for additional charges.
2 properties 2 required
HourInterval
object
Represents the beginning and ending of operating time for a menu specific to a Day.
5 properties
MenuItem_3PD
object
Items are sold on the Menu. Modifiers to items are items themselves and their relationship is defined by ModifierGroup.
12 properties 6 required
MenuJobPublishState
objectnull
Only present if the MenuJobType is PUBLISH. Contains a map of MenuPublishTarget services to their corresponding statuses.
PercentageValue
object
Percentage value in decimal format.
1 property 1 required
MenuAsynchronousJob
object
The job created to process the menu request.
3 properties
Servings
object
The number of people an item serves. If only one serving value is known, set both min and max to that value.
2 properties
Photo
object
All data required to represent a Photo for an entity in menus.
4 properties 4 required
ItemUpdateRequest
object
Items are sold on the Menu. Modifiers to items are items themselves and their relationship is defined by ModifierGroup.
9 properties 5 required
Hours
object
Hours are represented as a list of HourIntervals.
1 property 1 required
RegularHours
object
Describes the configuration of regular hours.
2 properties 2 required
EnergyKcal
object
The calorie range of the item. If only one calorie value is known, set both low and high to that value.
2 properties
ExposedThirdPartyInfo
object
Information about a third party service that is exposed to the another service. Usually, this is used to expose an POS ID to an OFO.
2 properties 2 required
MenuJobType
string
Type of job.
SpecialHours
object
Describes the configuration of special store hours.
3 properties 3 required
AllergenClassification
object
Allergen classification information.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

otter-menus-endpoints-api-openapi.yml Raw ↑

Other APIs Otter publishes across the network.

Otter Account Pairing Endpoints API
Otter Auth Endpoints API
Otter Callback Endpoints API
Otter Delivery Endpoints API
Otter Direct Orders Endpoints API
Otter Finance Endpoints API
Otter Inventory Endpoints API
Otter Manager Loyalty Endpoints API
Otter Manager Menu Endpoints API
Otter Manager Order Endpoints API
Otter Manager Storefront Endpoints API
Otter Market Intel Endpoints API
Where this information came from

This is an independent, third-party profile of Otter Menus Endpoints API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.