Documentation you can read before signing up
The developer docs are public: a quickstart, embed blocks, storefront sections, webhooks, schedules, OAuth, GraphQL and the direct API. An API reference with Postman and OpenAPI exports is there for developers given access.
Build your first app in ten minutes
Order nowQuickstart (remote)
Webhooks · verify X-App-Signature
GraphQL · orders(first: 5)
Schedules · [[schedules]]
In short
The developer documentation at /custom-app/development-docs is public and covers the remote quickstart, embed blocks, storefront sections, webhooks, schedules, OAuth, GraphQL and the direct API. An API reference with Postman and OpenAPI exports is available to signed in accounts with API docs access.
The problem it solves
A platform whose docs sit behind a sales call is one nobody evaluates. Developers want to read how auth and webhooks work before they commit a weekend to it.
How it works
4 steps, start to finish
-
1
Start with the quickstart
Build a remote app and install it on a store you own.
-
2
Read the guides
Embed blocks, storefront sections, webhooks, schedules and OAuth, each with examples.
-
3
Query the API
GraphQL and the direct API, with the scope each call needs.
-
4
Import the reference
Download the Postman collection or OpenAPI file when you have API docs access.
In detail
What developer docs does for you
-
Public
No sign in needed to read the developer docs.
-
Quickstart
A remote app from nothing to installed.
-
Webhooks and hooks
Events, signatures, retries and the hook catalogue.
-
GraphQL
Queries, mutations and scopes for app tokens.
-
Postman and OpenAPI
Exports of the API reference for your own tools.
-
No. The developer documentation is public.
-
It is served with Postman and OpenAPI exports to signed in accounts that have been given API docs access.
-
Yes. The MCP server has its own public development docs, generated from the registered tools.
Developer docs · Free to start
Try developer docs on your own business
Set up in a couple of minutes. Your catalogue, orders and books stay yours to export.
- Live in 2 minutes
- Free to start
- No credit card