Overview
Spree is a commerce engine built around interconnected models that represent the core concepts of commerce: products, orders, payments, and shipments. It adapts to your stack — use it as a headless API for any frontend, embed it into an existing application, or scale it from a single storefront to a global multi-vendor marketplace.
Core Commerce Flow
The following diagram shows how the main models interact during a typical customer purchase:
How it works:
-
Catalog — Products have Variants (SKUs) with prices and inventory tracked at Stock Locations
-
Shopping — Customers add Variants to their cart, creating an Order with Line Items
-
Checkout — The Order collects Addresses, calculates Shipping options, and processes Payments
-
Fulfillment — Shipments are created from Stock Locations, tracking individual Inventory Units
-
Pricing & Adjustments — Taxes and Promotions create Adjustments that modify order totals
Core Model Relationships
This diagram shows the key database relationships between Spree’s main models:
APIs
Spree exposes two REST APIs:
| API | Purpose | Authentication |
|---|
| Store API | Customer-facing — cart, checkout, products, account | Publishable API key + JWT |
| Admin API | Operational — manage products, orders, customers, settings | Secret API key + JWT |
Multi-Store Architecture
Spree supports multiple stores from a single installation. Each Store can have:
- Its own domain and branding
- Different currencies and locales
- Separate product catalogs
- Independent payment and shipping methods
- Isolated orders and customers
This makes Spree suitable for multi-brand retailers, international expansion, or B2B/B2C hybrid setups.
Extension Points
Spree is designed to be customized without modifying core code. The main extension mechanisms are:
| Mechanism | Use Case | Documentation |
|---|
| Events & Subscribers | React to order completion, payment, shipment events | Events Guide |
| Webhooks | Notify external systems of changes | Webhooks Guide |
| Dependencies | Swap out services (tax calculation, shipping estimation) | Dependencies Guide |
| Decorators | Modify existing core models & classes behavior (use sparingly) | Decorators Guide |
For most customizations, prefer Events and Dependencies over Decorators. They’re easier to maintain and won’t break during upgrades.
Packages
Spree is distributed as a set of packages:
Core (required):
| Package | Purpose |
|---|
spree | Models, services, business logic, Store API, Admin API, and Webhooks |
| Package | Purpose |
|---|
spree_admin | Admin dashboard for managing your store |
spree_emails | Transactional email templates (order confirmation, shipping, etc.) |
| Package | Purpose |
|---|
@spree/sdk | TypeScript SDK for the Store API |
@spree/admin-sdk | TypeScript SDK for the Admin API |
@spree/cli | Command line interface for managing local environment and using the Admin API from the terminal |
