spree-api-v3
Installation
SKILL.md
Spree API v3
Before writing code
Fetch live docs:
- Fetch https://spreecommerce.org/docs/api-reference for the v3 API index.
- Fetch the OpenAPI spec for the Spree version you target — it ships per release. Find the link on the API reference page.
- Fetch the v5.4 announcement (https://spreecommerce.org/announcing-spree-commerce-5-4/) for the design rationale.
- Inspect the live Spree source under
app/controllers/spree/api/v3/for the canonical request/response shape per endpoint. - Check the rate-limit configuration in
config/initializers/spree.rbfor the deployment you're targeting.
Conceptual Architecture
Two APIs, One Generation
| API | Path | Auth | Audience |
|---|---|---|---|
| Store API | /api/v3/store/* |
Publishable key (pk_…) + per-user JWT bearer |
Customers, storefronts |
| Admin API | /api/v3/admin/* |
Per-user API keys + OAuth2 (Doorkeeper) | Admin, operations, server-to-server |