LithosPOS platform APIs
The LithosPOS platform API lets your software read and write a merchant’s point-of-sale data: items and menus, stock and purchasing, customers, online orders, taxes and sales reporting. Your application authenticates as itself — not as a staff user — and every call is scoped to one merchant company, which authorizes your app through an OAuth consent screen or, for ADSR, by approving an access request.
Pick a product
Section titled “Pick a product”Access is packaged as three products. An app declares its product when you create it, and that choice is permanent — it fixes the scope bundle the token carries.
How access works
Section titled “How access works”- Register a developer account and verify your email address.
- Apply to the developer program (a short NDA application) and sign the developer agreement.
- Create an organization and an app inside it. The app is issued a sandbox credential immediately.
- Provision a sandbox merchant — a real, isolated demo company you can write to freely.
- Mint a token with your sandbox client credentials and call the API.
- Submit for review when you are ready for production merchants.
- Let merchants connect you — through the OAuth consent screen, or an ADSR access request they approve.
Steps 1–5 take a few minutes once your program application is approved. Start with the getting started walkthrough.
Base URLs
Section titled “Base URLs”| Surface | URL | Purpose |
|---|---|---|
| Partner API | https://api.lithospos.com/v1 | Every merchant data operation |
| OAuth token endpoint | https://api.lithospos.com/v1/oauth/token | Exchange an authorization code or refresh token for an access token |
| OAuth authorize | https://my.lithospos.com/oauth/authorize | Where you send a merchant to approve your app |
| Sandbox token endpoint | https://api.lithospos.com/v1/token | Client-credentials quickstart, sandbox only |
One host serves every merchant. LithosPOS runs regional clusters (UK, US, India, UAE) and a merchant’s data lives in exactly one of them, but the gateway reads the region from your token and routes each request to the right origin — you never address a cluster directly.
Take the base URL from api_base_url in the token response rather than hard-coding it. It
is the contract, and reading it is what keeps your integration working across failover and
self-hosted topologies.
Conventions
Section titled “Conventions”- Envelope — successful partner responses return
{ "data": … }, with{ "meta": { "page", "limit", "total" } }added on list endpoints. - Errors — every failure carries a stable machine-readable
code. Branch oncode, never onmessage: messages are translated to the caller’s locale. - Localisation — send
Accept-Languageand response messages come back in that language. - Money and quantities — decimals are JSON numbers in the merchant’s own currency; there is no minor-unit conversion.
- Dates —
YYYY-MM-DDfor report windows, ISO 8601 timestamps everywhere else.