# 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:

```ts title="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](/docs/get-started/first-product) takes you from an empty admin to a product shoppers can open.

## What OrbCatalog does

- **Shapes products by Type.** You design [Types](/docs/catalog/concepts) 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](/docs/catalog/concepts) 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](/docs/admin/catalog) 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](/docs/integrate/catalog-sources). The fields a Source owns are read-only in the panel. A [file import](/docs/admin/import) reads CSV, JSON Lines or Excel.
- **Tells your systems what changed.** A [change feed](/docs/integrate/catalog-changes) serves exports and anything else that wants increments, and each change can go out as a signed webhook.
- **Answers AI agents.** An [agent](/docs/catalog/agents) reads the catalog over MCP and proposes changes that a person approves in the admin.

## What OrbCatalog leaves to you

| OrbCatalog does not                  | Who does                                                                             |
| ------------------------------------ | ------------------------------------------------------------------------------------ |
| Take orders or payments              | OrbCart. A catalog price is a hint; OrbCart's [Quote](/docs/cart/concepts#quote) decides. |
| Search and rank products             | OrbSearch, from the catalog's feed.                                                  |
| Hold pages and stories               | OrbPage, which shows the catalog's products in its content.                          |
| Price per customer or customer group | Not possible today.                                                                  |
| Count stock in several places        | Not possible today. A SKU has one count, shared by every Channel.                    |
| Run approval workflows or sync back  | Not possible today.                                                                  |

## Change what you need

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

| Depth     | You                                                | Example                                                                                                     |
| --------- | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| Configure | Design Types and set languages and Channels.       | [A Type with a unit price](/docs/admin/catalog#unit-prices), [storefront paths](/docs/shop/catalog#storefront-paths). |
| Compose   | Let a Source own some fields and editors the rest. | [Sync from a PIM or ERP](/docs/integrate/catalog-sources).                                                       |
| Replace   | Put your own storage behind the media library.     | [Your private R2 or S3 store](/docs/catalog/media-storage).                                                      |

## 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](/docs/run/connect-the-products) shows the configuration.

## Next steps

| You want to                | Read                                                 |
| -------------------------- | ---------------------------------------------------- |
| Publish a first product    | [Your first product](/docs/get-started/first-product)     |
| Understand the model       | [Concepts](/docs/catalog/concepts)                        |
| Keep products in the admin | [The catalog in the admin](/docs/admin/catalog)           |
| Build the storefront side  | [Read the catalog](/docs/shop/catalog)                    |
| Connect your PIM or ERP    | [Sync from a PIM or ERP](/docs/integrate/catalog-sources) |
| Look up a route            | [HTTP API](/docs/catalog/http-api)                        |