OverviewStores & Onboarding

Stores & Onboarding

A store is the unit everything else hangs off — products, orders, tokens, and installed apps all belong to exactly one store.

Onboarding stages

Store setup is split into four sequential stages, each its own endpoint:

  • Stage 1 — basics: name, description. Creates the store. See Create a store.
  • Stage 2— branding: favicon, black & white logo, coloured logo.
  • Stage 3— contact & address: mobile, landline, contact/support email, WhatsApp number, address, store region, GST number.
  • Stage 4 — social media URLs.

Call POST /v1/user/stores/:id/onboarding/complete once all stages are filled in to finalize the store.

Store lifecycle

Update any store field later with PUT /v1/user/stores/:id, or remove the store entirely with DELETE /v1/user/stores/:id.

Listing your stores

GET /v1/user/stores/@me lists every store the authenticated user owns. See List my stores.