How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Spree Commerce

Spree Commerce Configuration API

Store configuration — payment methods, tag autocomplete

Documentation Provider Profile APIs.io OpenAPI GitHub

Spree Commerce Configuration API is one of 183 APIs that Spree Commerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Configuration. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 27 operations across 18 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version v3.

Requests are made against a single base URL, http://{defaultHost}.

27 operations 18 paths 5 schemas 4 DELETE15 GET5 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v3
Base URL
https://demo.spreecommerce.org
Authentication
API Key, HTTP Bearer
Contact
Spree Commerce
Resource Areas
1

Authentication & Security 2

Spree Commerce Configuration API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-spree-api-key (api_key). It accepts HTTP bearer tokens (JWT) (bearer_auth).

  • api_key — Secret API key for admin access
  • bearer_auth — JWT token for admin user authentication

Paths & Operations 27

Across 18 paths, the API surfaces 27 operations — 4 DELETE, 15 GET, 5 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Configuration 27

Store configuration — payment methods, tag autocomplete

GET
/api/v3/admin/admin_users
List staff
2 params → 200
GET
/api/v3/admin/admin_users/{id}
Show a staff member
3 params → 200
PATCH
/api/v3/admin/admin_users/{id}
Update a staff member
3 params body → 200
DELETE
/api/v3/admin/admin_users/{id}
Remove a staff member from this store
3 params → 204
GET
/api/v3/admin/api_keys
List API keys
2 params → 200
POST
/api/v3/admin/api_keys
Create an API key
2 params body → 201422
GET
/api/v3/admin/api_keys/{id}
Show an API key
3 params → 200
DELETE
/api/v3/admin/api_keys/{id}
Delete an API key
3 params → 204
PATCH
/api/v3/admin/api_keys/{id}/revoke
Revoke an API key
3 params → 200
GET
/api/v3/admin/invitations
List invitations
2 params → 200
POST
/api/v3/admin/invitations
Create an invitation
2 params body → 201
DELETE
/api/v3/admin/invitations/{id}
Revoke an invitation
3 params → 204
PATCH
/api/v3/admin/invitations/{id}/resend
Resend an invitation
3 params → 200
GET
/api/v3/admin/payment_methods
List payment methods
4 params → 200
GET
/api/v3/admin/payment_methods/types
List available payment provider types
2 params → 200
GET
/api/v3/admin/payment_methods/{id}
Show a payment method
5 params → 200
GET
/api/v3/admin/roles
List roles
2 params → 200
GET
/api/v3/admin/stock_locations
List stock locations
10 params → 200401
POST
/api/v3/admin/stock_locations
Create a stock location
2 params body → 201422
GET
/api/v3/admin/stock_locations/{id}
Get a stock location
4 params → 200404
PATCH
/api/v3/admin/stock_locations/{id}
Update a stock location
3 params body → 200422
DELETE
/api/v3/admin/stock_locations/{id}
Delete a stock location
3 params → 204
GET
/api/v3/admin/store_credit_categories
List store credit categories
7 params → 200401
GET
/api/v3/admin/store_credit_categories/{id}
Get a store credit category
4 params → 200404
GET
/api/v3/admin/store
Get the current store
2 params → 200401
PATCH
/api/v3/admin/store
Update the current store
2 params body → 200422
GET
/api/v3/admin/tags
List tags
4 params → 200422

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are StockLocation (25 properties), Store (15 properties), PaginationMeta (9 properties), StoreCreditCategory (5 properties). Each schema is shown below with its type and property counts.

Store
object
15 properties 15 required
PaginationMeta
object
9 properties 7 required
StockLocation
object
25 properties 25 required
StoreCreditCategory
object
5 properties 5 required
ErrorResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spree-commerce-configuration-api-openapi.yml Raw ↑

Other APIs Spree Commerce publishes across the network.

Spree Webhooks
AE Profile APIs.io
@spree/sdk (TypeScript Store API SDK)
AE Profile APIs.io
@spree/admin-sdk (TypeScript Admin API SDK)
AE Profile APIs.io
@spree/cli
AE Profile APIs.io
create-spree-app
AE Profile APIs.io
Spree Next.js Storefront
AE Profile APIs.io
Spree Rails Storefront
AE Profile APIs.io
spree-starter (Application Template)
AE Profile APIs.io
spree-multi-store
AE Profile APIs.io
Spree Stripe Integration
AE Profile APIs.io
Spree Adyen Integration
AE Profile APIs.io
Spree PayPal Checkout Integration
AE Profile APIs.io
#Configuration
← Back to S APIs
API Details
ID
spree-commerce:spree-commerce-configuration-api
Base URL
https://demo.spreecommerce.org
Docs
https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
Provider
Spree Commerce
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=spree-commerce-configuration-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/spree-commerce-configuration-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Spree Commerce Configuration API, 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.