Overview
Commerce Suite stores products, orders, and loyalty accounts. Public umk_* REST is read-only (commerce:read). JWT Growth still allows creates/updates for dashboard flows.
| Item | Value |
|---|---|
| Service | Commerce |
| Permissions | commerce:read |
| Key example | umk_live_commerce_<8>_<secret> |
| Dashboard UI | Dashboard → Email Suites |
| JWT Growth API | /api/growth/… (see below) |
| Public umk_* REST | Live — see public API table |
| Markdown | /developers/commerce.md |
Public /v1/commerce/* is live and read-only. Do not invent public write scopes. JWT Growth can POST products/orders/loyalty.
Get started
- Enable Commerce in Dashboard → Billing.
- Open Dashboard → Email Suites for the product tab UI.
- Create an API token for Commerce with permission commerce:read.
- Store the secret server-side only (Cloudflare-style least privilege).
- Use JWT /api/growth/* for dashboard session flows; public /v1/* paths when documented as Live.
API tokens (Cloudflare-style)
Authorization: Bearer umk_live_commerce_<8>_<secret>
Scope: commerce:read — Read orders and catalog data on the public Commerce API
Guide: /developers/api-tokensConcepts
| Resource | Description |
|---|---|
| Product | Catalog item (name, sku, priceCents) |
| Order | Order snapshot for support context |
| Loyalty account | Loyalty balance/identity by customerRef |
| Statistics | Suite aggregates |
Dashboard Growth API (JWT — available now)
Tenant JWT under /api/growth/*. Generic PATCH|DELETE /api/growth/:suite/:resource/:id also applies for some resources. Check GET /api/growth/entitlements for access.
| Method | Path | Purpose |
|---|---|---|
| GET|POST | /api/growth/commerce/products | Products |
| GET|POST | /api/growth/commerce/orders | Orders |
| GET|POST | /api/growth/commerce/loyalty | Loyalty |
| GET | /api/growth/commerce/statistics | Stats |
Public API contract
| Method | Path | Scope | Status |
|---|---|---|---|
| GET | /v1/commerce/products | commerce:read | Live |
| GET | /v1/commerce/products/{id} | commerce:read | Live |
| GET | /v1/commerce/orders | commerce:read | Live |
| GET | /v1/commerce/orders/{id} | commerce:read | Live |
| GET | /v1/commerce/loyalty | commerce:read | Live |
| GET | /v1/commerce/loyalty/{id} | commerce:read | Live |
| GET | /v1/commerce/statistics | commerce:read | Live |
Do not invent URLs. Public handlers ship without changing your key model.
Agent recipe
# Enable Commerce → create token (commerce:read)
# Today: JWT /api/growth/… listed above
# Public: paths in the contract table
# Read /developers/commerce.md before answering
# See also Live Chat + Business Email complete docs