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

SpotOn Orders API

Order and check data export, including items, modifiers, payments, and taxes.

SpotOn Orders API is one of 15 APIs that SpotOn publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 62 JSON Schema definitions.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a JSON-LD context, a getting-started guide, and 62 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version v2.

Requests are made against 2 base URLs: https://api.seatninja.com, https://sandbox.seatninja.com.

2 operations 2 paths 11 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2
Base URL
https://restaurantapi.spoton.com/posexport/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

SpotOn Orders API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — API key scoped to specific restaurants.

Paths & Operations 2

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

Orders 2

Order and check data export, including items, modifiers, payments, and taxes.

GET
/locations/{locationId}/orders
SpotOn List Orders
listOrders 8 params → 200400401403500
GET
/locations/{locationId}/orders/{orderId}
SpotOn Get Order
getOrder 2 params → 200401403404500

Schemas 11

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

OwnerInfo
object
Employee ownership details for an order.
3 properties
Error
object
A standard error response.
2 properties
OrderDiscount
object
A discount applied to an order line or modifier.
5 properties
OrderSurcharge
object
A surcharge applied to an order check or payment.
6 properties
OrderMenuItem
object
A menu item line on an order check or guest.
14 properties
OrderTax
object
A tax applied to an order line, modifier, or surcharge.
4 properties
OrderModifier
object
A modifier applied to an ordered menu item.
10 properties
OrderPayment
object
A payment recorded against an order check.
14 properties
Order
object
An order exported from the SpotOn Restaurant POS System.
19 properties
OrderCheck
object
A check on an order, holding guests, payments, and surcharges.
10 properties
OrderGuest
object
A guest on an order check.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spoton-orders-api-openapi.yml Raw ↑

Other APIs SpotOn publishes across the network.

SpotOn Availability API
SpotOn Cash Deposits API
SpotOn Employees API
SpotOn Job Positions API
SpotOn Locations API
SpotOn Menu Items API
SpotOn Order Types API
SpotOn Paid In Outs API
SpotOn Payment Options API
SpotOn Report Categories API
SpotOn Reservations API
SpotOn Restaurants API
Where this information came from

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