Skip to content
Last updated

Getting Started

The Final POS Public API lets you programmatically manage the core resources that power your point-of-sale system — products, customers, orders, taxes, outlets, and more.

Base URL

All requests are made against a single base URL:

https://api.finalpos.com

Request & Response Format

  • Content type: application/json for both requests and responses.
  • Character encoding: UTF-8.

API Structure

The API is organized into three areas (paths use your deployment’s API prefix, e.g. /v1 or /v1/api):

AreaConventionExample
CRUDSingular endpoints for single-record operations (create, read, update, delete).POST …/customer, GET …/customer/{id}
BulkPlural endpoints for multi-record operations (bulk create, list, bulk update, bulk delete).POST …/customers, GET …/customers
WorkflowsMulti-step operations composed across domains; all live under …/workflows/<segment>.POST …/workflows/outlet-product, GET …/workflows/tax/by-tax-rate/{taxRateId}

Next Steps

  • Authentication — Create an API key and learn how permissions work.
  • API Reference — Browse all available endpoints grouped by domain.