Admin overview
Admin is the merchant control centre. Staff manage catalogue, inventory, orders, customers, discounts, reports, and settings. It authenticates with session cookies — not shop API keys.
Admin pages
Home, Products, Orders, Customers, Analytics, Discounts, Reports
Admin settings
Store, POS, shipping, taxes, DOT.com, users, API credentials
Two navigation states
Admin uses a two-state sidebar. Day-to-day work lives in the main nav (Home, Products, Orders, …). Opening Settings switches to a settings sidebar with a “Back to Admin” control. Items appear based on plan modules (POS / ecommerce / trial), staff permissions, and feature flags.
| Shop home | /admin/shops/[shopId] |
|---|---|
| Settings hub | /admin/shops/[shopId]/settings |
| API credentials | …/settings/api |
| Local Admin | http://localhost:3000 |
What Admin owns
Products and variants, inventory and purchase orders, omnichannel orders (view / fulfill / refund / cancel when allowed), customers and segments, discounts and gift cards, analytics, POS receipt and hardware settings, taxes, shipping, billing, staff roles, and developer API credentials.
Integrating with Admin data
External apps should use the Merchant API rather than scraping Admin. Example — sync catalogue and orders:
GET /api/v1/{shopId}/products
GET /api/v1/{shopId}/orders
GET /api/v1/{shopId}/customersPermissions vs API scopes
Staff roles gate Admin screens. API keys use scopes instead (read_products, write_orders, …). Creating keys requires Settings permission on the shop.
Cancel rules