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

Endpoints to interact with product inventory.

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

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

3 operations 2 paths 20 schemas 2 GET1 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 Inventory 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 3

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

Inventory Endpoints 3

Endpoints to interact with product inventory.

GET
/inventories/v1/summaries
Otter List Inventory Summaries
listInventorySummaries 3 params → 200400401403404422
GET
/inventories/v1/shipments
Otter List Shipments
listInventoryShipments 3 params → 200400401403404422
POST
/inventories/v1/shipments
Otter Create Shipment
createShipment 1 param body → 200400401403404422

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are InventorySummary (8 properties), CreateShipmentLineItem (6 properties), ShipmentLineItem (4 properties), Shipment (4 properties). Each schema is shown below with its type and property counts.

ShipmentState
string
The state of the shipment.
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…
ListShipmentsResponse
object
2 properties
ShipmentDeliveryInfo
object
Delivery information for a shipment.
ErrorDetail
object
The error detail response object.
2 properties
CourierServiceDeliveryInfo
CreateShipmentRequest
object
2 properties 2 required
ShipmentLineItem
object
4 properties 2 required
InventorySummary
object
The inventory summary for a specific product.
8 properties 3 required
SelfDropDeliveryInfo
ErrorMessage
object
The error response object.
2 properties
DeliveryMetadata
object
2 properties 2 required
CreateShipmentResponse
object
A response containing information about the created shipment.
1 property 1 required
ShipmentStateChange
object
2 properties 2 required
Gtin
string
A 14 digit Global Trade Item Number (GTIN). For GTIN values that are shorter than 14 digits, value will be padded with leading zeroes.
Shipment
object
4 properties 4 required
InventorySummariesResponse
object
2 properties
DeliveryWindow
object
The delivery window in which the shipment is expected to arrive at the destination.
2 properties 2 required
CreateShipmentLineItem
object
6 properties 1 required
ParcelCarrierDeliveryInfo

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

otter-inventory-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 Manager Loyalty Endpoints API
Otter Manager Menu Endpoints API
Otter Manager Order Endpoints API
Otter Manager Storefront Endpoints API
Otter Market Intel Endpoints API
Otter Menus Endpoints API
Where this information came from

This is an independent, third-party profile of Otter Inventory 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.