Skip to Content

ORBCATALOG DOCUMENTATION

OrbCatalog

OrbCatalog keeps your products, prices and stock and serves them to your storefronts. What it does, what it leaves to you and where to start.

OrbCatalog is the product database of a shop: Types, Products, Variants, Categories and Offers. Editors keep them in the admin, a PIM or ERP sends them, and storefronts read what is published through a CDN. One Postgres, one API, a CDN in front.

A category page's product cards, each with its price in the German shop, are one call:

src/product-cards.ts
import { catalog } from "@orbcatalog/client";

export async function productCards(url: string) {
  const shop = catalog({ url });
  return shop.products({ category: "outdoor/rucksaecke", locale: "de", channel: "de" });
}

Each card carries its localized slug and, because the call names a channel, the offer of its cheapest orderable variant. Your first product takes you from an empty admin to a product shoppers can open.

What OrbCatalog does

  • Shapes products by Type. You design Types in the admin and publish them as one Schema. The Schema becomes the validators, the grid's columns, the filter indexes and the OpenAPI description.
  • Publishes per language and on time. German can go live today and English next week. A version scheduled for Friday 09:00 is served from 09:00, and nothing has to run at 09:00.
  • Keeps prices as a ledger. An Offer is one SKU's price and availability in one Channel. An ERP and the panel write prices side by side, and a sale that starts at 12:00 is live at 12:00 without a purge.
  • Edits at scale. The grid is designed for catalogs of 2,000,000 products, filters as you type and changes many products at once, with a preview and Undo.
  • Takes products from your systems. A PIM or ERP sends products, categories, offers and stock as a Source. The fields a Source owns are read-only in the panel. A file import reads CSV, JSON Lines or Excel.
  • Tells your systems what changed. A change feed serves exports and anything else that wants increments, and each change can go out as a signed webhook.
  • Answers AI agents. An agent reads the catalog over MCP and proposes changes that a person approves in the admin.

What OrbCatalog leaves to you

OrbCatalog does notWho does
Take orders or paymentsOrbCart. A catalog price is a hint; OrbCart's Quote decides.
Search and rank productsOrbSearch, from the catalog's feed.
Hold pages and storiesOrbPage, which shows the catalog's products in its content.
Price per customer or customer groupNot possible today.
Count stock in several placesNot possible today. A SKU has one count, shared by every Channel.
Run approval workflows or sync backNot possible today.

Change what you need

Everything in OrbCatalog changes in one of three ways, from shallow to deep.

DepthYouExample
ConfigureDesign Types and set languages and Channels.A Type with a unit price, storefront paths.
ComposeLet a Source own some fields and editors the rest.Sync from a PIM or ERP.
ReplacePut your own storage behind the media library.Your private R2 or S3 store.

With OrbCart, OrbPage and OrbSearch

OrbCatalog needs none of its siblings. Each sibling you run reads the catalog through configuration, not code of yours:

  • OrbCart borrows offers and stock through its contracts, and hears at once when a price moves.
  • OrbPage shows products on its pages as cards, without prices.
  • OrbSearch imports the catalog's feed, and a price change reaches it in seconds.

Connect the products shows the configuration.

Next steps

You want toRead
Publish a first productYour first product
Understand the modelConcepts
Keep products in the adminThe catalog in the admin
Build the storefront sideRead the catalog
Connect your PIM or ERPSync from a PIM or ERP
Look up a routeHTTP API

On this page