Spree Commerce
Spree Commerce is an open-source headless eCommerce platform originally released in 2007 and built on Ruby on Rails. The Spree server exposes a modern Store API (v3), an Admin API (v3), a Platform API (v2) used by internal/back-office integrations, and a Storefront API (v2) based on the JSON:API spec - all described with OpenAPI 3 - plus an OAuth 2.0 token endpoint for authentication. Developer surface includes the TypeScript Store and Admin SDKs (@spree/sdk and @spree/admin-sdk), the @spree/cli for managing Spree projects, the create-spree-app scaffolder, the open-source Next.js storefront, the spree-starter application template, the spree_extension generator for building Rails extensions, the deface view-customization plugin, official payments integrations (Stripe, Adyen, PayPal), marketing integrations (Klaviyo, Google Analytics), an Avalara/AvaTax extension, the spree_multi_vendor marketplace extension, and a Webhook event system for reacting to store events.
Limited machine-readable signal and partial portal coverage — documentation a human can read, but little a machine or agent can consume without scraping.
API Evangelist profiles Spree Commerce the way a machine reads it — 187 machine-readable artifacts across 97 APIs, pulled from the provider's own public surface and indexed so a developer, an analyst, or an AI agent can evaluate it against every other provider on the network.
Every provider in the network is reduced to the same set of machine-readable artifacts — OpenAPI contracts, event specifications, GraphQL schemas, runnable collections, pricing and rate-limit signals, security posture, OAuth scopes, and the agent surfaces (MCP servers and skills) that let software drive the API on its own. We profile them because the interface is the part of a company you can actually inspect: it is a truer signal of what a provider does than any marketing page. From those artifacts we compute the Kin Score — Spree Commerce scores 40.5/100 (thin), with a separate agent-readiness read of 52/100 (agent native). The full breakdown is below, followed by every artifact we hold — each card links through to its machine-readable definition on apis.io.
Kin Score
This is the API Evangelist rating — a single, repeatable read computed from the artifacts on this page. Green fill is points earned; the red track is points possible, so every bar shows earned-versus-possible at a glance.
Put this on your own site. The badge is drawn live from Spree Commerce's current Kin Score — paste it once and it updates itself every time the score is recomputed. It follows your visitor's light or dark setting, and it links back here so anyone who sees it can read the full breakdown.
<!-- Kin Score · API Evangelist -->
<a href="https://providers.apievangelist.com/providers/spree-commerce/"
title="Spree Commerce on API Evangelist — API profile and Kin Score">
<img src="https://apis.io/badge/spree-commerce.svg"
alt="Spree Commerce Kin Score — API readiness rating by API Evangelist" width="150" height="150" loading="lazy">
</a>
[](https://providers.apievangelist.com/providers/spree-commerce/)
<!-- Kin Score · API Evangelist -->
<a href="https://providers.apievangelist.com/providers/spree-commerce/"
title="Spree Commerce on API Evangelist — API profile and Kin Score">
<img src="https://apis.io/badge/spree-commerce/card.svg"
alt="Spree Commerce Kin Score — API readiness rating by API Evangelist" width="340" height="120" loading="lazy">
</a>
More shapes, themes and sizes → · Score as JSON · How badges work
How we profile Spree Commerce
Each block below is one kind of artifact we hold for Spree Commerce. For each we say what it is and why it earns a place in the profile, then list every one we've indexed — capped at two rows, scroll within the panel for the rest.
APIs 97
Each API is captured as its own OpenAPI definition — every operation, parameter, and response. This is the single most useful machine-readable description of what an API does, and it's what lets us score, lint, mock, and generate against it without asking the provider for anything.
Individual APIs this provider publishes, each with its own machine-readable definition.
Spree Webhooks
Outbound webhook event system - the Spree server emits signed JSON payloads for order, product, customer, payment, and shipment lifecycle events. The webhook envelope carries an...
@spree/sdk (TypeScript Store API SDK)
Official TypeScript SDK for the Spree Store API - typed clients, auth helpers, and resource methods. Distributed via npm as @spree/sdk and consumed by the Next.js storefront, cu...
@spree/admin-sdk (TypeScript Admin API SDK)
Official TypeScript SDK for the Spree Admin API. Provides a typed client for managing products, orders, customers, and store configuration from Node.js services and admin tools.
@spree/cli
Command-line tool for managing Spree Commerce projects - scaffolding new apps, running the dev server, managing Docker, and orchestrating common project tasks. Installed via npm...
create-spree-app
One-line project generator for new Spree Commerce installations - mirrors create-next-app and create-medusa-app patterns. Bootstraps a working Rails-based Spree project from the...
Spree Next.js Storefront
Open-source Next.js storefront talking to the Spree Storefront API - cart, checkout, account, multi-region, one-page checkout, and Stripe, Adyen, and PayPal payments. MIT licensed.
Spree Rails Storefront
Spree 5 storefront built with Ruby on Rails and a visual page builder. Reference implementation for teams that want a Rails-monolith storefront on top of Spree rather than a sep...
spree-starter (Application Template)
Reference Spree application template used to bootstrap new Spree installations - includes Docker Compose, the recommended gem set, and a sensible default configuration for self-...
spree-multi-store
Extension for running and administering multiple stores from a single Spree installation - per-store products, taxonomies, domains, and configuration.
Spree Stripe Integration
Official Stripe payments integration for Spree, including support for Stripe Connect. Wires Spree's payment lifecycle to Stripe Payment Intents and Webhooks.
Spree Adyen Integration
Official Adyen payments platform integration for Spree Commerce - payment methods, capture, refund, and webhook handling against the Adyen API.
Spree PayPal Checkout Integration
Official PayPal Checkout integration extension for Spree - PayPal buttons, order flow, capture, and refund.
Spree Avalara AvaTax Integration
Officially certified Avalara AvaTax tax-calculation integration for Spree - real-time tax calculation, address validation, and document filing against AvaTax.
Spree Klaviyo Integration
Official Klaviyo marketing-platform integration for Spree - syncs customers, orders, and product events to Klaviyo for email and SMS lifecycle marketing.
Spree Google Analytics 4 Integration
Official Google Analytics 4 integration for Spree - ecommerce event tracking and measurement on top of the Spree storefronts.
spree_extension (Extension Generator CLI)
CLI tool for generating and managing Spree Commerce extensions - scaffolds the gemspec, engine, migrations, and conventions used by the Spree extension ecosystem.
Spree Dev Tools
Internal developer tooling for working on Spree itself - debuggers, profilers, dummy data generators, and helpers used by Spree's core contributors and extension authors.
deface (Rails View Customization)
Rails plugin maintained under the Spree organization that lets Spree stores customize ERB views without forking the underlying templates. Core extension primitive in the Spree e...
Spree Core Repository (spree/spree)
Monorepo with the Spree Rails engine, Admin, Store/Admin/Platform/ Storefront APIs, OpenAPI specs, TypeScript SDKs, CLI, and Next.js storefront. Released since 2007; latest stab...
Spree Commerce Account / Address API
The Account / Address API from Spree Commerce — 2 operation(s) for account / address.
Spree Commerce Account API
The Account API from Spree Commerce — 1 operation(s) for account.
Spree Commerce Account / Credit Cards API
The Account / Credit Cards API from Spree Commerce — 3 operation(s) for account / credit cards.
Spree Commerce Account / Orders API
The Account / Orders API from Spree Commerce — 2 operation(s) for account / orders.
Spree Commerce Addresses API
The Addresses API from Spree Commerce — 2 operation(s) for addresses.
Spree Commerce Adjustments API
The Adjustments API from Spree Commerce — 2 operation(s) for adjustments.
Spree Commerce Adyen API
The Adyen API from Spree Commerce — 3 operation(s) for adyen.
Spree Commerce Authentication API
Admin user authentication
Spree Commerce Cart API
The Cart API from Spree Commerce — 1 operation(s) for cart.
Spree Commerce Cart / Coupons API
The Cart / Coupons API from Spree Commerce — 3 operation(s) for cart / coupons.
Spree Commerce Cart / Line Items API
The Cart / Line Items API from Spree Commerce — 3 operation(s) for cart / line items.
Spree Commerce Cart / Other API
The Cart / Other API from Spree Commerce — 4 operation(s) for cart / other.
Spree Commerce Carts API
Shopping cart management
Spree Commerce Checkout API
The Checkout API from Spree Commerce — 2 operation(s) for checkout.
Spree Commerce Checkout / Payments API
The Checkout / Payments API from Spree Commerce — 2 operation(s) for checkout / payments.
Spree Commerce Checkout / Shipments API
The Checkout / Shipments API from Spree Commerce — 2 operation(s) for checkout / shipments.
Spree Commerce Checkout / State API
The Checkout / State API from Spree Commerce — 3 operation(s) for checkout / state.
Spree Commerce Checkout / Store Credit API
The Checkout / Store Credit API from Spree Commerce — 2 operation(s) for checkout / store credit.
Spree Commerce Classifications API
The Classifications API from Spree Commerce — 2 operation(s) for classifications.
Spree Commerce CMS Pages API
The CMS Pages API from Spree Commerce — 2 operation(s) for cms pages.
Spree Commerce CMS Sections API
The CMS Sections API from Spree Commerce — 2 operation(s) for cms sections.
Spree Commerce Configuration API
Store configuration — payment methods, tag autocomplete
Spree Commerce Countries API
The Countries API from Spree Commerce — 5 operation(s) for countries.
Spree Commerce Custom Fields API
The Custom Fields API from Spree Commerce — 2 operation(s) for custom fields.
Spree Commerce Customers API
Customer management — profiles, addresses, store credits, credit cards
Spree Commerce Data Feeds API
The Data Feeds API from Spree Commerce — 2 operation(s) for data feeds.
Spree Commerce Digital Assets API
The Digital Assets API from Spree Commerce — 2 operation(s) for digital assets.
Spree Commerce Digital Downloads API
The Digital Downloads API from Spree Commerce — 1 operation(s) for digital downloads.
Spree Commerce Digital Links API
The Digital Links API from Spree Commerce — 3 operation(s) for digital links.
Spree Commerce Digitals API
Digital product downloads
Spree Commerce Exports API
The Exports API from Spree Commerce — 3 operation(s) for exports.
Spree Commerce Gift Cards API
The Gift Cards API from Spree Commerce — 4 operation(s) for gift cards.
Spree Commerce Line Items API
The Line Items API from Spree Commerce — 2 operation(s) for line items.
Spree Commerce Markets API
Markets, countries, currencies, and locales
Spree Commerce Menu Items API
The Menu Items API from Spree Commerce — 3 operation(s) for menu items.
Spree Commerce Menus API
The Menus API from Spree Commerce — 2 operation(s) for menus.
Spree Commerce Newsletter Subscribers API
Guest and customer newsletter subscriptions (double opt-in)
Spree Commerce Option Types API
The Option Types API from Spree Commerce — 2 operation(s) for option types.
Spree Commerce Option Values API
The Option Values API from Spree Commerce — 2 operation(s) for option values.
Spree Commerce Order Status API
The Order Status API from Spree Commerce — 1 operation(s) for order status.
Spree Commerce Orders API
Order management — orders, items, payments, fulfillments, refunds, gift cards, store credits
Spree Commerce Payment Methods API
The Payment Methods API from Spree Commerce — 2 operation(s) for payment methods.
Spree Commerce Payments API
The Payments API from Spree Commerce — 2 operation(s) for payments.
Spree Commerce Policies API
Store policies (return policy, privacy policy, terms of service)
Spree Commerce Post Categories API
The Post Categories API from Spree Commerce — 2 operation(s) for post categories.
Spree Commerce Posts API
The Posts API from Spree Commerce — 2 operation(s) for posts.
Spree Commerce Product Catalog API
Products, variants, and option types
Spree Commerce Products API
The Products API from Spree Commerce — 6 operation(s) for products.
Spree Commerce Promotion Actions API
The Promotion Actions API from Spree Commerce — 2 operation(s) for promotion actions.
Spree Commerce Promotion Categories API
The Promotion Categories API from Spree Commerce — 2 operation(s) for promotion categories.
Spree Commerce Promotion Rules API
The Promotion Rules API from Spree Commerce — 2 operation(s) for promotion rules.
Spree Commerce Promotions API
The Promotions API from Spree Commerce — 11 operation(s) for promotions.
Spree Commerce Roles API
The Roles API from Spree Commerce — 2 operation(s) for roles.
Spree Commerce Shipments API
The Shipments API from Spree Commerce — 9 operation(s) for shipments.
Spree Commerce Shipping Categories API
The Shipping Categories API from Spree Commerce — 2 operation(s) for shipping categories.
Spree Commerce Shipping Methods API
The Shipping Methods API from Spree Commerce — 2 operation(s) for shipping methods.
Spree Commerce States API
The States API from Spree Commerce — 2 operation(s) for states.
Spree Commerce Stock Items API
The Stock Items API from Spree Commerce — 2 operation(s) for stock items.
Spree Commerce Stock Locations API
The Stock Locations API from Spree Commerce — 2 operation(s) for stock locations.
Spree Commerce Store Credit Categories API
The Store Credit Categories API from Spree Commerce — 2 operation(s) for store credit categories.
Spree Commerce Store Credit Types API
The Store Credit Types API from Spree Commerce — 2 operation(s) for store credit types.
Spree Commerce Store Credits API
The Store Credits API from Spree Commerce — 2 operation(s) for store credits.
Spree Commerce Stores API
The Stores API from Spree Commerce — 1 operation(s) for stores.
Spree Commerce Stripe API
The Stripe API from Spree Commerce — 4 operation(s) for stripe.
Spree Commerce Tax Categories API
The Tax Categories API from Spree Commerce — 2 operation(s) for tax categories.
Spree Commerce Tax Rates API
The Tax Rates API from Spree Commerce — 2 operation(s) for tax rates.
Spree Commerce Taxonomies API
The Taxonomies API from Spree Commerce — 2 operation(s) for taxonomies.
Spree Commerce Taxons API
The Taxons API from Spree Commerce — 5 operation(s) for taxons.
Spree Commerce Token API
The Token API from Spree Commerce — 1 operation(s) for token.
Spree Commerce Users API
The Users API from Spree Commerce — 2 operation(s) for users.
Spree Commerce Variants API
The Variants API from Spree Commerce — 3 operation(s) for variants.
Spree Commerce Vendors API
The Vendors API from Spree Commerce — 10 operation(s) for vendors.
Spree Commerce Webhook Events API
The Webhook Events API from Spree Commerce — 1 operation(s) for webhook events.
Spree Commerce Webhook Subscribers API
The Webhook Subscribers API from Spree Commerce — 2 operation(s) for webhook subscribers.
Spree Commerce Wished Items API
The Wished Items API from Spree Commerce — 2 operation(s) for wished items.
Spree Commerce Wishlists API
The Wishlists API from Spree Commerce — 9 operation(s) for wishlists.
Spree Commerce Wishlists / Wished Items API
The Wishlists / Wished Items API from Spree Commerce — 5 operation(s) for wishlists / wished items.
Spree Commerce Zones API
The Zones API from Spree Commerce — 2 operation(s) for zones.
Scroll within the panel for all 97 ·
Open Collections 84
Open, tool-agnostic collections carry the same runnable value as Postman without locking you to one client — the portable, forkable form of the same exercise.
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
API Collection
OPEN COLLECTIONAdmin Account / Address API
OPEN COLLECTIONAdmin / Address Account API
OPEN COLLECTIONAdmin Account / Address Account / Credit Cards API
OPEN COLLECTIONAdmin Account / Address Account / Orders API
OPEN COLLECTIONAdmin Account / Address Addresses API
OPEN COLLECTIONAdmin Account / Address Adjustments API
OPEN COLLECTIONAdmin API
OPEN COLLECTIONAdmin Account / Address Adyen API
OPEN COLLECTIONAdmin Account / Address Authentication API
OPEN COLLECTIONAdmin Account / Address Cart API
OPEN COLLECTIONAdmin Account / Address Cart / Coupons API
OPEN COLLECTIONAdmin Account / Address Cart / Line Items API
OPEN COLLECTIONAdmin Account / Address Cart / Other API
OPEN COLLECTIONAdmin Account / Address Carts API
OPEN COLLECTIONAdmin Account / Address Checkout API
OPEN COLLECTIONAdmin Account / Address Checkout / Payments API
OPEN COLLECTIONAdmin Account / Address Checkout / Shipments API
OPEN COLLECTIONAdmin Account / Address Checkout / State API
OPEN COLLECTIONAdmin Account / Address Checkout / Store Credit API
OPEN COLLECTIONAdmin Account / Address Classifications API
OPEN COLLECTIONAdmin Account / Address CMS Pages API
OPEN COLLECTIONAdmin Account / Address CMS Sections API
OPEN COLLECTIONAdmin Account / Address Configuration API
OPEN COLLECTIONAdmin Account / Address Countries API
OPEN COLLECTIONAdmin Account / Address Custom Fields API
OPEN COLLECTIONAdmin Account / Address Customers API
OPEN COLLECTIONAdmin Account / Address Data Feeds API
OPEN COLLECTIONAdmin Account / Address Digital Assets API
OPEN COLLECTIONAdmin Account / Address Digital Downloads API
OPEN COLLECTIONAdmin Account / Address Digital Links API
OPEN COLLECTIONAdmin Account / Address Digitals API
OPEN COLLECTIONAdmin Account / Address Exports API
OPEN COLLECTIONAdmin Account / Address Gift Cards API
OPEN COLLECTIONAdmin Account / Address Line Items API
OPEN COLLECTIONAdmin Account / Address Markets API
OPEN COLLECTIONAdmin Account / Address Menu Items API
OPEN COLLECTIONAdmin Account / Address Menus API
OPEN COLLECTIONAdmin Account / Address Newsletter Subscribers API
OPEN COLLECTIONAuthentication
OPEN COLLECTIONAdmin Account / Address Option Types API
OPEN COLLECTIONAdmin Account / Address Option Values API
OPEN COLLECTIONAdmin Account / Address Order Status API
OPEN COLLECTIONAdmin Account / Address Orders API
OPEN COLLECTIONAdmin Account / Address Payment Methods API
OPEN COLLECTIONAdmin Account / Address Payments API
OPEN COLLECTIONPlatform API
OPEN COLLECTIONAdmin Account / Address Policies API
OPEN COLLECTIONAdmin Account / Address Post Categories API
OPEN COLLECTIONAdmin Account / Address Posts API
OPEN COLLECTIONAdmin Account / Address Product Catalog API
OPEN COLLECTIONAdmin Account / Address Products API
OPEN COLLECTIONAdmin Account / Address Promotion Actions API
OPEN COLLECTIONAdmin Account / Address Promotion Categories API
OPEN COLLECTIONAdmin Account / Address Promotion Rules API
OPEN COLLECTIONAdmin Account / Address Promotions API
OPEN COLLECTIONAdmin Account / Address Roles API
OPEN COLLECTIONAdmin Account / Address Shipments API
OPEN COLLECTIONAdmin Account / Address Shipping Categories API
OPEN COLLECTIONAdmin Account / Address Shipping Methods API
OPEN COLLECTIONAdmin Account / Address States API
OPEN COLLECTIONAdmin Account / Address Stock Items API
OPEN COLLECTIONAdmin Account / Address Stock Locations API
OPEN COLLECTIONStore API
OPEN COLLECTIONAdmin Account / Address Store Credit Categories API
OPEN COLLECTIONAdmin Account / Address Store Credit Types API
OPEN COLLECTIONAdmin Account / Address Store Credits API
OPEN COLLECTIONStorefront API
OPEN COLLECTIONAdmin Account / Address Stores API
OPEN COLLECTIONAdmin Account / Address Stripe API
OPEN COLLECTIONAdmin Account / Address Tax Categories API
OPEN COLLECTIONAdmin Account / Address Tax Rates API
OPEN COLLECTIONAdmin Account / Address Taxonomies API
OPEN COLLECTIONAdmin Account / Address Taxons API
OPEN COLLECTIONAdmin Account / Address Token API
OPEN COLLECTIONAdmin Account / Address Users API
OPEN COLLECTIONAdmin Account / Address Variants API
OPEN COLLECTIONAdmin Account / Address Vendors API
OPEN COLLECTIONAdmin Account / Address Webhook Events API
OPEN COLLECTIONAdmin Account / Address Webhook Subscribers API
OPEN COLLECTIONAdmin Account / Address Wished Items API
OPEN COLLECTIONAdmin Account / Address Wishlists API
OPEN COLLECTIONAdmin Account / Address Wishlists / Wished Items API
OPEN COLLECTIONAdmin Account / Address Zones API
OPEN COLLECTIONScroll within the panel for all 84 ·
Pricing Plans 1
Pricing is part of the interface. Machine-readable plans tell you what a tier costs and includes before you commit — one of the six things the Kin Score reads for commercial clarity.
Published pricing tiers and plan structures.
Rate Limits 1
Rate limits are the difference between a demo that works and a production integration that doesn't fall over. Publishing them is an operational-transparency signal — and a hard requirement for any agent that plans its own throughput.
Documented rate limits and quota policies.
Spree Commerce Rate Limits
RATE LIMITSFinOps 1
Cost, billing, and metering signals let a buyer model the financial operations of an API before it's live. We profile them for the same reason we profile pricing: the money is part of the contract.
Cost, billing, and metering signals for API financial operations.
Spree Commerce Finops
FINOPSSecurity Posture 2
Authentication, domain security, vulnerability disclosure, and trust-center signals — the evidence that a provider takes security seriously enough to document it. We profile it because you can't govern what you can't see.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Agentic Access 1
An x-agentic-access contract marks which operations are safe for an agent to run on its own and which need a human in the loop. It is the difference between an API an agent can use and one it can use safely.
Recommended x-agentic-access execution contracts for AI agents.
Resources
Every other property we hold for Spree Commerce — documentation, portals, status pages, policies, and corporate surface — grouped by the job it does, following the integrator's arc from getting started to running in production.
Get Started 1
Portal, sign-up, and the first successful call
Documentation 2
Reference material describing how the API behaves
Agent Surfaces 1
MCP servers, agent skills, and machine-readable catalogs
Build 1
SDKs, sample code, and the tooling you integrate with
Access & Security 2
Authentication, authorization, and security posture
Operate 1
Status, limits, changes, and where to get help
Commercial 2
Pricing, plans, and the legal terms of use
Company 3
The organization behind the API
Other 1
Properties that don't map to a standard resource type
← All providers · Data indexed from github.com/api-evangelist/spree-commerce · machine-readable index on apis.io
This is an independent, third-party profile of Spree Commerce, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.