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
openapi.json
openapi.yaml
Overview
License
UNLICENSED
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

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

Create a new zapiertrigger

Request

Creates a new zapiertrigger record.

Security
X-Api-Key
Bodyapplication/jsonrequired
triggerTypestringrequired

Type of the Zapier trigger.

Example: "new_order"
triggerIdstringrequired

Trigger ID from Zapier.

Example: "trigger_123456"
apiKeystringrequired

API key for the Zapier integration.

Example: "zap_api_key_123"
triggerUrlstringrequired

Webhook URL for the trigger.

Example: "https://hooks.zapier.com/hooks/catch/123456/abcdef"
customTriggerNamestring

Custom name for the trigger.

Example: "My Order Trigger"
curl -i -X POST \
  https://docs.finalpos.com/_mock/openapi/v1/api/zapier-triggers \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "triggerType": "new_order",
    "triggerId": "trigger_123456",
    "apiKey": "zap_api_key_123",
    "triggerUrl": "https://hooks.zapier.com/hooks/catch/123456/abcdef",
    "customTriggerName": "My Order Trigger"
  }'

Responses

The zapiertrigger has been successfully created.

Bodyapplication/json
idstring

Unique identifier for the ZapierTriggers.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the ZapierTriggers was created.

Example: "2025-12-07T19:31:48.436+00:00"
updatedAtstring(date-time)

Timestamp when the ZapierTriggers was last updated.

Example: "2025-12-07T19:35:48.436+00:00"
companyIdstring

Company ID associated with the ZapierTriggers.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
triggerTypestring

Type of the Zapier trigger.

Example: "new_order"
triggerIdstring

Trigger ID from Zapier.

Example: "trigger_123456"
apiKeystring

API key for the Zapier integration.

Example: "zap_api_key_123"
triggerUrlstring

Webhook URL for the trigger.

Example: "https://hooks.zapier.com/hooks/catch/123456/abcdef"
customTriggerNamestring

Custom name for the trigger.

Example: "My Order Trigger"
Response
application/json
{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "triggerType": "new_order",
  "triggerId": "trigger_123456",
  "apiKey": "zap_api_key_123",
  "triggerUrl": "https://hooks.zapier.com/hooks/catch/123456/abcdef",
  "customTriggerName": "My Order Trigger"
}

Get a zapiertrigger by ID

Request

Retrieves a single zapiertrigger by its unique identifier.

Security
X-Api-Key
Path
idstringrequired

ZapierTriggers ID

curl -i -X GET \
  'https://docs.finalpos.com/_mock/openapi/v1/api/zapier-triggers/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

The zapiertrigger has been successfully retrieved.

Bodyapplication/json
idstring

Unique identifier for the ZapierTriggers.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the ZapierTriggers was created.

Example: "2025-12-07T19:31:48.436+00:00"
updatedAtstring(date-time)

Timestamp when the ZapierTriggers was last updated.

Example: "2025-12-07T19:35:48.436+00:00"
companyIdstring

Company ID associated with the ZapierTriggers.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
triggerTypestring

Type of the Zapier trigger.

Example: "new_order"
triggerIdstring

Trigger ID from Zapier.

Example: "trigger_123456"
apiKeystring

API key for the Zapier integration.

Example: "zap_api_key_123"
triggerUrlstring

Webhook URL for the trigger.

Example: "https://hooks.zapier.com/hooks/catch/123456/abcdef"
customTriggerNamestring

Custom name for the trigger.

Example: "My Order Trigger"
Response
application/json
{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "triggerType": "new_order",
  "triggerId": "trigger_123456",
  "apiKey": "zap_api_key_123",
  "triggerUrl": "https://hooks.zapier.com/hooks/catch/123456/abcdef",
  "customTriggerName": "My Order Trigger"
}

Update a zapiertrigger by ID

Request

Updates an existing zapiertrigger record.

Security
X-Api-Key
Path
idstringrequired

ZapierTriggers ID

Bodyapplication/jsonrequired
triggerTypestring

Type of the Zapier trigger.

Example: "new_order"
triggerIdstring

Trigger ID from Zapier.

Example: "trigger_123456"
apiKeystring

API key for the Zapier integration.

Example: "zap_api_key_123"
triggerUrlstring

Webhook URL for the trigger.

Example: "https://hooks.zapier.com/hooks/catch/123456/abcdef"
customTriggerNamestring

Custom name for the trigger.

Example: "My Order Trigger"
curl -i -X PUT \
  'https://docs.finalpos.com/_mock/openapi/v1/api/zapier-triggers/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "triggerType": "new_order",
    "triggerId": "trigger_123456",
    "apiKey": "zap_api_key_123",
    "triggerUrl": "https://hooks.zapier.com/hooks/catch/123456/abcdef",
    "customTriggerName": "My Order Trigger"
  }'

Responses

The zapiertrigger has been successfully updated.

Bodyapplication/json
idstring

Unique identifier for the ZapierTriggers.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the ZapierTriggers was created.

Example: "2025-12-07T19:31:48.436+00:00"
updatedAtstring(date-time)

Timestamp when the ZapierTriggers was last updated.

Example: "2025-12-07T19:35:48.436+00:00"
companyIdstring

Company ID associated with the ZapierTriggers.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
triggerTypestring

Type of the Zapier trigger.

Example: "new_order"
triggerIdstring

Trigger ID from Zapier.

Example: "trigger_123456"
apiKeystring

API key for the Zapier integration.

Example: "zap_api_key_123"
triggerUrlstring

Webhook URL for the trigger.

Example: "https://hooks.zapier.com/hooks/catch/123456/abcdef"
customTriggerNamestring

Custom name for the trigger.

Example: "My Order Trigger"
Response
application/json
{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "triggerType": "new_order",
  "triggerId": "trigger_123456",
  "apiKey": "zap_api_key_123",
  "triggerUrl": "https://hooks.zapier.com/hooks/catch/123456/abcdef",
  "customTriggerName": "My Order Trigger"
}

Delete a zapiertrigger by ID

Request

Deletes a zapiertrigger by its unique identifier.

Security
X-Api-Key
Path
idstringrequired

ZapierTriggers ID

curl -i -X DELETE \
  'https://docs.finalpos.com/_mock/openapi/v1/api/zapier-triggers/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

The zapiertrigger has been successfully deleted.

Bodyapplication/json
statusCodenumberrequired

HTTP status code

Example: 200
messagestringrequired

Message describing the result of the operation

Example: "Resource with Id 123 deleted successfully"
Response
application/json
{
  "statusCode": 200,
  "message": "Resource with Id 123 deleted successfully"
}