Skip to content

Adore API documentation ​

Documentation of the Adore e-shop backend API for the shopfront, the admin and integrations.

PartWhat it containsWhere
API referenceEndpoints, parameters, request and response schemas (OpenAPI 3.1)/reference/ · raw spec /openapi.yaml
API conventionsBase URLs, headers, auth, embed, only, filters, pagination, errorsAPI conventions
GuidesMulti-step flows: which requests to combine and how to read the resultsStock availability

For AI assistants and tools ​

  • The OpenAPI spec is the source of truth for endpoints and shapes: docs/openapi/adore-api.yaml in the repository, served as /openapi.yaml.
  • The guides are plain Markdown in docs/guides/ and can be read directly.