N1 APIDemo shop

GUIDE

Quickstart in 5 minutes

Sign in to a demo shop, run a query, page through a list and handle an error.

  1. Start Core with the demo shops: pnpm i && pnpm db:migrate && pnpm db:seed, then N1_DEV_AUTH=stub DOCS_ORIGINS=http://localhost:4321 pnpm dev. Check GET /readyz answers {"status":"ready"}.
  2. Get a token for demo shop A: see Demo shop.
  3. Ask who you are with session: paste the token in the panel and press Run.
  4. Page through a list. Lists use first and after, and return totalCount and pageInfo.endCursor. See Response handling. Shop modules such as customers ship with their own pages in this explorer.
  5. Handle an error. Remove the token and run again: you get UNAUTHENTICATED with a requestId. Branch on the code. See Errors.
Each new operation arrives with its own page here, generated from the same schema Core runs, so this explorer never describes something the server does not do.