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

Create a new product

Request

Creates a new product record.

Security
X-Api-Key
Bodyapplication/jsonrequired
namestringrequired

Name of the product.

Example: "Sweet Tea"
productTypestringrequired

Type of the product.

Example: "Beverages"
externalIdstring

External ID of the product.

Example: "1234567890"
descriptionstring

Description of the product.

Example: "Sweet Tea is a refreshing drink made with tea and sugar."
shortDescriptionstring

Short description of the product.

Example: "Sweet Tea is a drink with sugar."
skustring

SKU of the product.

Example: "1234567890"
imagesArray of strings

Images of the product.

Example: ["https://example.com/image1.jpg","https://example.com/image2.jpg"]
tagsArray of strings

Tags of the product.

Example: ["sweet","tea","refreshing"]
statusstring

Status of the product.

Example: "draft"
sourcestring

Source of the product.

Example: "woo-commerce"
minPricenumber

Min price of the product.

Example: 100
maxPricenumber

Max price of the product.

Example: 200
supplierstring

Supplier of the product.

Example: "Supplier 1"
taxTablestring

Tax table of the product.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
categoriesArray of strings

Categories of the product.

Example: ["o1p2q3r4s5t6u7v8w9x0y1z2","o1p2q3r4s5t6u7v8w9x0y1z3"]
outletsArray of strings

Outlets of the product.

Example: ["o1p2q3r4s5t6u7v8w9x0y1z2","o1p2q3r4s5t6u7v8w9x0y1z3"]
metadataArray of objects(MetadataDto)

Metadata associated with the Product.

Example: [{"key":"key1","value":"value1"},{"key":"key2","value":"value2"}]
attributesArray of objects(AttributeEmbeddedDto)

Attributes associated with the Product.

Example: [{"name":"color","values":["red","blue"]}]
curl -i -X POST \
  https://docs.finalpos.com/_mock/openapi/v1/api/product \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Sweet Tea",
    "productType": "Beverages",
    "externalId": "1234567890",
    "description": "Sweet Tea is a refreshing drink made with tea and sugar.",
    "shortDescription": "Sweet Tea is a drink with sugar.",
    "sku": "1234567890",
    "images": [
      "https://example.com/image1.jpg",
      "https://example.com/image2.jpg"
    ],
    "tags": [
      "sweet",
      "tea",
      "refreshing"
    ],
    "status": "draft",
    "source": "woo-commerce",
    "minPrice": 100,
    "maxPrice": 200,
    "supplier": "Supplier 1",
    "taxTable": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "categories": [
      "o1p2q3r4s5t6u7v8w9x0y1z2",
      "o1p2q3r4s5t6u7v8w9x0y1z3"
    ],
    "outlets": [
      "o1p2q3r4s5t6u7v8w9x0y1z2",
      "o1p2q3r4s5t6u7v8w9x0y1z3"
    ],
    "metadata": [
      {
        "key": "key1",
        "value": "value1"
      },
      {
        "key": "key2",
        "value": "value2"
      }
    ],
    "attributes": [
      {
        "name": "color",
        "values": [
          "red",
          "blue"
        ]
      }
    ]
  }'

Responses

The product has been successfully created.

Bodyapplication/json
idstring

Unique identifier for the Product.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the Product was created.

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

Timestamp when the Product was last updated.

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

Company ID associated with the Product.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
namestring

Name of the product.

Example: "Sweet Tea"
productTypestring

Type of the product.

Example: "Beverages"
externalIdstring

External ID of the product.

Example: "1234567890"
descriptionstring

Description of the product.

Example: "Sweet Tea is a refreshing drink made with tea and sugar."
shortDescriptionstring

Short description of the product.

Example: "Sweet Tea is a drink with sugar."
skustring

SKU of the product.

Example: "1234567890"
fromFinalboolean

Flag to indicate if the Product is created from Oliver.

Example: false
imagesArray of strings

Images of the product.

Example: ["https://example.com/image1.jpg","https://example.com/image2.jpg"]
tagsArray of strings

Tags of the product.

Example: ["sweet","tea","refreshing"]
statusstring

Status of the product.

Example: "draft"
sourcestring

Source of the product.

Example: "woo-commerce"
minPricenumber

Min price of the product.

Example: 100
maxPricenumber

Max price of the product.

Example: 200
supplierstring

Supplier of the product.

Example: "Supplier 1"
taxTablestring

Tax table of the product.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
categoriesArray of strings

Categories of the product.

Example: ["o1p2q3r4s5t6u7v8w9x0y1z2","o1p2q3r4s5t6u7v8w9x0y1z3"]
outletsArray of strings

Outlets of the product.

Example: ["o1p2q3r4s5t6u7v8w9x0y1z2","o1p2q3r4s5t6u7v8w9x0y1z3"]
metadataArray of objects(MetadataDto)

Metadata associated with the Product.

Example: [{"key":"key1","value":"value1"},{"key":"key2","value":"value2"}]
attributesArray of objects(AttributeEmbeddedDto)

Attributes associated with the Product.

Example: [{"name":"color","values":["red","blue"]}]
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",
  "name": "Sweet Tea",
  "productType": "Beverages",
  "externalId": "1234567890",
  "description": "Sweet Tea is a refreshing drink made with tea and sugar.",
  "shortDescription": "Sweet Tea is a drink with sugar.",
  "sku": "1234567890",
  "fromFinal": false,
  "images": [
    "https://example.com/image1.jpg",
    "https://example.com/image2.jpg"
  ],
  "tags": [
    "sweet",
    "tea",
    "refreshing"
  ],
  "status": "draft",
  "source": "woo-commerce",
  "minPrice": 100,
  "maxPrice": 200,
  "supplier": "Supplier 1",
  "taxTable": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "categories": [
    "o1p2q3r4s5t6u7v8w9x0y1z2",
    "o1p2q3r4s5t6u7v8w9x0y1z3"
  ],
  "outlets": [
    "o1p2q3r4s5t6u7v8w9x0y1z2",
    "o1p2q3r4s5t6u7v8w9x0y1z3"
  ],
  "metadata": [
    { … },
    { … }
  ],
  "attributes": [
    { … }
  ]
}

Get a product by ID

Request

Retrieves a single product by its unique identifier.

Security
X-Api-Key
Path
idstringrequired

Product ID

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

Responses

The product has been successfully retrieved.

Bodyapplication/json
idstring

Unique identifier for the Product.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the Product was created.

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

Timestamp when the Product was last updated.

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

Company ID associated with the Product.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
namestring

Name of the product.

Example: "Sweet Tea"
productTypestring

Type of the product.

Example: "Beverages"
externalIdstring

External ID of the product.

Example: "1234567890"
descriptionstring

Description of the product.

Example: "Sweet Tea is a refreshing drink made with tea and sugar."
shortDescriptionstring

Short description of the product.

Example: "Sweet Tea is a drink with sugar."
skustring

SKU of the product.

Example: "1234567890"
fromFinalboolean

Flag to indicate if the Product is created from Oliver.

Example: false
imagesArray of strings

Images of the product.

Example: ["https://example.com/image1.jpg","https://example.com/image2.jpg"]
tagsArray of strings

Tags of the product.

Example: ["sweet","tea","refreshing"]
statusstring

Status of the product.

Example: "draft"
sourcestring

Source of the product.

Example: "woo-commerce"
minPricenumber

Min price of the product.

Example: 100
maxPricenumber

Max price of the product.

Example: 200
supplierstring

Supplier of the product.

Example: "Supplier 1"
taxTablestring

Tax table of the product.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
categoriesArray of strings

Categories of the product.

Example: ["o1p2q3r4s5t6u7v8w9x0y1z2","o1p2q3r4s5t6u7v8w9x0y1z3"]
outletsArray of strings

Outlets of the product.

Example: ["o1p2q3r4s5t6u7v8w9x0y1z2","o1p2q3r4s5t6u7v8w9x0y1z3"]
metadataArray of objects(MetadataDto)

Metadata associated with the Product.

Example: [{"key":"key1","value":"value1"},{"key":"key2","value":"value2"}]
attributesArray of objects(AttributeEmbeddedDto)

Attributes associated with the Product.

Example: [{"name":"color","values":["red","blue"]}]
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",
  "name": "Sweet Tea",
  "productType": "Beverages",
  "externalId": "1234567890",
  "description": "Sweet Tea is a refreshing drink made with tea and sugar.",
  "shortDescription": "Sweet Tea is a drink with sugar.",
  "sku": "1234567890",
  "fromFinal": false,
  "images": [
    "https://example.com/image1.jpg",
    "https://example.com/image2.jpg"
  ],
  "tags": [
    "sweet",
    "tea",
    "refreshing"
  ],
  "status": "draft",
  "source": "woo-commerce",
  "minPrice": 100,
  "maxPrice": 200,
  "supplier": "Supplier 1",
  "taxTable": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "categories": [
    "o1p2q3r4s5t6u7v8w9x0y1z2",
    "o1p2q3r4s5t6u7v8w9x0y1z3"
  ],
  "outlets": [
    "o1p2q3r4s5t6u7v8w9x0y1z2",
    "o1p2q3r4s5t6u7v8w9x0y1z3"
  ],
  "metadata": [
    { … },
    { … }
  ],
  "attributes": [
    { … }
  ]
}

Update a product by ID

Request

Updates an existing product record.

Security
X-Api-Key
Path
idstringrequired

Product ID

Bodyapplication/jsonrequired
namestring

Name of the product.

Example: "Sweet Tea"
productTypestring

Type of the product.

Example: "Beverages"
externalIdstring

External ID of the product.

Example: "1234567890"
descriptionstring

Description of the product.

Example: "Sweet Tea is a refreshing drink made with tea and sugar."
shortDescriptionstring

Short description of the product.

Example: "Sweet Tea is a drink with sugar."
skustring

SKU of the product.

Example: "1234567890"
imagesArray of strings

Images of the product.

Example: ["https://example.com/image1.jpg","https://example.com/image2.jpg"]
tagsArray of strings

Tags of the product.

Example: ["sweet","tea","refreshing"]
statusstring

Status of the product.

Example: "draft"
sourcestring

Source of the product.

Example: "woo-commerce"
minPricenumber

Min price of the product.

Example: 100
maxPricenumber

Max price of the product.

Example: 200
supplierstring

Supplier of the product.

Example: "Supplier 1"
taxTablestring

Tax table of the product.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
categoriesArray of strings

Categories of the product.

Example: ["o1p2q3r4s5t6u7v8w9x0y1z2","o1p2q3r4s5t6u7v8w9x0y1z3"]
outletsArray of strings

Outlets of the product.

Example: ["o1p2q3r4s5t6u7v8w9x0y1z2","o1p2q3r4s5t6u7v8w9x0y1z3"]
metadataArray of objects(MetadataDto)

Metadata associated with the Product.

Example: [{"key":"key1","value":"value1"},{"key":"key2","value":"value2"}]
attributesArray of objects(AttributeEmbeddedDto)

Attributes associated with the Product.

Example: [{"name":"color","values":["red","blue"]}]
curl -i -X PUT \
  'https://docs.finalpos.com/_mock/openapi/v1/api/product/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Sweet Tea",
    "productType": "Beverages",
    "externalId": "1234567890",
    "description": "Sweet Tea is a refreshing drink made with tea and sugar.",
    "shortDescription": "Sweet Tea is a drink with sugar.",
    "sku": "1234567890",
    "images": [
      "https://example.com/image1.jpg",
      "https://example.com/image2.jpg"
    ],
    "tags": [
      "sweet",
      "tea",
      "refreshing"
    ],
    "status": "draft",
    "source": "woo-commerce",
    "minPrice": 100,
    "maxPrice": 200,
    "supplier": "Supplier 1",
    "taxTable": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "categories": [
      "o1p2q3r4s5t6u7v8w9x0y1z2",
      "o1p2q3r4s5t6u7v8w9x0y1z3"
    ],
    "outlets": [
      "o1p2q3r4s5t6u7v8w9x0y1z2",
      "o1p2q3r4s5t6u7v8w9x0y1z3"
    ],
    "metadata": [
      {
        "key": "key1",
        "value": "value1"
      },
      {
        "key": "key2",
        "value": "value2"
      }
    ],
    "attributes": [
      {
        "name": "color",
        "values": [
          "red",
          "blue"
        ]
      }
    ]
  }'

Responses

The product has been successfully updated.

Bodyapplication/json
idstring

Unique identifier for the Product.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the Product was created.

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

Timestamp when the Product was last updated.

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

Company ID associated with the Product.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
namestring

Name of the product.

Example: "Sweet Tea"
productTypestring

Type of the product.

Example: "Beverages"
externalIdstring

External ID of the product.

Example: "1234567890"
descriptionstring

Description of the product.

Example: "Sweet Tea is a refreshing drink made with tea and sugar."
shortDescriptionstring

Short description of the product.

Example: "Sweet Tea is a drink with sugar."
skustring

SKU of the product.

Example: "1234567890"
fromFinalboolean

Flag to indicate if the Product is created from Oliver.

Example: false
imagesArray of strings

Images of the product.

Example: ["https://example.com/image1.jpg","https://example.com/image2.jpg"]
tagsArray of strings

Tags of the product.

Example: ["sweet","tea","refreshing"]
statusstring

Status of the product.

Example: "draft"
sourcestring

Source of the product.

Example: "woo-commerce"
minPricenumber

Min price of the product.

Example: 100
maxPricenumber

Max price of the product.

Example: 200
supplierstring

Supplier of the product.

Example: "Supplier 1"
taxTablestring

Tax table of the product.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
categoriesArray of strings

Categories of the product.

Example: ["o1p2q3r4s5t6u7v8w9x0y1z2","o1p2q3r4s5t6u7v8w9x0y1z3"]
outletsArray of strings

Outlets of the product.

Example: ["o1p2q3r4s5t6u7v8w9x0y1z2","o1p2q3r4s5t6u7v8w9x0y1z3"]
metadataArray of objects(MetadataDto)

Metadata associated with the Product.

Example: [{"key":"key1","value":"value1"},{"key":"key2","value":"value2"}]
attributesArray of objects(AttributeEmbeddedDto)

Attributes associated with the Product.

Example: [{"name":"color","values":["red","blue"]}]
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",
  "name": "Sweet Tea",
  "productType": "Beverages",
  "externalId": "1234567890",
  "description": "Sweet Tea is a refreshing drink made with tea and sugar.",
  "shortDescription": "Sweet Tea is a drink with sugar.",
  "sku": "1234567890",
  "fromFinal": false,
  "images": [
    "https://example.com/image1.jpg",
    "https://example.com/image2.jpg"
  ],
  "tags": [
    "sweet",
    "tea",
    "refreshing"
  ],
  "status": "draft",
  "source": "woo-commerce",
  "minPrice": 100,
  "maxPrice": 200,
  "supplier": "Supplier 1",
  "taxTable": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "categories": [
    "o1p2q3r4s5t6u7v8w9x0y1z2",
    "o1p2q3r4s5t6u7v8w9x0y1z3"
  ],
  "outlets": [
    "o1p2q3r4s5t6u7v8w9x0y1z2",
    "o1p2q3r4s5t6u7v8w9x0y1z3"
  ],
  "metadata": [
    { … },
    { … }
  ],
  "attributes": [
    { … }
  ]
}

Delete a product by ID

Request

Deletes a product by its unique identifier.

Security
X-Api-Key
Path
idstringrequired

Product ID

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

Responses

The product 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"
}

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