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

API surfaces and who can call them.

These common surfaces live under /api/v1. Each endpoint defines its own authentication, tenant context and permissions; the prefix alone is not its security contract.

/public/*

Public catalog reads

Catalog reads use x-organization-slug to identify the tenant without privileged credentials. Other public routes have their own context: signup intake is organization-agnostic, while checkout/action routes use their documented tokens and guards.

/merchant/*

Merchant operations

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.

/customer/*

Customer accounts and actions

Profiles, order history and supported customer actions use customer sessions or action tokens, with their documented tenant and permission boundaries. These are separate from staff credentials.

/storefront/*Scoped access

Server-to-server storefront access

Storefront reads require a tenant API key with the storefront:read scope. Send it as x-api-key from your server. The key determines tenant context and endpoint rate limits apply.

/import/*Scoped access

Scoped import integrations

Catalog and content import endpoints require a server-side API key with the applicable import scope. The platform grants import write scopes. Guided migration remains on the roadmap.

/platform/*

Internal platform admin

Tenant management and operational reads for authorized litecommerce staff. Platform authority is separate from merchant and customer access.

/webhooks/*

Inbound provider callbacks

Payment-provider callbacks consumed by litecommerce infrastructure. This is not a tenant event-delivery API; outbound tenant webhooks remain unscheduled.

Live today

Public endpoints you can call right now.

Public catalog examples use the x-organization-slug header. Signup intake is organization-agnostic. Server-to-server routes resolve tenant context from an issued API key instead.

Public API examples, request methods and descriptions
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/:itemIdPublicly eligible inventory rows for an item, including on-hand, reserved and available quantities.
POST/public/availability/checkDate-range availability for one item and an optional variant.

Scroll horizontally to read every column.

Merchant + platform endpoints exist alongside these for authenticated writes and use their current session/role contracts. Server-to-server storefront and import access already uses issued, scoped API keys kept on your backend. Self-service key management and richer developer tooling remain in development. The full endpoint reference — rendered from the exported OpenAPI spec — is in the API reference. Read the API versioning and deprecation policy for the compatibility and notice contract. Track what ships each week in the changelog.

Reference integrations

Real customer storefronts. One backend.

These customer storefronts consume the same public API. Explore them 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 use its guide to install the complete skill and reference files. It guides storefront development against the documented routes, tenant context and server-side credential boundaries, including server-priced BYO checkout sessions and payment handoff. Hosted litecheckout is also live as an optional checkout and customer account surface alongside your own storefront.

Developer experience

On the roadmap.

This scoped developer-platform work is sourced from the feature manifest. Track what actually ships in the changelog.

Self-Service API Key Management and Developer Tooling

In active development

Build on the existing server-side API-key access with self-service key management, richer scopes, examples and supported SDKs. These tools remain in development; API keys stay server-side.

Early access

Want a tenant now?

Request access and, once approved, we'll provision your tenant on Free — then walk you through the API and your storefront options.

Free includes the full platform within its usage limits.