# Documentation - [Overview](/docs): OrbCommerce is four products for commerce that fit together and can be used one at a time. Pick a product, or follow a path through several. - Get started - [Run it locally](/docs/get-started): The catalog, OrbCart, OrbPage and the admin on your machine, seeded with the Clay & Crema demo shop, with one command. - [Your first product](/docs/get-started/first-product): From an empty admin to a product your shoppers can open, by the screens alone. - [OrbCart quickstart](/docs/get-started/orbcart): Run the reference shop on your machine in about ten minutes. Then buy something in five lines of code. - Work in the admin - [The catalog in the admin](/docs/admin/catalog): Design a Type, find and edit products, change many at once, keep the pictures and publish. - [Import a file](/docs/admin/import): Bring products in from a CSV, JSON Lines or Excel file, see what changes before it does, and undo it. - [AI Chat](/docs/admin/chat): Ask about the product you are looking at, read from your catalog as you, with your own Vercel AI Gateway key. How to turn it on, what leaves the admin, what it costs in dollars and what it may do. - [Admin languages](/docs/admin/languages): Choose the language the whole admin speaks, give your own screens words in it, and add a language. - [Bring your own screens into the admin](/docs/admin/your-own-module): Give a partner's work an area of its own in the OrbCommerce Admin, show it beside the Order it came from, and start it from the Order list, without touching OrbCart's screens. - [Move your screens to the admin's design system](/docs/admin/design-system): What changed in @orbcommerce/ui, how an old part becomes a new one, the rules a screen of your own follows, and how to check it with the audit. - Integrate - **The catalog** - [Sync from a PIM or ERP](/docs/integrate/catalog-sources): A Source sends products, categories, register entries, offers and stock; each row is judged on its own. - [Follow the catalog's changes](/docs/integrate/catalog-changes): The change feed for exports and anything that wants increments, and signed webhooks. - **OrbSearch** - [OrbSearch's engine ↗](https://orbsearch.dev/docs) - **OrbCart** - [Offers](/docs/integrate/offers): The one function OrbCart needs from you. Your systems know the goods; offers tells OrbCart. - [Stock & ERP hand-off](/docs/integrate/inventory): Limit purchases to what you can ship, hold it during checkout, and hand every Order to your ERP. - [Contracts in another system](/docs/integrate/remote-contracts): Let your ERP, a Laravel shop or another Worker answer offers, stock, tax and order handoff, over HTTP or a Service Binding. - [Prices and stock from your ERP](/docs/integrate/erp-prices-and-stock): Answer OrbCart's offers and inventory contracts from an ERP over HTTP, with one request per call, parsed answers and a reservation that never sells the last unit twice. - [Send paid Orders to your ERP](/docs/integrate/erp-order-handoff): Hand every paid Order to your ERP exactly once, keep OrbCart's Line IDs there, and report shipments back so the buyer's order page shows the tracking. - [Order events](/docs/integrate/order-events): Tell your systems what happened to an Order and to the purchase before it, such as a confirmation to send or a payment to book. - [Orders & refunds](/docs/integrate/orders-and-refunds): Read Orders, give money back and report shipments from your backend. - [Run your own actions on an Order](/docs/integrate/order-actions): Give your support team a parcel label, a resent confirmation or a handoff to a branch in the Order's menu, with your code doing the work and the outcome in the Order's history. - [Sending the buyer's emails](/docs/integrate/buyer-emails): Confirm Orders, tell buyers a payment did not go through and follow up on a Cart, from your own mail system and OrbCart's events. - [Tax](/docs/integrate/tax): Pick one tax source per Channel. Use the EU's daily rates, or bring your own amounts. - [Signed-in buyers](/docs/integrate/identity): Use your shop's existing login. OrbCart keeps no accounts; it trusts your ID tokens. - Build a shop - **Products** - [Read the catalog](/docs/shop/catalog): Product, category and brand pages, a store finder, free times and the mini cart, with @orbcatalog/client. - **Content** - [Declare sections and slots](/docs/shop/sections): Your shop says which sections editors build pages from and where they go. Editors build templates and pages from them in the admin. - [Read the content](/docs/shop/content): How OrbPage's pages, menus and previews reach the shop, typed by its own sections, and what the shop does when a read fails. - **Carts and checkout** - [Configuration](/docs/shop/configuration): One defineCommerce call describes your whole shop. Markets, shipping, payments and your systems. - [Carts](/docs/shop/carts): Add goods, change quantities and keep the buyer's place across reloads and devices. - [Quotes & payments](/docs/shop/quotes): Show the exact total, collect the payment and turn the purchase into an Order. - [The order page](/docs/shop/order-page): Give every buyer, guests included, their order from any device through a secret link, without an account. - [The withdrawal function](/docs/shop/withdrawal): Let every shopper withdraw from an order in two steps, with the law's labels, without an account. - [Shipping](/docs/shop/shipping): Declare delivery and store pickup, with prices and authoritative Catalog Locations. - [Discounts](/docs/shop/discounts): Codes, automatic promotions, free shipping, batches of single-use codes and redemption limits. Made by your team in the admin. - [Gift cards](/docs/shop/gift-cards): Sell gift cards as products, let your team make them, and set how their codes look and how long they last. - [Extensions](/docs/shop/extensions): Your own typed fields on a Line or the Cart. An engraving, a gift message, a configurator's choices. - [React checkout](/docs/shop/react-checkout): Your Cart in, an Order out. One component for the last step of the purchase. - **Payments** - [Payment providers](/docs/shop/payments): Map each payment method to a provider. Swap a provider by changing one word. - [A payment provider of your own](/docs/shop/payment-provider): Bring a provider OrbCart does not ship. One module in your Worker and one line in defineCommerce. - [Express checkout](/docs/shop/express-checkout): Apple Pay, Google Pay, PayPal and Amazon Pay buttons right in the bag. - [Test payments](/docs/shop/test-payments): Cards, accounts and passwords that work in each provider's sandbox. - **Recipes** - [Recipes](/docs/shop/recipes): Complete, copyable code for the tasks shops build first, from an add-to-cart button to a test that buys something. - [Add to cart and a mini cart](/docs/shop/add-to-cart): An add-to-cart button for your product pages and a bag in the header that shows the server's Lines and total. - [A checkout without React](/docs/shop/checkout-without-react): Your own checkout page in plain TypeScript, with the checkout store of @orbcart/client. Details, the binding total, a card field and every outcome of the order button. - [A checkout with a page per step](/docs/shop/checkout-steps): Contact, delivery and payment each on their own address, with the browser's back button, a reload and the provider's return all landing on the right step. - [Free shipping and a welcome code](/docs/shop/free-shipping-and-codes): Free standard shipping from €50 without a code, 10 % off with WELCOME10, a code field in the bag, and a test that proves both. - [A gift message, end to end](/docs/shop/gift-message): Declare a gift message once, let the buyer write it in checkout, and print it on the packing slip. Checked on the server, kept in the Quote and frozen in the Order. - [Test a purchase](/docs/shop/test-a-purchase): A Vitest test that buys a backpack against your real Worker, pays with a card through a fake Stripe, reads the Order back and proves a double click buys once. - **Go further** - [AI agents](/docs/shop/agents): Let shopping agents check out in your shop over UCP and follow their orders. The buyer agrees on your checkout, or in their agent's app with AP2. - [Extend OrbCart](/docs/shop/extend): Every place your code plugs into OrbCart, from one line of configuration to a package of your own, and what cannot be extended yet. - [Testing](/docs/shop/testing): Test real purchases against your own Worker, in Vitest, without a network. - Run it - [The test environment](/docs/run/test-environment): Every product, the admin and Nordgrat's shop on Cloudflare, seeded, with one command. - [Connect the products](/docs/run/connect-the-products): Point OrbPage, OrbCart and OrbSearch at the catalog, with the variables, secrets and calls each needs. - [Deployment](/docs/run/deployment): Deploy a test environment to your Cloudflare account, step by step. - OrbCatalog - [OrbCatalog](/docs/catalog): 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. - **Concepts** - [Concepts](/docs/catalog/concepts): OrbCatalog's seven nouns, from Type to Channel, and the shape of a stored Product. - **Your systems** - [Private media storage](/docs/catalog/media-storage): Use one existing private R2 or S3-compatible store without changing the media library. - **AI agents** - [Agents](/docs/catalog/agents): What an agent can read from the catalog over MCP, how it proposes a change that a person approves, the scopes that open it and how to connect a client. - **Reference** - [HTTP API](/docs/catalog/http-api): Every public read of the catalog, how long each is cached and what purges it. - OrbSearch - [OrbSearch](/docs/search): OrbSearch finds products in your catalog, understands the query and explains every result. What it does, what it leaves to you and where to start. - OrbPage - [OrbPage](/docs/page): OrbPage holds what editors write about your products, built from the sections your shop declares. What it does, what it leaves to you and where to start. - **Your systems** - [Write content from code](/docs/page/write-content): Seed or import OrbPage pages and menus from a script. Sign in, write and publish a body, mint ids, use library pictures and pass the audit. - OrbCart - [OrbCart](/docs/cart): OrbCart runs the purchase, from Cart to Order, and asks your systems for prices and stock. What it does, what it leaves to you and where to start. - [What makes OrbCart different](/docs/cart/why-orbcart): What OrbCart is, what it is not, and how its approach compares with the other ways to take an order online. - **Concepts** - [Concepts](/docs/cart/concepts): The mental model of OrbCart. Who owns what, the words of a purchase, and why it is shaped this way. - [How it works](/docs/cart/how-it-works): Follow one purchase from cart.add to the Order in your ERP, and see what OrbCart does when something goes wrong. - [Security](/docs/cart/security): The trust model of OrbCart, what each key and token opens, what is not built yet, and what to check before you go live. - **Storefront** - [Track storefront events](/docs/cart/storefront-events): Send cart and checkout events to Google Tag Manager or your own analytics receiver. - **Reference** - [SDKs & tools](/docs/cart/sdks): Which package for which job, and which key goes where. - [CLI](/docs/cart/cli): The orbcart command. Local development, keys and tax rates. - [HTTP API](/docs/cart/http-api): Call OrbCart from any language. Keys, headers, the endpoints you call and how retries work. - [Errors](/docs/cart/errors): Every error code, what caused it and what to do next. - **Project** - [Project status](/docs/cart/status): What works today, what is being built and what comes next.