Introduction
The EPOS Developer API is a versioned, read-only, scoped HTTP API for external systems that need to read catalog, promotion and inventory data from an EPOS store - loyalty apps, price comparison tools, stock dashboards, marketing sites, or internal reporting for a partner.
Every route lives under /v1/. This is a deliberate boundary: EPOS also has a much larger internal
API used by the Back Office and the Point of Sale applications, but that internal API is not
documented here, is not stable, and is not available to integrations. If a route isn’t in
the API Reference, it isn’t part of this contract - don’t rely on it, and don’t
guess at internal routes from other EPOS documentation you may come across.
Who this is for
Section titled “Who this is for”- A developer building or maintaining an integration for a store using EPOS.
- A coding agent (Claude Code, Codex, or similar) implementing that integration on a developer’s behalf - this documentation is written to be unambiguous for both audiences. Every endpoint’s method, required scope, parameters, and response shape are stated explicitly rather than implied.
What you can do today
Section titled “What you can do today”Read products, categories, customer-facing promotions, and exact inventory stock levels, filtered
by store and scoped to exactly the data your IntegrationClient has been granted. See
What’s available today on the home page for the full route list.
What you can’t do (yet)
Section titled “What you can’t do (yet)”- Write anything. Every route is
GET. There is no way to create, update or delete data through this API. - Receive events. There are no webhooks. See Events & Webhooks.
- Install a plugin. There is no plugin runtime or marketplace. See Plugins.
- Authenticate as a user. This API uses static Integration API keys, not OAuth2 and not a staff login. See Authentication.
How this documentation is organized
Section titled “How this documentation is organized”- Getting Started - this section. Read Quickstart next.
- Authentication - how API keys work, and how to keep them safe.
- API - conceptual, per-resource guides (what a product/category/promotion/stock row means).
- API Reference - the exact, generated contract: every route, parameter, and schema.
- Scopes - what each permission grants.
- Errors, Request IDs, Rate Limits - the shared contract every route follows.
- Integrations - practical guides for common integration patterns (catalog sync, inventory sync).
- Modules and Plugins - how EPOS itself is extended internally, and why that’s different from a public plugin system.
- Examples - runnable-shaped snippets in five languages.
- Reference - the raw OpenAPI document and a changelog.