Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
---
title: "Spree Commerce documentation: open-source commerce platform"
description: "Spree is the open-source commerce platform that fits the systems you already run — connect your ERP, PIM, WMS and payment stack instead of replacing them."
sidebarTitle: "Overview"
icon: "house"
mode: "wide"
---
{/* ── Primitives ─────────────────────────────────────────────────────────── */}
export const Icon = ({ children, className = "" }) => (
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24"
fill="none" stroke="currentColor" strokeWidth="1.75" strokeLinecap="round" strokeLinejoin="round"
className={className}>
{children}
</svg>
);
export const Eyebrow = ({ children }) => (
<div className="font-mono text-xs uppercase tracking-[0.14em] text-[#999999] dark:text-zinc-500 mb-3">
{children}
</div>
);
export const SectionTitle = ({ children }) => (
<h2 className="text-3xl sm:text-4xl font-semibold tracking-tight text-[#061932] dark:text-zinc-50 m-0">
{children}
</h2>
);
export const Lede = ({ children }) => (
<p className="mt-3 text-base text-[#666666] dark:text-zinc-400 leading-relaxed m-0">{children}</p>
);
export const Section = ({ children, className = "" }) => (
<section className={`border-t border-[#e9e5dd]/80 dark:border-[#3f3e3c] ${className}`}>
<div className="py-12">{children}</div>
</section>
);
{/* Big clickable card — the whole surface is the link. */}
export const Card = ({ href, icon, title, children, footer }) => (
<a href={href}
className="home-plain group flex flex-col rounded-2xl border border-[#e2dfd8] dark:border-[#3f3e3c] bg-[#f7f5f2] dark:bg-[#272626] p-7 no-underline transition-colors hover:border-[#d5d5d5] dark:hover:border-[#565351] hover:bg-[#f2efea] dark:hover:bg-[#2e2c2c]">
<div className="flex items-center gap-3">
{icon && (
<span className="flex items-center justify-center w-9 h-9 rounded-lg bg-white dark:bg-[#3f3e3c] text-[#4d4d4d] dark:text-zinc-300 shrink-0">
{icon}
</span>
)}
<h3 className="text-lg font-semibold text-[#061932] dark:text-zinc-50 m-0">{title}</h3>
</div>
<p className="mt-3 text-sm text-[#666666] dark:text-zinc-400 leading-relaxed m-0">{children}</p>
{footer}
</a>
);
{/* Numbered step list inside a learning-path card. */}
export const Steps = ({ items }) => (
<ol className="mt-5 pt-5 border-t border-[#e9e5dd] dark:border-[#3f3e3c] list-none p-0 m-0 space-y-2.5">
{items.map((label, i) => (
<li key={label} className="flex items-center gap-3 m-0">
<span className="flex items-center justify-center w-5 h-5 shrink-0 rounded-full bg-white dark:bg-[#3f3e3c] text-[11px] font-medium text-[#666666] dark:text-zinc-400">
{i + 1}
</span>
<span className="text-sm text-[#4d4d4d] dark:text-zinc-300">{label}</span>
</li>
))}
</ol>
);
{/* Pill link — used for the "How do I…?" question list. */}
export const Pill = ({ href, children }) => (
<a href={href}
className="home-plain group inline-flex items-center rounded-lg border border-[#e2dfd8] dark:border-[#3f3e3c] bg-[#f7f5f2] dark:bg-[#272626] px-3.5 py-2 font-mono text-[13px] no-underline transition-colors hover:border-[#b3b3b3] dark:hover:border-[#5f5c59]">
<span className="text-[#4d4d4d] dark:text-zinc-300 group-hover:text-[#061932] dark:group-hover:text-zinc-100">{children}</span>
</a>
);
{/* Compact concept link — icon, topic and a one-line descriptor. */}
export const ConceptLink = ({ href, title, icon, children }) => (
<a href={href}
className="home-plain group flex gap-3.5 rounded-xl px-4 py-3.5 no-underline transition-colors hover:bg-[#f7f5f2] dark:hover:bg-[#32302e]/60">
<span className="mt-0.5 flex items-center justify-center w-8 h-8 shrink-0 rounded-lg bg-[#f2efea] dark:bg-[#3f3e3c] text-[#4d4d4d] dark:text-zinc-300 transition-colors group-hover:bg-white dark:group-hover:bg-[#4a4846]">
<Icon className="w-[18px] h-[18px]">{icon}</Icon>
</span>
<span className="block min-w-0">
<span className="inline-flex items-center gap-1.5 text-[15px] font-semibold text-[#061932] dark:text-zinc-50">
{title}
<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2"
strokeLinecap="round" strokeLinejoin="round"
className="opacity-0 -translate-x-1 transition-all group-hover:opacity-100 group-hover:translate-x-0">
<path d="M5 12h14" /><path d="m12 5 7 7-7 7" />
</svg>
</span>
<span className="block mt-1 text-sm text-[#666666] dark:text-zinc-400 leading-relaxed">{children}</span>
</span>
</a>
);
{/* Group heading inside the concept grid — spans the full grid width. */}
export const ConceptGroup = ({ children }) => (
<div className="col-span-full mt-10 first:mt-0 mb-1 px-4">
<h3 className="font-mono text-xs uppercase tracking-[0.14em] text-[#999999] dark:text-zinc-500 m-0">{children}</h3>
</div>
);
export const CopyBox = ({ label, command }) => {
const [copied, setCopied] = useState(false);
return (
<div>
<div className="font-mono text-xs uppercase tracking-[0.14em] text-[#999999] dark:text-zinc-500 mb-2">{label}</div>
<button
onClick={() => { navigator.clipboard.writeText(command); setCopied(true); setTimeout(() => setCopied(false), 2000); }}
className="group/copy flex w-full items-center justify-between gap-4 rounded-xl border border-[#e2dfd8] dark:border-[#3f3e3c] bg-[#f7f5f2] dark:bg-[#272626] px-4 py-3.5 text-left cursor-pointer transition-colors hover:border-[#d5d5d5] dark:hover:border-[#565351]">
<span className="font-mono text-[13px] leading-relaxed text-[#1a1a1a] dark:text-zinc-200 break-all">{command}</span>
<span className="shrink-0 text-[#999999] group-hover/copy:text-[#666666] dark:group-hover/copy:text-zinc-300">
{copied
? <svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="#22c55e" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round"><path d="M20 6 9 17l-5-5" /></svg>
: <svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round"><rect width="14" height="14" x="8" y="8" rx="2" ry="2" /><path d="M4 16c-1.1 0-2-.9-2-2V4c0-1.1.9-2 2-2h10c1.1 0 2 .9 2 2" /></svg>}
</span>
</button>
</div>
);
};
{/* ── Page ───────────────────────────────────────────────────────────────── */}
<div className="home-page not-prose w-full">
{/* HERO */}
<section>
<div className="pt-2 pb-12 sm:pb-16">
<div className="max-w-3xl">
<h1 className="text-4xl sm:text-6xl font-semibold tracking-tight text-[#061932] dark:text-zinc-50 m-0 leading-[1.05]">
Build commerce the way you want it
</h1>
<p className="mt-6 text-lg sm:text-xl text-[#666666] dark:text-zinc-400 leading-relaxed m-0">
From Omnichannel and cross-border DTC, to complex B2B commerce workflows, to marketplaces and subscription services. Spree gives you battle-tested commerce primitives and unlimited flexibility to build the commerce experience your business needs.
</p>
<div className="mt-8 flex flex-wrap items-center gap-3">
<a href="/developer/getting-started/quickstart"
className="home-plain inline-flex items-center gap-2 rounded-xl bg-[#0077ff] hover:bg-[#0060ce] px-6 py-3.5 text-base font-medium no-underline transition-colors">
<span className="text-white">Get started</span>
<Icon className="w-4 h-4 text-white"><path d="M5 12h14" /><path d="m12 5 7 7-7 7" /></Icon>
</a>
<a href="https://console.spree.sh"
className="inline-flex items-center gap-2 rounded-xl border border-[#d5d5d5] dark:border-[#4a4846] px-6 py-3.5 text-base font-medium text-[#1a1a1a] dark:text-zinc-200 no-underline transition-colors hover:border-[#b3b3b3] dark:hover:border-[#5f5c59]">
Try a free sandbox
<Icon className="w-4 h-4"><path d="M7 7h10v10" /><path d="M7 17 17 7" /></Icon>
</a>
</div>
<div className="mt-8 max-w-xl">
<CopyBox label="Quick Install" command="npx create-spree-app@latest my-store" />
</div>
</div>
</div>
</section>
{/* LEARNING PATHS */}
<Section>
<Eyebrow>Learning paths</Eyebrow>
<SectionTitle>Start where you are</SectionTitle>
<div className="mt-10 grid md:grid-cols-3 gap-5">
<Card href="/developer/storefront/nextjs/quickstart"
icon={<Icon><path d="m2 7 4.41-4.41A2 2 0 0 1 7.83 2h8.34a2 2 0 0 1 1.42.59L22 7" /><path d="M4 12v8a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2v-8" /><rect width="20" height="5" x="2" y="7" /></Icon>}
title="Build a storefront"
footer={<Steps items={["Set up the TypeScript SDK", "Fetch products and build a cart", "Take a payment at checkout", "Deploy the Next.js starter"]} />}>
Use the Store API to power any frontend — Next.js, a mobile app, or your own stack.
</Card>
<Card href="/developer/tutorial/introduction"
icon={<Icon><path d="M12 3H5a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2v-7" /><path d="M18.4 2.6a1 1 0 0 1 3 3l-9 9a2 2 0 0 1-.9.5l-2.9.9a.5.5 0 0 1-.6-.6l.8-2.9a2 2 0 0 1 .5-.9z" /></Icon>}
title="Extend the platform"
footer={<Steps items={["Model a custom resource", "Add an Admin API endpoint", "Build a dashboard plugin", "Expose it on the storefront"]} />}>
Add your own models, endpoints and admin screens without forking the core.
</Card>
<Card href="/developer/core-concepts/architecture"
icon={<Icon><circle cx="12" cy="12" r="10" /><path d="M12 2a14.5 14.5 0 0 0 0 20 14.5 14.5 0 0 0 0-20" /><path d="M2 12h20" /></Icon>}
title="Evaluate Spree"
footer={<Steps items={["Read the architecture overview", "See how it fits your systems", "Review deployment options", "Plan your upgrade path"]} />}>
Assess the architecture, the integration story and what running it in production takes.
</Card>
</div>
</Section>
{/* CORE CONCEPTS */}
<Section>
<Eyebrow>Core concepts</Eyebrow>
<SectionTitle>Commerce Primitives</SectionTitle>
<Lede>
Every piece of the platform, in the order you meet it — from the store that holds your data to
the extension points you build on.
</Lede>
<div className="mt-8 grid sm:grid-cols-2 lg:grid-cols-3 gap-x-6 gap-y-1 -mx-4">
<ConceptGroup>Platform</ConceptGroup>
<ConceptLink href="/developer/core-concepts/stores" title="Stores"
icon={<><path d="m2 7 4.41-4.41A2 2 0 0 1 7.83 2h8.34a2 2 0 0 1 1.42.59L22 7" /><path d="M4 12v8a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2v-8" /><path d="M2 7h20v5H2z" /></>}>
The top-level container for all commerce data, including products, orders and customers.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/channels" title="Channels"
icon={<><rect width="20" height="14" x="2" y="3" rx="2" /><path d="M8 21h8" /><path d="M12 17v4" /></>}>
Omnichannel selling — web, mobile, point of sale, marketplace and wholesale.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/markets" title="Markets"
icon={<><circle cx="12" cy="12" r="10" /><path d="M12 2a14.5 14.5 0 0 0 0 20 14.5 14.5 0 0 0 0-20" /><path d="M2 12h20" /></>}>
Sell across regions, each with its own currency, locale and tax treatment.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/customers" title="Customers"
icon={<><path d="M19 21v-2a4 4 0 0 0-4-4H9a4 4 0 0 0-4 4v2" /><circle cx="12" cy="7" r="4" /></>}>
Accounts, authentication, addresses, order history and guest checkout.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/data-privacy" title="Data privacy"
icon={<><path d="M20 13c0 5-3.5 7.5-7.66 8.95a1 1 0 0 1-.67-.01C7.5 20.5 4 18 4 13V6a1 1 0 0 1 1-1c2 0 4.5-1.2 6.24-2.72a1.17 1.17 0 0 1 1.52 0C14.51 3.81 17 5 19 5a1 1 0 0 1 1 1z" /><path d="m9 12 2 2 4-4" /></>}>
GDPR subject requests, consent records, EU Omnibus price history and the right of withdrawal.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/companies" title="Companies"
icon={<><path d="M3 21h18" /><path d="M5 21V7l8-4v18" /><path d="M19 21V11l-6-4" /><path d="M9 9h.01" /><path d="M9 13h.01" /><path d="M9 17h.01" /></>}>
B2B buyers as organizations — divisions, employees, shared addresses and VAT compliance.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/sellers" title="Sellers"
icon={<><path d="M2 9h20l-1.5-4.5A2 2 0 0 0 18.6 3H5.4a2 2 0 0 0-1.9 1.5z" /><path d="M4 9v10a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9" /><path d="M9 13h6" /></>}>
Running a marketplace — vendors with their own catalog and panel, and orders split per seller.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/staff-roles" title="Staff & roles"
icon={<><path d="M16 21v-2a4 4 0 0 0-4-4H6a4 4 0 0 0-4 4v2" /><circle cx="9" cy="7" r="4" /><path d="M22 21v-2a4 4 0 0 0-3-3.87" /><path d="M16 3.13a4 4 0 0 1 0 7.75" /></>}>
Admin users, invitations and role-based permissions scoped per store.
</ConceptLink>
<ConceptGroup>Catalog</ConceptGroup>
<ConceptLink href="/developer/core-concepts/products" title="Products"
icon={<><path d="m7.5 4.27 9 5.15" /><path d="M21 8a2 2 0 0 0-1-1.73l-7-4a2 2 0 0 0-2 0l-7 4A2 2 0 0 0 3 8v8a2 2 0 0 0 1 1.73l7 4a2 2 0 0 0 2 0l7-4A2 2 0 0 0 21 16z" /><path d="m3.3 7 8.7 5 8.7-5" /><path d="M12 22V12" /></>}>
Variants, option types, categories, collections and product types.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/pricing" title="Pricing"
icon={<><path d="M12 2v20" /><path d="M17 5H9.5a3.5 3.5 0 0 0 0 7h5a3.5 3.5 0 0 1 0 7H6" /></>}>
Price lists, price rules and the pricing context behind regional, wholesale and volume pricing.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/catalogs" title="Catalogs"
icon={<><path d="M4 19.5v-15A2.5 2.5 0 0 1 6.5 2H19a1 1 0 0 1 1 1v18a1 1 0 0 1-1 1H6.5a1 1 0 0 1 0-5H20" /></>}>
Show different products and prices to different audiences — a wholesale range or one company's terms.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/inventory" title="Inventory"
icon={<><path d="M3 21V8l9-5 9 5v13" /><path d="M3 21h18" /><rect width="6" height="6" x="9" y="15" /><path d="M9 12h6" /></>}>
Stock across locations — what is on hand, what is spoken for, and what a shopper can buy.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/media" title="Media"
icon={<><rect width="18" height="18" x="3" y="3" rx="2" /><circle cx="9" cy="9" r="2" /><path d="m21 15-3.09-3.09a2 2 0 0 0-2.82 0L6 21" /></>}>
The store-wide library — upload once and reuse everywhere, with focal points and automatic resizing.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/search-filtering" title="Search & filtering"
icon={<><circle cx="11" cy="11" r="8" /><path d="m21 21-4.3-4.3" /></>}>
Query parameters to search, filter, sort and paginate any resource through the API.
</ConceptLink>
<ConceptGroup>Cart & checkout</ConceptGroup>
<ConceptLink href="/developer/core-concepts/carts" title="Carts"
icon={<><circle cx="8" cy="21" r="1" /><circle cx="19" cy="21" r="1" /><path d="M2.05 2.05h2l2.66 12.42a2 2 0 0 0 2 1.58h9.78a2 2 0 0 0 1.95-1.57l1.65-7.43H5.12" /></>}>
The shopping and checkout phase — a cart collects items and details, then becomes an order.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/orders" title="Orders"
icon={<><path d="M15 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V7z" /><path d="M14 2v5h5" /><path d="M9 13h6" /><path d="M9 17h4" /></>}>
The permanent record of a completed cart, with separate payment and delivery statuses.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/order-totals" title="Order totals"
icon={<><path d="M4 2v20l2-1.5L8 22l2-1.5L12 22l2-1.5L16 22l2-1.5L20 22V2l-2 1.5L16 2l-2 1.5L12 2l-2 1.5L8 2 6 3.5z" /><path d="M8 7h8" /><path d="M8 11h8" /><path d="M8 16h8" /></>}>
How a total is built from items, tax, discounts, delivery and fees — and how to render a summary that adds up.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/payments" title="Payments"
icon={<><rect width="20" height="14" x="2" y="5" rx="2" /><path d="M2 10h20" /></>}>
Payment methods, sessions, saved cards and refunds that finish reliably even when a tab closes.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/taxes" title="Taxes"
icon={<><path d="M9 14 4 9l5-5" /><path d="M4 9h11a5 5 0 0 1 5 5v6" /><path d="m15 9 5 5" /></>}>
Tax categories and rates, inclusive versus added-on pricing, and connecting an external tax service.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/discounts" title="Discounts"
icon={<><path d="m15 9-6 6" /><path d="M9 9h.01" /><path d="M15 15h.01" /><circle cx="12" cy="12" r="10" /></>}>
The record of money taken off an order, and why it is spread across the items it applied to.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/fees" title="Fees"
icon={<><circle cx="12" cy="12" r="10" /><path d="M12 8v8" /><path d="M8 12h8" /></>}>
Surcharges added to an order — handling, gift wrap, cash on delivery — and cross-border customs duties.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/commissions" title="Commissions"
icon={<><path d="M3 3v16a2 2 0 0 0 2 2h16" /><path d="m19 9-5 5-4-4-3 3" /></>}>
What a marketplace charges its sellers — rates, the rules that target them, and the settlement record.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/promotions" title="Promotions"
icon={<><path d="M20.59 13.41 13.42 20.6a2 2 0 0 1-2.83 0L2 12V2h10l8.59 8.59a2 2 0 0 1 0 2.82" /><path d="M7 7h.01" /></>}>
Percentage and fixed discounts, free shipping, BOGO offers and coupon codes built from rules and actions.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/store-credits-gift-cards" title="Store credits & gift cards"
icon={<><rect width="20" height="14" x="2" y="7" rx="2" /><path d="M12 7v14" /><path d="M2 12h20" /><path d="M12 7a3 3 0 1 0-3-3c0 1.7 1.3 3 3 3" /><path d="M12 7a3 3 0 1 1 3-3c0 1.7-1.3 3-3 3" /></>}>
Stored-value balances and redeemable codes for refunds, loyalty and gifting.
</ConceptLink>
<ConceptGroup>Fulfillment</ConceptGroup>
<ConceptLink href="/developer/core-concepts/fulfillments" title="Fulfillments"
icon={<><path d="M14 18V6a2 2 0 0 0-2-2H4a2 2 0 0 0-2 2v11a1 1 0 0 0 1 1h2" /><path d="M14 9h4l4 4v4a1 1 0 0 1-1 1h-2" /><circle cx="7" cy="18" r="2" /><circle cx="17" cy="18" r="2" /></>}>
Getting items to the customer — shipping, digital delivery and in-store pickup.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/delivery-setup" title="Delivery setup"
icon={<><path d="M12 2a8 8 0 0 0-8 8c0 5.4 8 12 8 12s8-6.6 8-12a8 8 0 0 0-8-8" /><circle cx="12" cy="10" r="3" /></>}>
Profiles that decide how a product ships, zones that decide where, and where rates come from.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/returns-exchanges-claims" title="Returns, exchanges & claims"
icon={<><path d="M3 7v6h6" /><path d="M21 17a9 9 0 0 0-9-9 9 9 0 0 0-6.3 2.6L3 13" /><path d="M21 21v-4h-4" /></>}>
What happens after delivery — separate records for money back, different items, and something gone wrong.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/addresses" title="Addresses"
icon={<><rect width="20" height="16" x="2" y="4" rx="2" /><path d="m2 7 10 6 10-6" /></>}>
Country and state data, and address forms that adapt to the country a customer picks.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/calculators" title="Calculators"
icon={<><rect width="16" height="20" x="4" y="2" rx="2" /><path d="M8 6h8" /><path d="M8 11h.01" /><path d="M12 11h.01" /><path d="M16 11h.01" /><path d="M8 15h.01" /><path d="M12 15h.01" /><path d="M16 15h.01" /></>}>
The arithmetic behind delivery charges and promotion discounts, and how to choose between them.
</ConceptLink>
<ConceptGroup>Extensibility</ConceptGroup>
<ConceptLink href="/developer/core-concepts/events" title="Events"
icon={<><path d="M13 2 3 14h9l-1 8 10-12h-9z" /></>}>
React to an order placed, a payment taken or stock running out, without modifying core code.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/webhooks" title="Webhooks"
icon={<><path d="M18 16.98h-5.99c-1.1 0-1.95.94-2.48 1.9A4 4 0 0 1 2 17c.01-.7.2-1.4.57-2" /><path d="m6 17 3.13-5.78c.53-.97.1-2.18-.5-3.1a4 4 0 1 1 6.89-4.06" /><path d="m12 6 3.13 5.73C15.66 12.7 16.9 13 18 13a4 4 0 0 1 0 8" /></>}>
Real-time HTTP notifications to external services when something happens in your store.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/translations" title="Translations"
icon={<><path d="m5 8 6 6" /><path d="m4 14 6-6 2-3" /><path d="M2 5h12" /><path d="M7 2h1" /><path d="m22 22-5-10-5 10" /><path d="M14 18h6" /></>}>
Selling in more than one language — product content and the interface around it.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/slugs" title="Slugs"
icon={<><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71" /><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71" /></>}>
SEO-friendly URLs for products, categories and stores, and looking records up by slug or ID.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/metafields" title="Custom fields"
icon={<><path d="M4 7V4h16v3" /><path d="M9 20h6" /><path d="M12 4v16" /></>}>
Add your own structured, typed data to any record — searchable, filterable and editable in the dashboard.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/imports-exports" title="Imports & exports"
icon={<><path d="M12 3v12" /><path d="m8 11 4 4 4-4" /><path d="M8 5H4a2 2 0 0 0-2 2v12a2 2 0 0 0 2 2h16a2 2 0 0 0 2-2V7a2 2 0 0 0-2-2h-4" /></>}>
Move data in and out as CSV — bulk catalog updates, customer lists and order extracts.
</ConceptLink>
<ConceptLink href="/developer/core-concepts/reporting" title="Reporting"
icon={<><path d="M3 3v16a2 2 0 0 0 2 2h16" /><rect width="4" height="7" x="7" y="10" rx="1" /><rect width="4" height="12" x="15" y="5" rx="1" /></>}>
The metrics and dimensions behind the dashboard home screen, the Reports page and saved reports.
</ConceptLink>
</div>
</Section>
{/* FITS YOUR ARCHITECTURE */}
<Section>
<div className="grid lg:grid-cols-[1fr_1.15fr] gap-12 lg:gap-16 items-start">
<div>
<Eyebrow>Integrations</Eyebrow>
<SectionTitle>Spree fits your architecture</SectionTitle>
<Lede>
Most teams already run an ERP for stock, a PIM for product data and a payment provider with
years of history. Spree is the system of record for what the shopper sees — your systems stay
the system of record for what is true.
</Lede>
<a href="/developer/providers/overview"
className="mt-6 inline-flex items-center gap-2 text-sm font-medium text-blue-600 dark:text-blue-400 no-underline hover:gap-3 transition-all">
See how the provider contracts work
<Icon className="w-4 h-4"><path d="M5 12h14" /><path d="m12 5 7 7-7 7" /></Icon>
</a>
</div>
<div className="grid sm:grid-cols-2 gap-4">
<Card href="/developer/providers/erp" title="ERP">Sync stock levels and keep inventory truth where it already lives.</Card>
<Card href="/developer/providers/pim" title="PIM">Feed product data and pricing from your catalog system.</Card>
<Card href="/developer/providers/fulfillment" title="WMS & carriers">Buy labels, push fulfillments and track parcels.</Card>
<Card href="/developer/providers/sso" title="Identity & SSO">OpenID Connect for staff and customer sign-in.</Card>
</div>
</div>
</Section>
{/* HOW DO I…? */}
<Section>
<div className="grid lg:grid-cols-[1fr_1.3fr] gap-12 lg:gap-16 items-start">
<div>
<Eyebrow>How to</Eyebrow>
<SectionTitle>How do I…?</SectionTitle>
<Lede>Task-focused guides for the most common things teams build with Spree.</Lede>
</div>
<div>
<div className="flex flex-wrap gap-2.5">
<Pill href="/developer/how-to/build-a-marketplace">How do I build a marketplace?</Pill>
<Pill href="/developer/how-to/build-a-b2b-store">How do I sell B2B?</Pill>
<Pill href="/developer/how-to/sell-digital-products">How do I sell digital products?</Pill>
<Pill href="/developer/how-to/custom-payment-method">How do I add a payment method?</Pill>
<Pill href="/developer/core-concepts/metafields">How do I add custom fields?</Pill>
<Pill href="/developer/how-to/custom-promotion">How do I build a promotion?</Pill>
<Pill href="/developer/customization/api">How do I extend the API?</Pill>
<Pill href="/developer/dashboard/plugins/overview">How do I write a dashboard plugin?</Pill>
<Pill href="/developer/how-to/custom-search-provider">How do I plug in search?</Pill>
</div>
<div className="mt-8 pt-6 border-t border-[#e9e5dd]/80 dark:border-[#3f3e3c] flex flex-wrap items-center gap-2.5">
<span className="font-mono text-xs uppercase tracking-[0.14em] text-[#999999] dark:text-zinc-500 mr-1">Reference</span>
<Pill href="/api-reference/store-api/introduction">Store API</Pill>
<Pill href="/api-reference/admin-api/introduction">Admin API</Pill>
<Pill href="/developer/sdk/quickstart">TypeScript SDK</Pill>
<Pill href="/developer/cli/quickstart">CLI</Pill>
</div>
</div>
</div>
</Section>
{/* AI AGENTS */}
<Section>
<div className="grid lg:grid-cols-[1fr_1.15fr] gap-12 lg:gap-16 items-start">
<div>
<Eyebrow>For AI agents</Eyebrow>
<SectionTitle>Give your AI tools the full picture</SectionTitle>
<Lede>
Connect your coding assistant to the Spree docs over MCP, or install the agent skills so it
knows Spree's conventions before it writes a line of code.
</Lede>
<a href="/developer/agentic/overview"
className="mt-6 inline-flex items-center gap-2 text-sm font-medium text-blue-600 dark:text-blue-400 no-underline hover:gap-3 transition-all">
Set up agentic development
<Icon className="w-4 h-4"><path d="M5 12h14" /><path d="m12 5 7 7-7 7" /></Icon>
</a>
</div>
<div className="space-y-5">
<CopyBox label="Install the agent skills" command="npx skills add spree/agent-skills" />
<CopyBox label="Add the MCP server" command="claude mcp add spree-docs --transport http https://spreecommerce.org/docs/mcp" />
<p className="text-sm text-[#666666] dark:text-zinc-400 m-0">
Works with Claude Code, Cursor, VS Code and more. Every page is also served as plain
markdown — see <a href="/developer/agentic/llm-docs" className="text-blue-600 dark:text-blue-400">LLM-ready docs</a>.
</p>
</div>
</div>
</Section>
{/* COMMUNITY */}
<Section>
<Eyebrow>Community & support</Eyebrow>
<SectionTitle>Get help when you need it</SectionTitle>
<div className="mt-10 grid md:grid-cols-3 gap-5">
<Card href="https://discord.spreecommerce.org"
icon={<Icon><path d="M7.5 7.5c3-1 6-1 9 0" /><path d="M7 16.5c3 1 7 1 10 0" /><path d="M15.5 17c.64 2 .84 2 2 3 1.5-.5 3-1.5 3.5-2.5.5-2.5-.5-8-2.5-11.5-1-.5-2-1-3-1l-.5 1" /><path d="M8.5 17c-.64 2-.84 2-2 3-1.5-.5-3-1.5-3.5-2.5-.5-2.5.5-8 2.5-11.5 1-.5 2-1 3-1l.5 1" /></Icon>}
title="Discord community">
Ask questions and swap solutions with other Spree developers.
</Card>
<Card href="https://github.com/spree/spree/discussions"
icon={<Icon><path d="M14 9a2 2 0 0 1-2 2H6l-4 4V4a2 2 0 0 1 2-2h8a2 2 0 0 1 2 2z" /><path d="M18 9h2a2 2 0 0 1 2 2v11l-4-4h-6a2 2 0 0 1-2-2v-1" /></Icon>}
title="GitHub Discussions">
Propose features, discuss ideas and follow the development of the core.
</Card>
<Card href="https://spreecommerce.org/contact/"
icon={<Icon><circle cx="12" cy="12" r="10" /><circle cx="12" cy="12" r="4" /><path d="m4.9 4.9 4.2 4.2" /><path d="m14.9 14.9 4.2 4.2" /><path d="m14.9 9.1 4.2-4.2" /><path d="m4.9 19.1 4.2-4.2" /></Icon>}
title="Enterprise support">
Running Spree in production? Talk to us about dedicated support for your team.
</Card>
</div>
</Section>
</div>