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.
Spree Commerce publishes 97 API contracts indexed on the APIs.io network, including Account / Address API, Account API, Account / Credit Cards API, and 94 more. Tagged areas include Commerce, Headless, E-Commerce, Open Source, and Ruby on Rails.
The Spree Commerce catalog on APIs.io includes 1 Spectral governance ruleset.
Spree Commerce’s developer surface includes authentication, engineering blog, documentation, API reference, GitHub presence, pricing, release notes, and 16 more developer resources.
32.6/100thin▬ flatAgent40/100agent nativeFront door AI5/6
prominent
Heartbeat100/100
alive
open core · BSD-3-Clause
Full breakdown ↓
scored 2026-11-13 · rubric v0.28.0 · Show this score on your site →
Regulatory Posture applies to this provider. Its tags matched the
Horizontal (data, software, accessibility, platform) regime, so
Regulatory Posture carries 15 points of the composite.
If this regime is wrong for your business, say so on your
provider repo — the
applicability map is public and we will correct it.
Open Source Surface applies to this provider. This product is open source and we
read its repository directly, so Open Source Surface carries
10 points of the composite. It is scored from what the repository actually
publishes — a security policy, a contribution guide, a release history, a code of conduct — read live from the
provider rather than inferred from our own catalog pointers.
This facet adds; nothing was taken away to make room for it. An open-source project is not excused from
the commercial facets, because exemption would strip it of the points it does earn.
If we have the wrong repository, or this product is not open source, say so on your
provider repo and we
will drop the facet rather than have you publish against it.
Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it
carries 10 points of the composite. It is scored from the published contracts
themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already
holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in
front of it, and the first time that check is skipped a duplicate record is created.
Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet,
not penalised by it.
The six quality facets above are damped to 65 points between them,
because both conditional facets apply and carry
35 points together. That is why each facet's contribution is shown against a damped
maximum: raising a quality facet moves the composite by 65% of its nominal
weight, not 100%. The full arithmetic is at apis.io/rating/.
Show this score on your site.
It updates itself when the score changes. Paste this where you link to your API docs:
<a href="https://apis.io/providers/spree-commerce/"><img src="https://apis.io/badge/spree-commerce/card.svg" alt="Spree Commerce on APIs.io — Kin Score by API Evangelist"></a>
Other styles, a README pill and a shields.io endpoint are on the badge page.
Raise your score.
Agent readiness — checks not met, largest first (exact, from this profile):
MCP Server+12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship Ask about this →
Delegated User Identity+6 pts — a served discovery document listing authorization_code in grant_types_supported (served), else an oauth2 authorizationCode flow or openIdConnect declared in an OpenAPI (documented) Ask about this →
Typed Event Surface+6 pts — AsyncAPI document, OR webhooks/callbacks objects in the as-published OpenAPI, OR common[].type includes Webhooks Ask about this →
Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.
Not sure how this applies to your stack? Ask about any one item. Kin Lane reads every question, looks at your profile and your situation, and replies with what a fix would take — scoped to that one area, priced up front, yours whether you ship it or not. Ask a question →
Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.
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...
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...
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.
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...
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...
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 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...
Reference Spree application template used to bootstrap new Spree installations - includes Docker Compose, the recommended gem set, and a sensible default configuration for self-...
Official Stripe payments integration for Spree, including support for Stripe Connect. Wires Spree's payment lifecycle to Stripe Payment Intents and Webhooks.
Official Klaviyo marketing-platform integration for Spree - syncs customers, orders, and product events to Klaviyo for email and SMS lifecycle marketing.
CLI tool for generating and managing Spree Commerce extensions - scaffolds the gemspec, engine, migrations, and conventions used by the Spree extension ecosystem.
Internal developer tooling for working on Spree itself - debuggers, profilers, dummy data generators, and helpers used by Spree's core contributors and extension authors.
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...
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...
Not yet checked against Spree Commerce's own pricing page. Compiled by API Evangelist on 2026-05-25; confirm before you rely on a figure. A free plan or tier is listed.
aid: spree-commerce
url: https://raw.githubusercontent.com/api-evangelist/spree-commerce/refs/heads/main/apis.yml
name: Spree Commerce
kind: opensource
description: 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.
deliveryModel:
model: open-core
license: BSD-3-Clause
open_source: true
commercial: true
callable_host: false
label: Open core · an OSS project plus a commercial hosted product
confidence: high
source:
- license
- openapi
- pricing
generated: '2026-08-28'
method: derived
accessModel:
pricing: freemium
onboarding: self-serve
trial: false
try_now: true
public: false
gated: none
gated_source:
- onboarding
label: Freemium · Self-serve signup
confidence: medium
source:
- plans
- authentication
- security
generated: '2026-11-13'
method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/spree-commerce.png
x-docs-platform: mintlify
x-docs-platform-confidence: medium
x-docs-platform-checked: 2026-10-17
tags:
- Commerce
- Headless
- E-Commerce
- Open Source
- Ruby on Rails
- Ruby
- TypeScript
tags_raw:
- Commerce
- Headless
- eCommerce
- Open Source
- Ruby on Rails
- Ruby
- TypeScript
- Open-Source
created: '2026-05-25'
modified: '2026-07-25'
specificationVersion: '0.23'
apis:
- aid: spree-commerce:webhooks
name: Spree Webhooks
description: 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 id, event name, created_at, data, and metadata block, with
payloads sharing the Store API v3 serializers.
humanURL: https://dev-docs.spreecommerce.org/api-reference/webhooks-events
baseURL: https://dev-docs.spreecommerce.org/api-reference/webhooks-events
tags:
- Webhook
- Event
- Notification
tags_raw:
- Webhooks
- Events
- Notifications
properties:
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/webhooks-events
- type: Documentation
url: https://dev-docs.spreecommerce.org/developer/core-concepts/webhooks
- aid: spree-commerce:sdk
name: '@spree/sdk (TypeScript Store API SDK)'
description: 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, custom storefronts, and server-side integrations.
humanURL: https://www.npmjs.com/package/@spree/sdk
baseURL: https://github.com/spree/spree/tree/main/packages/sdk
tags:
- SDK
- TypeScript
- JavaScript
- Storefront
properties:
- type: Repository
url: https://github.com/spree/spree/tree/main/packages/sdk
- type: Package
url: https://www.npmjs.com/package/@spree/sdk
- aid: spree-commerce:admin-sdk
name: '@spree/admin-sdk (TypeScript Admin API SDK)'
description: 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.
humanURL: https://www.npmjs.com/package/@spree/admin-sdk
baseURL: https://github.com/spree/spree/tree/main/packages/admin-sdk
tags:
- SDK
- TypeScript
- Admin
properties:
- type: Repository
url: https://github.com/spree/spree/tree/main/packages/admin-sdk
- type: Package
url: https://www.npmjs.com/package/@spree/admin-sdk
- aid: spree-commerce:cli
name: '@spree/cli'
description: 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 and exposed as the spree binary.
humanURL: https://www.npmjs.com/package/@spree/cli
baseURL: https://github.com/spree/spree/tree/main/packages/cli
tags:
- CLI
- Tooling
- Developer Experience
properties:
- type: Repository
url: https://github.com/spree/spree/tree/main/packages/cli
- type: Package
url: https://www.npmjs.com/package/@spree/cli
- aid: spree-commerce:create-spree-app
name: create-spree-app
description: 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-starter template.
humanURL: https://www.npmjs.com/package/create-spree-app
baseURL: https://github.com/spree/spree/tree/main/packages/create-spree-app
tags:
- CLI
- Scaffolding
- Starter
properties:
- type: Repository
url: https://github.com/spree/spree/tree/main/packages/create-spree-app
- type: Package
url: https://www.npmjs.com/package/create-spree-app
- aid: spree-commerce:nextjs-storefront
name: Spree Next.js Storefront
description: 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.
humanURL: https://github.com/spree/storefront
baseURL: https://github.com/spree/storefront
tags:
- Storefront
- Next.js
- Starter
- TypeScript
properties:
- type: Repository
url: https://github.com/spree/storefront
- aid: spree-commerce:rails-storefront
name: Spree Rails Storefront
description: 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 separate JavaScript runtime.
humanURL: https://github.com/spree/spree-rails-storefront
baseURL: https://github.com/spree/spree-rails-storefront
tags:
- Storefront
- Ruby on Rails
- Page Builder
tags_raw:
- Storefront
- Rails
- Page Builder
properties:
- type: Repository
url: https://github.com/spree/spree-rails-storefront
- aid: spree-commerce:starter
name: spree-starter (Application Template)
description: Reference Spree application template used to bootstrap new Spree installations - includes Docker Compose, the
recommended gem set, and a sensible default configuration for self-hosted deployments.
humanURL: https://github.com/spree/spree-starter
baseURL: https://github.com/spree/spree-starter
tags:
- Starter
- Application
- Docker
properties:
- type: Repository
url: https://github.com/spree/spree-starter
- aid: spree-commerce:multi-store
name: spree-multi-store
description: Extension for running and administering multiple stores from a single Spree installation - per-store products,
taxonomies, domains, and configuration.
humanURL: https://github.com/spree/spree-multi-store
baseURL: https://github.com/spree/spree-multi-store
tags:
- multi-store
- Extension
tags_raw:
- Multi Store
- Extension
properties:
- type: Repository
url: https://github.com/spree/spree-multi-store
- aid: spree-commerce:stripe
name: Spree Stripe Integration
description: Official Stripe payments integration for Spree, including support for Stripe Connect. Wires Spree's payment
lifecycle to Stripe Payment Intents and Webhooks.
humanURL: https://github.com/spree/spree_stripe
baseURL: https://github.com/spree/spree_stripe
tags:
- Payments
- Stripe
- Integration
properties:
- type: Repository
url: https://github.com/spree/spree_stripe
- aid: spree-commerce:adyen
name: Spree Adyen Integration
description: Official Adyen payments platform integration for Spree Commerce - payment methods, capture, refund, and webhook
handling against the Adyen API.
humanURL: https://github.com/spree/spree_adyen
baseURL: https://github.com/spree/spree_adyen
tags:
- Payments
- Adyen
- Integration
properties:
- type: Repository
url: https://github.com/spree/spree_adyen
- aid: spree-commerce:paypal-checkout
name: Spree PayPal Checkout Integration
description: Official PayPal Checkout integration extension for Spree - PayPal buttons, order flow, capture, and refund.
humanURL: https://github.com/spree/spree_paypal_checkout
baseURL: https://github.com/spree/spree_paypal_checkout
tags:
- Payments
- PayPal
- Integration
properties:
- type: Repository
url: https://github.com/spree/spree_paypal_checkout
- aid: spree-commerce:avatax
name: Spree Avalara AvaTax Integration
description: Officially certified Avalara AvaTax tax-calculation integration for Spree - real-time tax calculation, address
validation, and document filing against AvaTax.
humanURL: https://github.com/spree/spree_avatax_official
baseURL: https://github.com/spree/spree_avatax_official
tags:
- Tax
- Avalara
- AvaTax
- Integration
properties:
- type: Repository
url: https://github.com/spree/spree_avatax_official
- aid: spree-commerce:klaviyo
name: Spree Klaviyo Integration
description: Official Klaviyo marketing-platform integration for Spree - syncs customers, orders, and product events to
Klaviyo for email and SMS lifecycle marketing.
humanURL: https://github.com/spree/spree_klaviyo
baseURL: https://github.com/spree/spree_klaviyo
tags:
- Marketing
- Klaviyo
- Email
- Integration
properties:
- type: Repository
url: https://github.com/spree/spree_klaviyo
- aid: spree-commerce:google-analytics
name: Spree Google Analytics 4 Integration
description: Official Google Analytics 4 integration for Spree - ecommerce event tracking and measurement on top of the
Spree storefronts.
humanURL: https://github.com/spree/spree_google_analytics
baseURL: https://github.com/spree/spree_google_analytics
tags:
- Analytics
- Google Analytics
- Integration
properties:
- type: Repository
url: https://github.com/spree/spree_google_analytics
- aid: spree-commerce:extension
name: spree_extension (Extension Generator CLI)
description: CLI tool for generating and managing Spree Commerce extensions - scaffolds the gemspec, engine, migrations,
and conventions used by the Spree extension ecosystem.
humanURL: https://github.com/spree/spree_extension
baseURL: https://github.com/spree/spree_extension
tags:
- CLI
- Extension
- Tooling
properties:
- type: Repository
url: https://github.com/spree/spree_extension
- aid: spree-commerce:dev-tools
name: Spree Dev Tools
description: Internal developer tooling for working on Spree itself - debuggers, profilers, dummy data generators, and helpers
used by Spree's core contributors and extension authors.
humanURL: https://github.com/spree/spree_dev_tools
baseURL: https://github.com/spree/spree_dev_tools
tags:
- Developer Tools
- Tooling
properties:
- type: Repository
url: https://github.com/spree/spree_dev_tools
- aid: spree-commerce:deface
name: deface (Rails View Customization)
description: 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 ecosystem.
humanURL: https://github.com/spree/deface
baseURL: https://github.com/spree/deface
tags:
- Ruby on Rails
- Views
- Customization
- Plugins
tags_raw:
- Rails
- Views
- Customization
- Plugin
properties:
- type: Repository
url: https://github.com/spree/deface
- aid: spree-commerce:core-repo
name: Spree Core Repository (spree/spree)
description: 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 stable release v5.4.3.
humanURL: https://github.com/spree/spree
baseURL: https://github.com/spree/spree
tags:
- Open Source
- Repository
- Monorepo
- Ruby on Rails
- Ruby
tags_raw:
- Open Source
- Repository
- Monorepo
- Rails
- Ruby
- Open-Source
properties:
- type: Repository
url: https://github.com/spree/spree
- aid: spree-commerce:spree-commerce-account-address-api
name: Spree Commerce Account / Address API
description: The Account / Address API from Spree Commerce — 2 operation(s) for account / address.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Account / Address
properties:
- type: OpenAPI
url: openapi/spree-commerce-account-address-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-account-api
name: Spree Commerce Account API
description: The Account API from Spree Commerce — 1 operation(s) for account.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Account
properties:
- type: OpenAPI
url: openapi/spree-commerce-account-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-account-credit-cards-api
name: Spree Commerce Account / Credit Cards API
description: The Account / Credit Cards API from Spree Commerce — 3 operation(s) for account / credit cards.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Account / Credit Cards
properties:
- type: OpenAPI
url: openapi/spree-commerce-account-credit-cards-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-account-orders-api
name: Spree Commerce Account / Orders API
description: The Account / Orders API from Spree Commerce — 2 operation(s) for account / orders.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Account / Orders
properties:
- type: OpenAPI
url: openapi/spree-commerce-account-orders-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-addresses-api
name: Spree Commerce Addresses API
description: The Addresses API from Spree Commerce — 2 operation(s) for addresses.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Addresses
properties:
- type: OpenAPI
url: openapi/spree-commerce-addresses-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-adjustments-api
name: Spree Commerce Adjustments API
description: The Adjustments API from Spree Commerce — 2 operation(s) for adjustments.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Adjustments
properties:
- type: OpenAPI
url: openapi/spree-commerce-adjustments-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-adyen-api
name: Spree Commerce Adyen API
description: The Adyen API from Spree Commerce — 3 operation(s) for adyen.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Adyen
properties:
- type: OpenAPI
url: openapi/spree-commerce-adyen-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-authentication-api
name: Spree Commerce Authentication API
description: Admin user authentication
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Authentication
properties:
- type: OpenAPI
url: openapi/spree-commerce-authentication-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-cart-api
name: Spree Commerce Cart API
description: The Cart API from Spree Commerce — 1 operation(s) for cart.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Cart
properties:
- type: OpenAPI
url: openapi/spree-commerce-cart-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-cart-coupons-api
name: Spree Commerce Cart / Coupons API
description: The Cart / Coupons API from Spree Commerce — 3 operation(s) for cart / coupons.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Cart / Coupons
properties:
- type: OpenAPI
url: openapi/spree-commerce-cart-coupons-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-cart-line-items-api
name: Spree Commerce Cart / Line Items API
description: The Cart / Line Items API from Spree Commerce — 3 operation(s) for cart / line items.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Cart / Line Items
properties:
- type: OpenAPI
url: openapi/spree-commerce-cart-line-items-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-cart-other-api
name: Spree Commerce Cart / Other API
description: The Cart / Other API from Spree Commerce — 4 operation(s) for cart / other.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Cart / Other
properties:
- type: OpenAPI
url: openapi/spree-commerce-cart-other-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-carts-api
name: Spree Commerce Carts API
description: Shopping cart management
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Cart
tags_raw:
- Carts
properties:
- type: OpenAPI
url: openapi/spree-commerce-carts-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-checkout-api
name: Spree Commerce Checkout API
description: The Checkout API from Spree Commerce — 2 operation(s) for checkout.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Checkout
properties:
- type: OpenAPI
url: openapi/spree-commerce-checkout-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-checkout-payments-api
name: Spree Commerce Checkout / Payments API
description: The Checkout / Payments API from Spree Commerce — 2 operation(s) for checkout / payments.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Checkout / Payments
properties:
- type: OpenAPI
url: openapi/spree-commerce-checkout-payments-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-checkout-shipments-api
name: Spree Commerce Checkout / Shipments API
description: The Checkout / Shipments API from Spree Commerce — 2 operation(s) for checkout / shipments.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Checkout / Shipments
properties:
- type: OpenAPI
url: openapi/spree-commerce-checkout-shipments-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-checkout-state-api
name: Spree Commerce Checkout / State API
description: The Checkout / State API from Spree Commerce — 3 operation(s) for checkout / state.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Checkout / State
properties:
- type: OpenAPI
url: openapi/spree-commerce-checkout-state-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-checkout-store-credit-api
name: Spree Commerce Checkout / Store Credit API
description: The Checkout / Store Credit API from Spree Commerce — 2 operation(s) for checkout / store credit.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Checkout / Store Credit
properties:
- type: OpenAPI
url: openapi/spree-commerce-checkout-store-credit-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-classifications-api
name: Spree Commerce Classifications API
description: The Classifications API from Spree Commerce — 2 operation(s) for classifications.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Classifications
properties:
- type: OpenAPI
url: openapi/spree-commerce-classifications-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-cms-pages-api
name: Spree Commerce CMS Pages API
description: The CMS Pages API from Spree Commerce — 2 operation(s) for cms pages.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- CMS Pages
properties:
- type: OpenAPI
url: openapi/spree-commerce-cms-pages-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/authentication
- aid: spree-commerce:spree-commerce-cms-sections-api
name: Spree Commerce CMS Sections API
description: The CMS Sections API from Spree Commerce — 2 operation(s) for cms sections.
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- CMS Sections
properties:
- type: OpenAPI
url: openapi/spree-commerce-cms-sections-api-openapi.yml
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
- type: Documentation
url: https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
# --- truncated at 32 KB (87 KB total) ---
# Full source: https://artifacts.apis.io/spree-commerce/apis.yml
Spree Commerce API — frequently asked questions
Does Spree Commerce have an API?
Yes. APIs.io lists 97 APIs from Spree Commerce, including Spree Webhooks, @spree/sdk (TypeScript Store API SDK) and @spree/admin-sdk (TypeScript Admin API SDK), and 94 more.
Is there an OpenAPI specification for the Spree Commerce API?
Yes. APIs.io indexes 78 OpenAPI specifications for Spree Commerce, each linked for download from this page.
How do I authenticate with the Spree Commerce API?
Spree Commerce uses bearer-token authentication (apiKey/http · 3 schemes). The details are profiled on APIs.io as Spree Commerce Authentication.
How much does the Spree Commerce API cost?
APIs.io lists 2 pricing plans for Spree Commerce, with each plan's price, limits and inclusions under Pricing on this page.
Is the Spree Commerce API ready for AI agents?
Spree Commerce has a Kin Score of 32.6 out of 100 (thin) and an Agent Readiness score of 40.1 (agent-native), scored by API Evangelist on 2026-11-13.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.