Appearance
Adore API documentation
Documentation of the Adore e-shop backend API for the shopfront, the admin and integrations.
| Part | What it contains | Where |
|---|---|---|
| API reference | Endpoints, parameters, request and response schemas (OpenAPI 3.1) | /reference/ · raw spec /openapi.yaml |
| API conventions | Base URLs, headers, auth, embed, only, filters, pagination, errors | API conventions |
| Guides | Multi-step flows: which requests to combine and how to read the results | Stock availability |
For AI assistants and tools
- The OpenAPI spec is the source of truth for endpoints and shapes:
docs/openapi/adore-api.yamlin the repository, served as/openapi.yaml. - The guides are plain Markdown in
docs/guides/and can be read directly.