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.
Spree Commerce publishes 78 APIs on the APIs.io network, including Account / Address API, Account API, Account / Credit Cards API, and 75 more. Tagged areas include Commerce, Headless, eCommerce, Open Source, and Ruby on Rails.
Spree Commerce’s developer surface includes authentication, engineering blog, documentation, API reference, GitHub presence, pricing, release notes, and 6 more developer resources.
97 APIs
CommerceHeadlesseCommerceOpen SourceRuby on RailsRubyTypeScript
Individual APIs this provider publishes, each with its own machine-readable definition.
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-...
Extension for running and administering multiple stores from a single Spree installation - per-store products, taxonomies, domains, and configuration.
Official Stripe payments integration for Spree, including support for Stripe Connect. Wires Spree's payment lifecycle to Stripe Payment Intents and Webhooks.
Official Adyen payments platform integration for Spree Commerce - payment methods, capture, refund, and webhook handling against the Adyen API.
Official PayPal Checkout integration extension for Spree - PayPal buttons, order flow, capture, and refund.
Officially certified Avalara AvaTax tax-calculation integration for Spree - real-time tax calculation, address validation, and document filing against AvaTax.
Official Klaviyo marketing-platform integration for Spree - syncs customers, orders, and product events to Klaviyo for email and SMS lifecycle marketing.
Official Google Analytics 4 integration for Spree - ecommerce event tracking and measurement on top of the Spree storefronts.
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...
The Account / Address API from Spree Commerce — 2 operation(s) for account / address.
The Account API from Spree Commerce — 1 operation(s) for account.
The Account / Credit Cards API from Spree Commerce — 3 operation(s) for account / credit cards.
The Account / Orders API from Spree Commerce — 2 operation(s) for account / orders.
The Addresses API from Spree Commerce — 2 operation(s) for addresses.
The Adjustments API from Spree Commerce — 2 operation(s) for adjustments.
The Adyen API from Spree Commerce — 3 operation(s) for adyen.
Admin user authentication
The Cart API from Spree Commerce — 1 operation(s) for cart.
The Cart / Coupons API from Spree Commerce — 3 operation(s) for cart / coupons.
The Cart / Line Items API from Spree Commerce — 3 operation(s) for cart / line items.
The Cart / Other API from Spree Commerce — 4 operation(s) for cart / other.
The Checkout API from Spree Commerce — 2 operation(s) for checkout.
The Checkout / Payments API from Spree Commerce — 2 operation(s) for checkout / payments.
The Checkout / Shipments API from Spree Commerce — 2 operation(s) for checkout / shipments.
The Checkout / State API from Spree Commerce — 3 operation(s) for checkout / state.
The Checkout / Store Credit API from Spree Commerce — 2 operation(s) for checkout / store credit.
The Classifications API from Spree Commerce — 2 operation(s) for classifications.
The CMS Pages API from Spree Commerce — 2 operation(s) for cms pages.
The CMS Sections API from Spree Commerce — 2 operation(s) for cms sections.
Store configuration — payment methods, tag autocomplete
The Countries API from Spree Commerce — 5 operation(s) for countries.
The Custom Fields API from Spree Commerce — 2 operation(s) for custom fields.
Customer management — profiles, addresses, store credits, credit cards
The Data Feeds API from Spree Commerce — 2 operation(s) for data feeds.
The Digital Assets API from Spree Commerce — 2 operation(s) for digital assets.
The Digital Downloads API from Spree Commerce — 1 operation(s) for digital downloads.
The Digital Links API from Spree Commerce — 3 operation(s) for digital links.
Digital product downloads
The Exports API from Spree Commerce — 3 operation(s) for exports.
The Gift Cards API from Spree Commerce — 4 operation(s) for gift cards.
The Line Items API from Spree Commerce — 2 operation(s) for line items.
Markets, countries, currencies, and locales
The Menu Items API from Spree Commerce — 3 operation(s) for menu items.
The Menus API from Spree Commerce — 2 operation(s) for menus.
Guest and customer newsletter subscriptions (double opt-in)
The Option Types API from Spree Commerce — 2 operation(s) for option types.
The Option Values API from Spree Commerce — 2 operation(s) for option values.
The Order Status API from Spree Commerce — 1 operation(s) for order status.
Order management — orders, items, payments, fulfillments, refunds, gift cards, store credits
The Payment Methods API from Spree Commerce — 2 operation(s) for payment methods.
The Payments API from Spree Commerce — 2 operation(s) for payments.
Store policies (return policy, privacy policy, terms of service)
The Post Categories API from Spree Commerce — 2 operation(s) for post categories.
The Posts API from Spree Commerce — 2 operation(s) for posts.
Products, variants, and option types
The Products API from Spree Commerce — 6 operation(s) for products.
The Promotion Actions API from Spree Commerce — 2 operation(s) for promotion actions.
The Promotion Categories API from Spree Commerce — 2 operation(s) for promotion categories.
The Promotion Rules API from Spree Commerce — 2 operation(s) for promotion rules.
The Promotions API from Spree Commerce — 11 operation(s) for promotions.
The Roles API from Spree Commerce — 2 operation(s) for roles.
The Shipments API from Spree Commerce — 9 operation(s) for shipments.
The Shipping Categories API from Spree Commerce — 2 operation(s) for shipping categories.
The Shipping Methods API from Spree Commerce — 2 operation(s) for shipping methods.
The States API from Spree Commerce — 2 operation(s) for states.
The Stock Items API from Spree Commerce — 2 operation(s) for stock items.
The Stock Locations API from Spree Commerce — 2 operation(s) for stock locations.
The Store Credit Categories API from Spree Commerce — 2 operation(s) for store credit categories.
The Store Credit Types API from Spree Commerce — 2 operation(s) for store credit types.
The Store Credits API from Spree Commerce — 2 operation(s) for store credits.
The Stores API from Spree Commerce — 1 operation(s) for stores.
The Stripe API from Spree Commerce — 4 operation(s) for stripe.
The Tax Categories API from Spree Commerce — 2 operation(s) for tax categories.
The Tax Rates API from Spree Commerce — 2 operation(s) for tax rates.
The Taxonomies API from Spree Commerce — 2 operation(s) for taxonomies.
The Taxons API from Spree Commerce — 5 operation(s) for taxons.
The Token API from Spree Commerce — 1 operation(s) for token.
The Users API from Spree Commerce — 2 operation(s) for users.
The Variants API from Spree Commerce — 3 operation(s) for variants.
The Vendors API from Spree Commerce — 10 operation(s) for vendors.
The Webhook Events API from Spree Commerce — 1 operation(s) for webhook events.
The Webhook Subscribers API from Spree Commerce — 2 operation(s) for webhook subscribers.
The Wished Items API from Spree Commerce — 2 operation(s) for wished items.
The Wishlists API from Spree Commerce — 9 operation(s) for wishlists.
The Wishlists / Wished Items API from Spree Commerce — 5 operation(s) for wishlists / wished items.
The Zones API from Spree Commerce — 2 operation(s) for zones.
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
Published pricing tiers and plan structures.
Documented rate limits and quota policies.
Cost, billing, and metering signals for API financial operations.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Recommended x-agentic-access execution contracts for AI agents.
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.
accessModel:
pricing: freemium
onboarding: self-serve
trial: false
try_now: true
public: false
label: Freemium · Self-serve signup
confidence: high
source:
- plans
- authentication
generated: '2026-07-22'
method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/spree-commerce.png
tags:
- Commerce
- Headless
- eCommerce
- Open Source
- Ruby on Rails
- Ruby
- TypeScript
created: '2026-05-25'
modified: '2026-07-25'
specificationVersion: '0.19'
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:
- 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
- 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
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:
- 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
- Rails
- Ruby
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:
- 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
- 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-configuration-api
name: Spree Commerce Configuration API
description: Store configuration — payment methods, tag autocomplete
humanURL: https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
baseURL: https://demo.spreecommerce.org
tags:
- Configuration
properties:
- type: OpenAPI
url: openapi/spree-commerce-configuration-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.s
# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spree-commerce/refs/heads/main/apis.yml