Appearance
Availability
Availability is always a coarse band - never a raw on-hand count. This holds everywhere stock is surfaced: catalog reads, the dedicated availability endpoints, and stock.changed webhook events.
| Band | Meaning |
|---|---|
IN_STOCK | Comfortably available |
LOW | Limited quantity - running short |
OUT | Currently unavailable |
| lead-time | Out of stock now, with an expected availability ETA |
Coarse bands keep a merchant's exact inventory position private while still telling a shopper what they need to know to buy.
Reading availability
Availability rides along on catalog reads, and there are dedicated endpoints for a single SKU or a batch:
bash
# A single SKU:
curl -s "https://api.harmon.example/v1/products/SKU-123/availability" \
-H "Authorization: Bearer hk_test_pub_your_key_here"
# → {"sku":"SKU-123","band":"LOW"}
# A batch in one call:
curl -s -X POST "https://api.harmon.example/v1/availability/batch" \
-H "Authorization: Bearer hk_test_pub_your_key_here" \
-H "Content-Type: application/json" \
-d '{"skus":["SKU-123","SKU-456"]}'Next steps
- Pagination & caching - keep availability fresh with
updated_since. - API Reference - the availability operations in full.
In the API Reference
POST /v1/availability/batch- coarse bands for many SKUs in one call