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 Storefront Endpoints API

Endpoints to manage storefront state

Otter Storefront 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 Storefront 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 7 operations across 7 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version v1.

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

7 operations 7 paths 32 schemas 7 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 Storefront 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 7

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

Storefront Endpoints 7

Endpoints to manage storefront state

POST
/v1/storefront/availability
Otter Notify About Store Availability Change
postStoreAvailabilityChange 2 params body → 204400401403404422
POST
/v1/storefront/hours
Otter Notify About Store Hours Configuration Change
postStoreHoursConfigurationChange 2 params body → 204400401403404422
POST
/v1/storefront/pause
Otter Notify the Result of a Pause Request Event
postPauseStoreEventResult 2 params body → 204400401403404422
POST
/v1/storefront/unpause
Otter Notify the Result of an Unpause Request Event
postUnpauseStoreEventResult 2 params body → 204400401403404422
POST
/v1/storefront/eater-side/status
Otter Notify About Store Availability Change from the Eater Side
postEaterSideStoreAvailabilityChange 2 params body → 204400401403404422
POST
/v1/storefront/eater-side/hours
Otter Notify About Store Hours Configuration Change on Eater Side
postEaterSideStoreHoursConfigurationChange 2 params body → 204400401403404422
POST
/v1/market-intel/store-details
Otter Notify About Store Details Update
postGetStoreDetailsResult 1 param body → 204400401403404422

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are Marketintel_StoreDetails (21 properties), Address (8 properties), Marketintel_GeoLocationInformation (5 properties), Marketintel_StorePromotion (4 properties). Each schema is shown below with its type and property counts.

Marketintel_StorePromotion
object
The Store Promotion information. At least one of the displayName, promotionType, campaignType or promotionId need to be present.
4 properties
Marketintel_StoreMenu
object
The Store listing in ranking order based on category.
3 properties
Storefront_TimeRange
object
Time range in a given date.
2 properties
UnpauseStoreEventResult
object
Result of an event that requested to unpause a store.
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…
Marketintel_GeoLocationInformation
object
The geographical location information used to discover stores. This information will need be pass back with the result.
5 properties
Address
objectnull
Order delivery address.
8 properties
Marketintel_StoreDetails
object
The Store delivery information.
21 properties
GetStoreDetailsEventResult
object
The result of an event that request to store details.
2 properties
Marketintel_StoreDeliveryInformation
object
The Store delivery information.
4 properties
ErrorDetail
object
The error detail response object.
2 properties
PauseStoreEventResult
object
Result of an event that requested to pause a store.
2 properties
StoreHoursConfigurationEventResult
object
The current store hours configuration.
3 properties
Marketintel_StoreSales
object
The Store Sales information. At least one of the periodType, numberOfSales or displayNumberOfSales need to be present.
3 properties
ErrorMessage
object
The error response object.
2 properties
Marketintel_TimeRange
object
Time range in a given date.
2 properties 2 required
Marketintel_Coordinates
object
The geographical coordinates of a location.
2 properties
StoreHours
objectnull
Represents store hours configuration with regular hours and special hours.
2 properties
Marketintel_StorePriceLevel
object
The Store Price Level information. At least one of the price level or price level name need to be present.
2 properties
Marketintel_HoursData
object
Represents hours configuration with regular hours and special hours.
3 properties 3 required
Money
object
Money amount.
2 properties 2 required
Marketintel_StoreChain
object
The Store Chain information.
2 properties
RequiredEventResultMetadata
object
Information about the result of a storefront event.
3 properties
Location
objectnull
Latitude and longitude of the address.
2 properties 2 required
Storefront_SpecialHours
object
Describes the configuration of special store hours.
3 properties 3 required
Storefront_RegularHours
object
Describes the configuration of regular hours.
2 properties 2 required
Marketintel_SpecialHours
object
Describes the configuration of special store hours.
3 properties 3 required
Marketintel_RegularHours
object
Describes the configuration of regular hours.
2 properties 2 required
StoreAvailabilityEventResult
object
The current state of a store.
3 properties
EventResultMetadata
objectnull
Information about the result of a storefront event.
3 properties
StoreHoursConfiguration
object
The current store hours configuration of a store.
3 properties 1 required
Marketintel_StoreRating
object
The Store rating information. At least one of the ratingScore, estimatedRatingCount or displayRatingCount need to be present.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

otter-storefront-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 Storefront 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.