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 pos_journals API

The pos_journals API from TableCheck — 3 operation(s) for pos_journals.

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

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

This API exposes 6 operations across 3 paths, and defines 14 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/.

6 operations 3 paths 14 schemas 1 DELETE2 GET2 POST1 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 pos_journals 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 6

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

pos_journals 6
GET
/shops/{shop_id}/pos_journals
List all PosJournals
listPosJournals 1 param → 200403422
POST
/shops/{shop_id}/pos_journals
Create PosJournal
createPosJournal 1 param body → 200400403422
GET
/shops/{shop_id}/pos_journals/{pos_journal_id}
Get PosJournal information
showPosJournal 2 params → 200404403422
PUT
/shops/{shop_id}/pos_journals/{pos_journal_id}
Update PosJournal
updatePosJournal 2 params body → 200400403404422
DELETE
/shops/{shop_id}/pos_journals/{pos_journal_id}
Delete PosJournal
deletePosJournal 2 params → 200400403404422
POST
/shops/{shop_id}/pos_journals/void
Void PosJournal (Check Void)
voidPosJournal 1 param body → 200400403404422

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are PosJournal (42 properties), PosJournalCreateParams (37 properties), PosJournalUpdateParams (37 properties), Reservation (26 properties). Each schema is shown below with its type and property counts.

ShopNotFoundError
object
1 property 1 required
Reservation
object
26 properties
PosOrder
object
10 properties
BadRequestError
object
1 property 1 required
PosJournalSingleResponse
object
2 properties
PosJournal
object
42 properties
NotFoundError
object
1 property 1 required
PosJournalCreateParams
object
37 properties 1 required
UnprocessableEntityError
object
1 property 1 required
PosPayment
object
7 properties
PosJournalUpdateParams
object
37 properties
PosJournalsListResponse
object
2 properties
PosDiscount
object
5 properties
ForbiddenError
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tablecheck-pos-journals-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 reservation_flags API
TableCheck reservations API
TableCheck shops API
TableCheck table_status API
TableCheck tables API