Build on the real
NOPOS API contract

This page is the launchpad. The full reference lives in the developer portal and is generated from the live endpoint catalog, so your docs, AI context, and client generation all point at the same source of truth.

Open Developer PortalDownload AGENTS.md
First smoke test
X-API-Key
curl -s https://nopos.vercel.app/v1/auth/verify \
  -H "X-API-Key: $NOPOS_API_KEY"
Base URL
https://nopos.vercel.app/v1
Auth header
X-API-Key
Live endpoints
383
Endpoint groups
65

Developer resources that do real work

Jump into the hosted portal, generate a typed client from OpenAPI, or give your AI coding tool the same generated context the portal uses.

Developer portal

The hosted reference, dashboard entry point, and API feature-request flow.

Open resource →

Vibecode guide

Point Cursor, Claude Code, Codex, Windsurf, v0, or Lovable at NOPOS.

Open resource →

AGENTS.md

Full AI coding-tool context generated from the live endpoint catalog.

Open resource →

llms.txt

A compact discovery index for agents and crawlers.

Open resource →

OpenAPI JSON

Machine-readable request and response shapes for typed client generation.

Open resource →

Swagger UI

Browse and test the public REST surface from a hosted API explorer.

Open resource →

Code against REST directly

There is no published NoPOS npm SDK. Keep API keys server-side, call the REST API directly, or generate a client from OpenAPI.

const NOPOS_BASE_URL = "https://nopos.vercel.app/v1";

async function nopos<T>(path: string, init: RequestInit = {}): Promise<T> {
  const res = await fetch(`${NOPOS_BASE_URL}${path}`, {
    ...init,
    headers: {
      "X-API-Key": process.env.NOPOS_API_KEY!,
      "content-type": "application/json",
      ...init.headers,
    },
  });

  if (!res.ok) {
    const body = await res.json().catch(() => ({}));
    throw new Error(body.error ?? body.message ?? `NOPOS ${res.status}`);
  }

  return res.json() as Promise<T>;
}

Starter workflows

These are practical first flows for custom POS, service, booking, and clinical front ends.

See platform capabilities →

Verify a key

GET /v1/auth/verify

Confirm the key works and resolve the store_id before building deeper flows.

Browse catalog

GET /v1/products

Load sellable products for retail, service, and checkout interfaces.

Find customers

GET /v1/customers/search

Search existing buyers, clients, patients, or members from the canonical customer record.

Create orders

POST /v1/orders

Persist line items and checkout state before taking payment.

Take payment

POST /v1/payments

Capture payment against the order or booking workflow.

Create bookings

POST /v1/bookings

Power appointment, reservation, service, and clinical scheduling front ends.

Prompts that start from truth

Drop the generated context into a project, then ask for one specific workflow instead of asking an AI tool to invent the backend shape.

Build a product grid that lists GET /v1/products, lets me add items to a cart, and creates an order with POST /v1/orders.
Add a checkout screen that takes payment via POST /v1/payments and shows the receipt.
Build a customer lookup using GET /v1/customers/search with create-on-the-fly via POST /v1/customers.
Make a booking screen: pick a service, find the next available slot, and create a booking.
Wire every NOPOS call through a server route so the API key never reaches the browser.