CommerceOS developer documentation

Commerce as a wire format, not a walled garden.

CommerceOS is a headless commerce platform: a public storefront API, framework SDKs, and a theme format that treats designs as data. Every sample below is taken from the same contracts the platform itself runs on.

wire · your first exchange

# storefronts talk to CommerceOS over one wire format▸ GET /storefront/v1/products?limit=2▸ X-Publishable-Key: pk_live_9f2…◂ 200 OK · application/json{  "items": [    {      "id": "ad9b7bd4-14dd-4d9f-966d-4224bdb9d652",      "title": "Classic Cotton Tee",      "image": "https://cdn…/tee.webp",      "priceAmount": 79900,      "currency": "INR"    }  ],  "nextCursor": "eyJjcmVhdGVkQXQi…"}# money is integer minor units, always with its currency

first request

Getting started

Create a publishable key and get live catalog data on screen in five minutes.

reference

Storefront API

Products, collections, content, regions, carts, checkout, and search over /storefront/v1.

react · vue · svelte · astro

SDKs

One typed core client with thin idiomatic bindings — the same contracts everywhere.

themes

Themes & .cos

Ship a static framework build as a versioned, immutable theme package.

integrate

Events & webhooks

Ten domain events, HMAC-signed deliveries, exactly-once processing on your side.

content

Content & regions

Merchant-editable block trees your storefront renders safely with any SDK.