Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TheFork Orders API

Open and close point-of-sale orders tied to reservations.

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

This API exposes 6 JSON Schema definitions.

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

This API exposes 2 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://api.thefork.io/manager/v1.

2 operations 2 paths 8 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.thefork.io
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

TheFork Orders API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow. By default, every request must be authenticated.

  • OAuth2ClientCredentials — Auth0 OAuth 2.0 client credentials flow. Exchange clientid and clientsecret for a bearer token at https://auth.thefork.io/oauth/token with audience https://api…

Paths & Operations 2

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

Orders 2

Open and close point-of-sale orders tied to reservations.

POST
/orders
Open Order
openOrder 1 param body → 204401429
POST
/orders/{orderId}/close
Close Order
closeOrder 2 params body → 204401404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Order (9 properties), Customer (5 properties), Offer (4 properties), Money (2 properties). Each schema is shown below with its type and property counts.

Offer
object
4 properties
ReservationStatus
string
Order
object
9 properties 5 required
Table
object
2 properties
Customer
object
5 properties
OrderClose
object
2 properties 1 required
Money
object
A monetary amount with currency.
2 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thefork-orders-api-openapi.yml Raw ↑

Other APIs TheFork publishes across the network.

TheFork Customers API
TheFork Reservations API
TheFork Reviews API