# Harmon Storefront API

> Build your own ecommerce storefront on Harmon - the public, machine-authenticated commerce API for merchants.

Developer documentation for the Harmon Storefront API. This index points an assistant (or a human) at every page and its purpose; the full text of the whole portal is available as one file under Optional.

## Get started

- [Harmon Storefront API](https://developers.joelxhenry.com/): New here? Start with the Quickstart - your first API call in five minutes -
- [Quickstart](https://developers.joelxhenry.com/quickstart): Your first API call in five minutes: get a key, confirm it's wired, then read

## Guides

- [Guides](https://developers.joelxhenry.com/guides/): The Harmon Storefront API is a public, machine-authenticated read + commerce
- [Authentication & keys](https://developers.joelxhenry.com/guides/authentication): Every request carries a merchant-scoped API key as a bearer token:
- [Availability](https://developers.joelxhenry.com/guides/availability): Availability is always a coarse band - never a raw on-hand count. This holds
- [Errors](https://developers.joelxhenry.com/guides/errors): Read endpoints degrade section by section rather than failing the whole
- [Pagination & caching](https://developers.joelxhenry.com/guides/pagination-and-caching): Anonymous catalog reads (GET /v1/products, /v1/products/{sku},
- [Rate limits](https://developers.joelxhenry.com/guides/rate-limits): Each key is rate-limited per minute. Bursting past the limit returns 429
- [Sandbox vs live](https://developers.joelxhenry.com/guides/sandbox-vs-live): A key minted with the hk_test_ prefix runs in sandbox mode; every other
- [Generate an SDK](https://developers.joelxhenry.com/guides/sdk-generation): The OpenAPI contract is the single source of truth for this API, so you
- [Verify webhook signatures](https://developers.joelxhenry.com/guides/webhook-signatures): Every outbound webhook Harmon POSTs to your endpoint carries three headers:

## API Reference

- [API Reference](https://developers.joelxhenry.com/reference): The complete, interactive contract for the Harmon Storefront API - every

## Recipes

- [Recipes](https://developers.joelxhenry.com/recipes/): Copy-paste cookbook for the most common storefront integrations. Each recipe is a
- [Cart → COD checkout](https://developers.joelxhenry.com/recipes/cart-cod-checkout): Place a real order: create a cart, add lines, re-price it, then check out on the
- [Customer-priced catalog with a shopper token](https://developers.joelxhenry.com/recipes/customer-priced-catalog): Anonymous catalog reads show list content, but a B2B shopper expects their
- [Keep a local catalog fresh with `updated_since`](https://developers.joelxhenry.com/recipes/local-catalog-updated-since): A headless storefront or a search index wants a local mirror of the catalog,
- [Render a product grid](https://developers.joelxhenry.com/recipes/product-grid): Build a browsable storefront grid from the public catalog - a page of products,
- [Verify a webhook](https://developers.joelxhenry.com/recipes/verify-webhook): React to events - order.confirmed, invoice.issued, stock.changed,

## Changelog

- [Changelog](https://developers.joelxhenry.com/changelog): What's new in the Harmon Storefront API and this developer portal. The API is at

## Reference & downloads

- [OpenAPI specification (JSON)](https://developers.joelxhenry.com/openapi.json): The complete machine-readable API contract - the single source of truth.
- [OpenAPI specification (YAML)](https://developers.joelxhenry.com/openapi.yaml): The same contract, as YAML.
- [Postman collection](https://developers.joelxhenry.com/postman.json): An importable Postman collection generated from the spec.

## Optional

- [Full documentation (single Markdown file)](https://developers.joelxhenry.com/llms-full.txt): Every page concatenated for one-fetch ingestion.