Quickstart
Get an API key, make your first authenticated request, and handle the common error cases - in about five minutes. Start here.
EPOS Developer API
Read-only, versioned, scoped access to catalog, promotions and inventory data for approved EPOS integrations.
This is the developer documentation for the EPOS Developer API - a versioned, read-only /v1
surface separate from EPOS’s internal system, built specifically for approved external
integrations. Access requires an Integration API key issued to an approved
IntegrationClient, scoped to exactly the data it needs.
Authentication
How Integration API keys work, how to store them, and how rotation/revocation behave. Read the auth guide.
API Reference
Every /v1 route, generated directly from the reviewed OpenAPI contract - methods, scopes,
parameters, schemas, examples. Browse the reference.
Scopes
Exactly what each scope grants, and nothing more. See the scope reference.
What’s available today
Section titled “What’s available today”| Area | Routes | Scope |
|---|---|---|
| Products | GET /v1/catalog/products, GET /v1/catalog/products/{id} | catalog.products.read |
| Categories | GET /v1/catalog/categories | catalog.categories.read |
| Promotions | GET /v1/catalog/promotions | catalog.promotions.read |
| Inventory stock | GET /v1/inventory/stock | inventory.stock.read |
Everything is read-only today. There are no write endpoints, no webhooks, and no plugin runtime - see Events & Webhooks and Plugins for current status.
Environments
Section titled “Environments”- Development:
https://dev-api.theprioryshop.co.uk- for building and testing integrations. - Production:
https://api.theprioryshop.co.uk- exists, but the production developer API is not publicly launched until owner approval. Don’t assume a production key is available on request yet; see Environments.