Spree Commerce

Spree Commerce Configuration API

Store configuration — payment methods, tag autocomplete

GitHub OpenAPI

Operations 27

GET /api/v3/admin/admin_users List staff #
GET /api/v3/admin/admin_users/{id} Show a staff member #
PATCH /api/v3/admin/admin_users/{id} Update a staff member #
DELETE /api/v3/admin/admin_users/{id} Remove a staff member from this store #
GET /api/v3/admin/api_keys List API keys #
POST /api/v3/admin/api_keys Create an API key #
GET /api/v3/admin/api_keys/{id} Show an API key #
DELETE /api/v3/admin/api_keys/{id} Delete an API key #
PATCH /api/v3/admin/api_keys/{id}/revoke Revoke an API key #
GET /api/v3/admin/invitations List invitations #
POST /api/v3/admin/invitations Create an invitation #
DELETE /api/v3/admin/invitations/{id} Revoke an invitation #
PATCH /api/v3/admin/invitations/{id}/resend Resend an invitation #
GET /api/v3/admin/payment_methods List payment methods #
GET /api/v3/admin/payment_methods/types List available payment provider types #
GET /api/v3/admin/payment_methods/{id} Show a payment method #
GET /api/v3/admin/roles List roles #
GET /api/v3/admin/stock_locations List stock locations #
POST /api/v3/admin/stock_locations Create a stock location #
GET /api/v3/admin/stock_locations/{id} Get a stock location #
PATCH /api/v3/admin/stock_locations/{id} Update a stock location #
DELETE /api/v3/admin/stock_locations/{id} Delete a stock location #
GET /api/v3/admin/store_credit_categories List store credit categories #
GET /api/v3/admin/store_credit_categories/{id} Get a store credit category #
GET /api/v3/admin/store Get the current store #
PATCH /api/v3/admin/store Update the current store #
GET /api/v3/admin/tags List tags #

Documentation

📖
Documentation
https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
📖
Documentation
https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
📖
Documentation
https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
📖
Documentation
https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
📖
Documentation
https://dev-docs.spreecommerce.org/api-reference/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/spree-commerce/refs/heads/main/openapi/spree-commerce-configuration-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/spree-commerce-configuration-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

spree-commerce-configuration-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Admin Configuration API
  contact:
    name: Spree Commerce
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  description: Spree Admin API v3 - Administrative API for managing products, orders, and store settings.
  version: v3
servers:
- url: http://{defaultHost}
  variables:
    defaultHost:
      default: localhost:3000
tags:


# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spree-commerce/refs/heads/main/openapi/spree-commerce-configuration-api-openapi.yml