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

TableCheck reservations API

The reservations API from TableCheck — 6 operation(s) for reservations.

TableCheck reservations API is one of 14 APIs that TableCheck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include reservations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 6 paths, and defines 51 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://api.tablecheck.com/api/availability/v1/.

10 operations 6 paths 51 schemas 5 GET1 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.tablecheck.com/api/availability/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

TableCheck reservations API declares 1 security scheme for authenticating requests. An API key is passed in the header as AUTHORIZATION (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 5 GET, 1 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

reservations 10
GET
/reservations
List all Reservations
listReservations 14 params → 200400403422
POST
/reservations
Create Reservation
createReservation body → 200400403422
GET
/reservations/{reservation_id_or_ref}
Fetch a specific Reservation
showReservationById 3 params → 200400403404422
PUT
/reservations/{reservation_id_or_ref}
Update Reservation
updateReservation 1 param body → 200400403404422
PUT
/reservations/{reservation_id_or_ref}/cancel
Cancel Reservation
cancelReservation 1 param body → 200400403404422
GET
/reservations/{reservation_id}
Fetch a specific Reservation
showReservationById 3 params → 200default
PUT
/reservations/{reservation_id}
Update Reservation
updateReservation 1 param body → 200400403404422
GET
/shops/{shop_id}/reservations
List all Reservations
listReservations 12 params → 200403422
GET
/shops/{shop_id}/reservations/{reservation_id}
Get Reservation information
showReservation 4 params → 200403404
PUT
/shops/{shop_id}/reservations/{reservation_id}
Update Reservation
updateReservation 2 params body → 200400403404422

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are Reservation (80 properties), Reservation_2 (52 properties), ReservationCreateParams (47 properties), CustomerEmbed (38 properties). Each schema is shown below with its type and property counts.

ReservationShowResponse
object
1 property
ReservationShowResponse_2
object
2 properties
Reservation_3
object
26 properties
Reservation_2
object
52 properties
MembershipEmbed
object
8 properties
ImageEmbed
object
8 properties
Emails
array
[PII] A list of Email objects.
UnprocessableEntityError
object
1 property 1 required
QuestionEmbed
object
3 properties
PaginationData
object
2 properties
ReservationUpdateParams_2
object
30 properties
Error
object
1 property 1 required
ReservationCancelParams
object
3 properties
ShopNotFoundError
object
1 property 1 required
ImageEmbedDestroy
object
2 properties
Reservation
object
80 properties
BadRequestError
object
1 property 1 required
FranchiseEmbed
object
2 properties
ShopEmbed
object
7 properties
ReservationUpdateParams_3
object
4 properties
Social
object
5 properties 1 required
ImageDimensions
object
3 properties
ImageVariants
object
4 properties
Email
object
5 properties 1 required
ReservationUpdateParams
object
25 properties
OrderEmbed
object
8 properties
MenuItemEmbed
object
3 properties
PhoneNumbersList
array
[PII] A list of phone numbers as strings.
ReservationsListResponse
object
2 properties
PosOrder
object
12 properties
ReservationCreateParams
object
The API validates that at least one of firstname or lastname is present. This schema requires lastname so that requests valid against the schema always satisfy…
47 properties 4 required
Event
object
8 properties
Address
object
10 properties
EmailAddressesList
array
[PII] Email addresses as an array of strings.
TableEmbed
object
2 properties
NotFoundError
object
1 property 1 required
PosJournalEmbed
object
23 properties
PromoEmbed
object
2 properties
ReservationOrder
object
4 properties
PosPayment
object
7 properties
MenuItemNameTranslation
object
2 properties
CustomerEmbed
object
38 properties
PaymentEmbed
object
12 properties
PosDiscount
object
5 properties
Phones
array
[PII] A list of Phone objects.
ReservationSingleResponse
object
1 property
ServiceCategoryEmbed
object
2 properties
ReservationFlag
object
10 properties
Phone
object
5 properties 1 required
ImageEmbedCreate
object
1 property
ForbiddenError
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tablecheck-reservations-api-openapi.yml Raw ↑

Other APIs TableCheck publishes across the network.

TableCheck availability API
TableCheck blockages API
TableCheck calendar API
TableCheck customers API
TableCheck franchises API
TableCheck membership_programs API
TableCheck memberships API
TableCheck pos_journals API
TableCheck reservation_flags API
TableCheck shops API
TableCheck table_status API
TableCheck tables API