Headless Commerce

Spree architecture
Spree APIs
Spree is a modular, API-first headless e-commerce platform that consists of several APIs.
​Storefront API​
Modern and lightweight REST API based on JSON API schema
Designed for building Storefronts and mobile apps
​JavaScript / TypeScript SDK available
​Next.js Commerce integration available 🎉​
​Vue Storefront integration available 🚀​
​Platform API (Developer Preview)
OAuth 2.0 authentication
designed for building application to application integration
permission sets based access to resources
access any resource on the Spree platform and perform any action
Webhooks
We're working hard to deliver webhooks in the Spree v4.4!
Storefronts
Spree allows limitless storefront customization. 
You can build your own storefront from scratch using our SDK which takes care of all heavy lifting tasks, or you can use Next.js Commerce or Vue Storefront. 
Spree modules
Spree is divided into several modules / ruby gems which you can install independently. 
​Spree Starter comes with all modules pre-installed for your convenience!
Spree module
Description
spree
Data models, Services and APIs
spree_backend
Admin Panel UI
spree_sample
Sample seed data
spree_emails
Transactional emails, eg. order confirmation
There are many other packages adding more features called Extensions.
To change which Spree gems you would like to install you will need to modify your project Gemfile.
Headless installation (default)
1
gem 'spree'
Copied!
Headless with Admin Panel
1
gem 'spree'
2
gem 'spree_backend'
Copied!
After changing the Gemfile you need to run
1
bundle install
Copied!
or if using Spree Starter:
1
bundle install
2
docker-compose build
Copied!
​