OpenAPI

The API Reference on this site is generated directly from a reviewed OpenAPI 3.0 document - the same one is also available as raw files, for tooling that wants to consume it directly (code generators, API clients, linters, or a coding agent that prefers a machine-readable source over parsed HTML):

• /openapi.json
• /openapi.yaml

What’s in it, and what isn’t

This document describes only the approved /v1 surface documented throughout this site - Products, Categories, Promotions, and Inventory Stock. It does not include, and is built with an explicit allow-list boundary to guarantee it never accidentally includes, any of EPOS’s internal (unversioned) API. If you’re scripting against this document, you can trust that every path in it is part of the public contract.

How it’s produced

Code and schema decorators are the source of truth - the document is generated deterministically from the API’s own implementation (npm run generate:openapi in the main EPOS repository), not hand-written, and not editable independently of the code it describes. See this repository’s internal docs/developer-platform/phase-2-openapi.md for the generation architecture (that document is engineering-internal, not part of this public site).

Custom scope extension

Each operation’s required scope is documented as an x-epos-scopes vendor extension on that operation - this is deliberately not modeled as OAuth2 scopes, since this API doesn’t use OAuth2. See Scopes Overview.