API Reference
SovEcom exposes its REST API over three surfaces. Each is documented endpoint-by-endpoint in its own section, generated directly from the OpenAPI specification so it never drifts from the running API.
Sections
Section titled “Sections”- Admin API — authenticated store-management endpoints under
/admin/v1. Admin JWT (access + refresh). - Store API — storefront endpoints under
/store/v1. Public reads; a customer session token for cart and account. - Setup & Platform API — first-run setup wizard, health, and file-serving endpoints.
Conventions
Section titled “Conventions”- Money — integer minor units (cents) plus a separate currency code. Never floats.
- Timestamps — ISO 8601, UTC.
- Single resource —
{ "data": { … } }. Collections —{ "data": [ … ], "meta": { … } }. Errors —{ "error": { "code", "message", "details" } }. - Versioning — breaking changes only at a major version bump; deprecated endpoints stay for at least 12 months after notice.
Raw specification
Section titled “Raw specification”The machine-readable OpenAPI document is served at /admin/v1/openapi.json, with interactive Swagger UI at /admin/v1/docs. Generate a typed client from it with @sovecom/client-js.
Last updated: 2026-06-25