Developer docs

Ship a storefront on the StoreOS API

Catalog, auth, checkout, orders, payments, and delivery — over REST, GraphQL, and typed SDKs. Bring your own framework.

REST: /v1
GraphQL: /graphql
SDK: @storeos/storefront-client

app/page.tsx

import { StoreFront } from "@storeos/storefront-client";

const store = new StoreFront({
  tenant: process.env.TENANT!,
});

const { nodes } = await store.getProducts({ limit: 3 });

200 OKGET /v1/products42 ms

{ "nodes": [
  { "id": "prd_8f2c", "name": "Linen overshirt", "price": 2490 }
] }

Getting started

Create your app, install the SDK, configure your tenant, and make your first API request.

Start building

REST API

HTTP routes for catalog, auth, checkout, and orders — with Swagger reference.

Explore REST API

GraphQL API

Queries and mutations for catalog, auth, checkout, and orders over GraphQL.

Explore GraphQL

TypeScript SDK

Typed REST client for products, orders, auth, and checkout.

Use the SDK

React SDK

Providers, hooks, cart, and GraphQL helpers for React and Next.js.

Use React SDK

Plugins

Couriers, payments, notifications, analytics, and chat widgets — and how to read them from your storefront.

Browse plugins

TypeScript SDK

Accelerate development with the SDK

Install @storeos/storefront-client and connect your storefront to StoreOS in minutes.

Typed catalog, auth, and checkout methods
Tenant UID and auth headers handled for you
Works with Next.js, Remix, or any JS framework

bun add @storeos/storefront-client

Quick start

Connect your storefront

Three steps from environment variables to a live product catalog. Works with Next.js, Remix, or any framework that can call the SDK.

Set your tenant

Add your store's tenant UID to .env.local. You'll get this from the StoreOS console after onboarding.

.env.local

NEXT_PUBLIC_SITE_API_TENANT=your-tenant-uid
NEXT_PUBLIC_SITE_URL=http://localhost:3000

Create your store client

Instantiate StoreFront once and reuse it across pages — auth headers and tenant scoping are handled for you.

lib/store.ts

import { StoreFront } from "@storeos/storefront-client";

export const store = new StoreFront({
  tenant: process.env.NEXT_PUBLIC_SITE_API_TENANT!,
});

Fetch your catalog

Drop the SDK into an existing page. The highlighted lines are all you need to load products — the rest is your UI.

app/page.tsx

import { store } from "@/lib/store";

export default async function CatalogPage() {
  const { nodes: products } = await store.getProducts({
    limit: 24,
  });

  return (
    <main>
      <h1>Products</h1>
      <ul>
        {products.map((product) => (
          <li key={product.id}>{product.name}</li>
        ))}
      </ul>
    </main>
  );
}

Full getting started guide→

Next step

Launch your storefront

Read the introduction to understand the architecture, or jump straight into the interactive API reference.

Introduction

Understand StoreOS, the API, and how your storefront fits in.

Open

API reference

Interactive Swagger docs for every StoreOS endpoint.

Open