Documentation
RetailLink for developers
Map of Admin, POS, Storefront, and the Merchant API — screens, auth, objects, and copy-ready snippets.
Getting started
API keys, auth, and your first request
A–Z index
Every Admin and POS page, alphabetically
Admin overview
Back office roles, nav states, and integration notes
Admin pages
Home through reports — every main sidebar link
Admin settings
Settings hub A–Z: store, POS, shipping, DOT.com, API
POS overview
Till app, register URL, plans, and data sync
POS screens
Routes, till modes, menus, and hardware dialogs
Storefront
Online store, themes, domains, checkout
Merchant API
REST resources, scopes, plan limits
Objects
product, variant, order, customer, and more
Authentication
API keys, sessions, and storefront auth
Webhooks
Event delivery and signature verification
How the platform fits together
Admin is the merchant back office. POS is the till. Storefront is the customer shop. All three share the same shop data. External apps should use Merchant API keys — not scrape Admin sessions.
API access by plan
Starter has no API access. Growth unlocks read-only keys and limited webhooks. Enterprise (and active trial) unlock write scopes and higher limits. Create credentials in Admin → Settings → API credentials.
Local ports
:3000 · POS :3002 · API :3003 · Storefront :3004 · Website :3005 · Docs :3006