Developer documentation

Overview What you can build on the platform, which approach suits which problem, and where to start. Your First Request From nothing to a working call in five minutes, and what to check when it does not work. Authentication Issuing a token, the abilities it carries, how requests are authenticated, and what the failures mean. Errors and Conventions Status codes, error shapes, how money and dates are represented, and the conventions worth knowing before you start.

Products and Categories Listing and reading products, filtering and sorting, pagination, and what the response contains. Orders Reading orders, creating one, the two status fields, the snapshot principle, and what to do when a request times out. Cart Building a basket from outside the shop, the token that holds it together, and handing the shopper to checkout. Inventory Reading stock levels, adjusting them, and the rollup that will overwrite your writes if you ignore it. Webhooks Subscribing to events, verifying a message came from the shop, handling retries, and what not to assume.

Building a Theme Directory layout, the manifest, template resolution, every variable and function available, and what you must handle. Template Reference Every template a theme can provide, what each receives, and what happens when you leave one out. Functions Available in Templates The functions a theme can call, grouped by what they are for, with the ones that matter most called out.

Building an App What an app can do, the App API, permissions, and installing into a shop. The App API Every endpoint an installed app can call, how it authenticates, and what each one is for. Building an App, Step by Step A worked example from an empty directory to an installed app, with the decisions explained at each step. Publishing and Updating Getting a theme or an app reviewed and listed, what the review looks at, and releasing a new version without breaking shops.