Skip to content

Developers

Commerce primitives, exposed as REST.

Every catalog primitive — products, variants, collections, pages, inventory, media — flows through a tenant-scoped REST API at /api/v1. Bring any frontend stack; the backend stays the same.

API surfaces

Four route conventions, four trust levels.

Every route lives under /api/v1 with one of four prefixes. The prefix tells you who can call it and what credential they need.

/public/*

Public catalog reads

Tenant-scoped GETs for items, collections, pages, inventory, and availability. Resolve the tenant via the `x-organization-slug` header; no privileged credentials required.

/merchant/*

Authenticated merchant writes

Catalog CRUD, inventory mutations, media uploads, settings, audit reads. Requires a Bearer token tied to a merchant staff session + a tenant membership; role checks enforced server-side.

/platform/*

Internal platform admin

Tenant lifecycle, support tools, plan + billing visibility. Reserved for litecommerce staff — not exposed to tenants or their customers.

/webhooks/*Coming soon

Outbound events to tenant systems

Signed webhook payloads for order, payment, booking, subscription, inventory, and return events. Tenant-configurable endpoints with retry + replay.

Live today

Public endpoints you can call right now.

Tenant context resolves from the x-organization-slug header. The reference storefronts below consume these same routes — they're a working integration example.

MethodPathWhat it does
GET/public/itemsList active catalog items for a tenant.
GET/public/items/:slugFetch a single item by slug, with variants + media.
GET/public/collectionsList published collections.
GET/public/collections/:slug/itemsItems assigned to a collection, in display order.
GET/public/pagesPublished CMS pages for a tenant storefront.
GET/public/inventory/:itemIdOn-hand, reserved, and available stock per variant.
POST/public/availability/checkBulk availability check across a list of variant IDs.
POST/public/signupTenant signup intake (M1.5.1). Lands in operator review; auto-provisions when the canary flag flips.

Merchant + platform endpoints exist alongside these for authenticated writes — they're not listed here yet because the credential model (tenant API keys, scopes) is in flight. The full endpoint reference — rendered from the exported OpenAPI spec — is in the API reference; track what ships each week in the changelog.

Reference integrations

Two real storefronts, two stacks, one backend.

Both demos consume the same public API. Read their source for a concrete picture of what BYO frontend looks like in practice.

Build with your agent

Hand your coding agent the storefront skill.

Give Codex, Claude, or Cursor the litecommerce Storefront Skill and let it generate a tenant-scoped storefront against the same API that powers the demos above — correct route conventions, tenant context, and secret-handling baked in. It builds the full flow on the shipped public surface, including BYO checkout: server-priced checkout sessions with a Stripe Payment Element handoff. Hosted litecheckout pages ship separately and aren't live yet.

Developer experience

On the roadmap.

These are the developer-experience pieces in flight. Track what actually ships in the changelog.

Tenant API keys (public + secret)

Coming soon

Per-tenant publishable + secret keys with scopes, rotation, and revocation. Replaces the slug header for production use.

Outbound webhooks

Coming soon

Signed payloads, retry, replay, delivery logs. Configurable per tenant from merchant admin.

SDKs

Coming soon

TypeScript first. Auth + types + helpful errors. Then a Python client.

Get started

Spin up a tenant and start building.

Free tier while billing is in development. Sign up, get your tenant provisioned, point your frontend at the API.

Questions about the API model? sales@litecommerce.io