Skip to content

Final POS API (1.2.4)

Welcome to the Final POS Public API—your playground for crafting the checkout and kiosk flows you want. Create your API keys in Manage (Settings > API Keys) and send them as x-api-key on every request. Customer endpoints use dynamic DTO generation so they adapt to your custom tables in real time, while the rest of the controllers follow a stable, static contract for predictable integrations.

Download OpenAPI description
Overview
License
Languages
Servers
Mock server
https://docs.finalpos.com/_mock/openapi
Official API
https://api.finalpos.com

Data Transfer Objects (DTOs)

Schemas

Customer

Operations

Customers

Operations

Custom Tables: structure

Operations

Custom Table: content

Operations

Custom Tables: content

Operations

Get all custom tables: content

Request

Retrieves a list of all custom tables: content. Supports pagination and filtering by companyId.

Security
X-Api-Key
Query
tableIdstring

Filter by custom table ID

skipnumber

Number of records to skip (must be a multiple of limit for accurate page numbers)

limitnumber

Maximum number of records to return

curl -i -X GET \
  'https://docs.finalpos.com/_mock/openapi/v1/api/custom-table-rows?tableId=string&skip=0&limit=0' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved a list of custom tables: content

Response
No content

Get all custom tables: content

Request

Retrieves a list of all custom tables: content. Supports pagination and filtering by companyId.

Security
X-Api-Key
Query
tableIdstring

Filter by custom table ID

rowIdstring

Filter by custom table row ID

skipnumber

Number of records to skip (must be a multiple of limit for accurate page numbers)

limitnumber

Maximum number of records to return

curl -i -X GET \
  'https://docs.finalpos.com/_mock/openapi/v1/api/custom-table-values?tableId=string&rowId=string&skip=0&limit=0' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved a list of custom tables: content

Response
No content

Get all rows from a custom table

Request

Security
X-Api-Key
Path
tableNamestringrequired

Table name (kebab-case)

Query
skipnumber

Number of records to skip

limitnumber

Maximum number of records to return

curl -i -X GET \
  'https://docs.finalpos.com/_mock/openapi/v1/api/custom-table-data/{tableName}?skip=0&limit=0' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
rowIdobjectrequired

Row ID

Example: {"$oid":"507f1f77bcf86cd799439011"}
]
Response
application/json
[ { "rowId": { … } } ]

Product

Operations

Products

Operations

Outlet

Operations

Outlets

Operations

Category

Operations

Categories

Operations

Station

Operations

Stations

Operations

Variant

Operations

Variants

Operations

Order

Operations

Orders

Operations

Transactions

Operations

Roles

Operations

Attachment

Operations

Account

Operations

Refunds

Operations

Session

Operations

ZapierTriggers

Operations