API Reference

The complete, interactive contract for the Harmon Storefront API - every operation, parameter, and schema, with a built-in Try it console. It is generated from the published OpenAPI document (the single source of truth), so it never drifts from what the API actually serves.

New here? Start with the Quickstart for your first call in five minutes, then the Guides for auth, sandbox vs live, errors, rate limits, caching, and availability.

The Try it console below is pre-loaded with a sandbox key (hk_test_…), so you can fire GET /v1/products right now without setup - it can never touch live data. Ready for your own merchant? Mint a key and paste it in:

→ Get your API keys

Download & integrate

Prefer to work from the raw contract or generate a client? Everything is downloadable - the spec is the single source of truth, so these never drift from what the API serves:

• OpenAPI - openapi.json · openapi.yaml
• Postman - postman.json (import straight into Postman)

Building with an AI assistant? The whole portal is LLM-native: point it at llms.txt (an index of every page) or llms-full.txt (the entire docs as one Markdown file), and use the Copy page as Markdown button on any page.

Loading the interactive API reference… If it doesn’t appear, the machine-readable contract is the published OpenAPI document at https://api.harmon.example/openapi.json. Start with the Quickstart and the Guides.