The three things you get
- An API key, issued by the merchant from their own dashboard, scoped to their store and nothing else.
- A GraphQL API for the catalogue, orders, customers and stock.
- Outbound webhooks, HMAC-signed, delivered with retries.
What does not exist yet
There is no app marketplace. You cannot register an OAuth application, there is no per-store install flow, and there is no listing merchants browse. An integration today is something a specific merchant asks you to build and gives you a key for.
If you are planning work that depends on installing across many stores at once, plan for one key per store. That is the model today, and building around it is cheap; building around a marketplace that does not exist is not.
Getting started
- Sign up for a free store of your own — that is your sandbox. It takes under a minute and you can delete it.
- Add demo products from Settings → Developer, so you have something to read.
- Place one test order on your own storefront — it takes half a minute and fires the order.placed webhook you are probably building against.
- Issue an API key and call the API (see Authentication).
- Register a webhook endpoint and verify a delivery (see Webhooks).
We deliberately do not run a shared sandbox store. A shared one drifts, fills up with other developers’ test data, and needs published credentials to a real account. Your own free store is cleaner, and you can throw it away.