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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Otter

Otter Orders Endpoints API

Endpoints to manage orders for a store.

Documentation Provider Profile APIs.io OpenAPI GitHub

Otter Orders 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 Orders 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 53 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 53 schemas 3 POST3 PUT

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
Kin Lane
License
Proprietary
Resource Areas
1

Authentication & Security 1

Otter Orders 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 — 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Orders Endpoints 6

Endpoints to manage orders for a store.

POST
/v1/orders
Otter Create Order
createOrder 1 param body → 200400401403404422
PUT
/v1/orders/{orderId}
Otter Update Order
updateOrder 2 params body → 200400401403404422
POST
/v1/orders/{orderId}/status
Otter Update Order Status
updateOrderStatus 3 params body → 202400401403404422
PUT
/v1/orders/{orderId}/payments
Otter Update Order Customer Payment
updateOrderCustomerPayment 2 params body → 200400401403404422
PUT
/v1/orders/{orderId}/delivery
Otter Update Order Delivery Information
updateOrderDeliveryInfo 2 params body → 202400401403404422
POST
/v1/orders/past-orders
Otter Upload Past Orders
uploadPastOrders 1 param body → 200400401403404422

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are FinancialData (19 properties), Item (14 properties), Order (14 properties), ItemModifier (11 properties). Each schema is shown below with its type and property counts.

PreparationTime
objectnull
Preparation time information for an order.
1 property
SignatureRequirement
objectnull
Enables and configure the signature requirement.
3 properties
PaymentDetailsBecs
object
Details of a BECS payment method in Australia.
5 properties
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…
UploadPastOrdersRequest
object
The request to create past orders (read only).
1 property 1 required
RecordProviderType
string
The type of payment provider.
OrderReference
object
An order reference.
2 properties 2 required
SourceExternalIdentifiers
objectnull
The external identifiers.
5 properties
PaymentDetailsSepa
object
Details of a SEPA payment method in EU countries.
8 properties
Address
objectnull
Order delivery address.
8 properties
FulfillmentInfo
objectnull
Information on order fulfillment.
7 properties
Person
objectnull
The recipient information.
5 properties
CustomerPayment
object
8 properties 3 required
PersonalIdentifiers
objectnull
The person's personal identifiers (e.g. tax identification number).
2 properties
VerificationRequirements
objectnull
Verification requirements for the delivery.
2 properties
ErrorDetail
object
The error detail response object.
2 properties
MandateStatus
string
The status of the mandate.
UploadPastOrdersResponse
object
The response to create a past order (read only).
1 property 1 required
CompositeFinanceLine
object
composite finance line can represent a value, tax and VAT for a given line as a list of SimpleFinanceLine objects
1 property 1 required
OrderDeliveryInfoUpdateRequest
object
The request to update an order delivery info status.
1 property 1 required
SimpleFinanceLine
object
simple finance line.
3 properties 3 required
CardInfo
objectnull
Additional card information.
2 properties 2 required
OrderCustomerPaymentUpdateRequest
object
The request to update customer payment for an order.
4 properties 2 required
Courier
objectnull
Details about the delivery courier.
5 properties
ErrorMessage
object
The error response object.
2 properties
PictureRequirement
objectnull
Enables and configure the picture requirement.
1 property
PaymentDetailsBacs
object
Details of a BACS payment method in the UK.
6 properties
CustomerPaymentV2
objectnull
Details about customer payment.
4 properties
FinancialData
object
Breakdown of order values. Represents total values, fees, discounts, and any possible adjustments that may happen in the order value. Breakdown lists can be us…
19 properties 1 required
CardBrandType
string
The brand of the card.
OrderTotalV2
objectnull
V2 for details about values of the order, provides richer objects allowing to capture taxes, misc charges, payments more precisely.
3 properties 1 required
LoyaltyInfo
objectnull
The customer's loyalty information.
1 property
AccountHolderType
string
The type of account holder.
Item
object
14 properties 1 required
PromotionDetails
objectnull
Order promotion details.
3 properties
Location
objectnull
Latitude and longitude of the address.
2 properties 2 required
Payout
objectnull
Details on payout.
3 properties
OrderTotal
object
Details about values of the order.
8 properties 1 required
RecordPaymentType
string
The type of payment method.
PaymentDetailsAch
object
Details of a debit ACH payment method in the US.
7 properties
PaymentDetailsAcss
object
Details of an ACSS payment method in Canada.
9 properties
DeliveryInfo
objectnull
Information on order's delivery process.
7 properties
RequiredDeliveryInfo
object
Information on order's delivery process.
7 properties
PaymentRecord
object
Represents the details and metadata of a payment method used in transactions.
7 properties
OrderStatusUpdateRequest
object
The request to change an order status.
1 property 1 required
AccountType
string
The type of ACH account.
CardWalletType
string
The type of wallet associated with the card.
OrderExternalIdentifiers
object
The external identifiers.
5 properties 2 required
Order
object
An order placed by a customer.
14 properties 3 required
CardFundingType
string
The funding type of the card.
ItemModifier
object
11 properties 1 required
PaymentDetailsCard
object
Details of a card payment method.
10 properties
DropoffInstructions
objectnull
Requirements to verify the completion of the delivery.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Otter publishes across the network.

Otter Account Pairing Endpoints API
AE Profile APIs.io
Otter Auth Endpoints API
AE Profile APIs.io
Otter Callback Endpoints API
AE Profile APIs.io
Otter Delivery Endpoints API
AE Profile APIs.io
Otter Direct Orders Endpoints API
AE Profile APIs.io
Otter Finance Endpoints API
AE Profile APIs.io
Otter Inventory Endpoints API
AE Profile APIs.io
Otter Manager Loyalty Endpoints API
AE Profile APIs.io
Otter Manager Menu Endpoints API
AE Profile APIs.io
Otter Manager Order Endpoints API
AE Profile APIs.io
Otter Manager Storefront Endpoints API
AE Profile APIs.io
Otter Market Intel Endpoints API
AE Profile APIs.io
#Orders Endpoints
← Back to O APIs
API Details
ID
otter:otter-orders-endpoints-api
Base URL
https://{public-api-url}
Docs
https://developer-guides.tryotter.com/docs/
Provider
Otter
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=otter-orders-endpoints-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/otter-orders-endpoints-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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