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 Product Catalog API

Products, variants, and option types

Documentation Provider Profile APIs.io OpenAPI GitHub

Spree Commerce Product Catalog 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 Product Catalog. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 26 operations across 17 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version v3.

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

26 operations 17 paths 22 schemas 4 DELETE11 GET3 PATCH8 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 Product Catalog 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 26

Across 17 paths, the API surfaces 26 operations — 4 DELETE, 11 GET, 3 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Product Catalog 26

Products, variants, and option types

GET
/api/v3/admin/option_types
List option types
7 params → 200401
POST
/api/v3/admin/option_types
Create an option type
2 params body → 201422
GET
/api/v3/admin/option_types/{id}
Get an option type
5 params → 200404
PATCH
/api/v3/admin/option_types/{id}
Update an option type
3 params body → 200422
DELETE
/api/v3/admin/option_types/{id}
Delete an option type
3 params → 204
GET
/api/v3/admin/products
List products
9 params → 200401
POST
/api/v3/admin/products
Create a product
2 params body → 201422
GET
/api/v3/admin/products/{id}
Get a product
5 params → 200404
PATCH
/api/v3/admin/products/{id}
Update a product
3 params body → 200422
DELETE
/api/v3/admin/products/{id}
Delete a product
3 params → 204
POST
/api/v3/admin/products/bulk_status_update
Bulk-update product status
2 params body → 200422
POST
/api/v3/admin/products/bulk_add_to_categories
Bulk-add products to categories
2 params body → 200
POST
/api/v3/admin/products/bulk_remove_from_categories
Bulk-remove products from categories
2 params body → 200
POST
/api/v3/admin/products/bulk_add_tags
Bulk-add tags to products
2 params body → 200
POST
/api/v3/admin/products/bulk_remove_tags
Bulk-remove tags from products
2 params body → 200
DELETE
/api/v3/admin/products/bulk_destroy
Bulk-delete products
2 params body → 200
GET
/api/v3/admin/products/{product_id}/variants
List product variants
7 params → 200
POST
/api/v3/admin/products/{product_id}/variants
Create a variant
3 params body → 201422
GET
/api/v3/admin/products/{product_id}/variants/{id}
Get a variant
6 params → 200404
PATCH
/api/v3/admin/products/{product_id}/variants/{id}
Update a variant
4 params body → 200
DELETE
/api/v3/admin/products/{product_id}/variants/{id}
Delete a variant
4 params → 204
GET
/api/v3/store/categories
List categories
5 params → 200401
GET
/api/v3/store/categories/{id}
Get a category
4 params → 200404401
GET
/api/v3/store/products
List products
13 params → 200401
GET
/api/v3/store/products/{id}
Get a product
4 params → 200404
GET
/api/v3/store/products/filters
Get product filters
3 params → 200401

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are Variant (38 properties), Product (35 properties), Product_2 (27 properties), Category (27 properties). Each schema is shown below with its type and property counts.

CustomField
object
10 properties 10 required
Variant
object
38 properties 32 required
Price
object
13 properties 12 required
PaginationMeta
object
9 properties 7 required
StockItem
object
12 properties 10 required
OptionValue
object
13 properties 12 required
StockLocation
object
25 properties 25 required
ErrorResponse
object
1 property 1 required
Category
object
27 properties 23 required
OptionType
object
10 properties 9 required
Media
object
22 properties 22 required
Product
object
35 properties 27 required
PriceHistory
object
10 properties 10 required
CustomField_2
object
6 properties 6 required
Variant_2
object
21 properties 17 required
Price_2
object
9 properties 9 required
OptionValue_2
object
9 properties 9 required
Category_2
object
21 properties 17 required
OptionType_2
object
5 properties 5 required
Media_2
object
16 properties 16 required
Product_2
object
27 properties 19 required
PriceHistory_2
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spree-commerce-product-catalog-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
#Product Catalog
← Back to S APIs
API Details
ID
spree-commerce:spree-commerce-product-catalog-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-product-catalog-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/spree-commerce-product-catalog-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 Product Catalog 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.