spree-api-v3
Installation
SKILL.md
Spree API v3
Spree 6 has three REST surfaces under /api/v3/, and they share one set of conventions:
| Surface | Path | Caller | Auth | Authorization |
|---|---|---|---|---|
| Store API | /api/v3/store/* |
Storefronts, mobile apps, shoppers | X-Spree-Api-Key: pk_… + optional Authorization: Bearer <jwt> (aud: store_api) + guest X-Spree-Token |
Ownership (see spree-auth-permissions) |
| Admin API | /api/v3/admin/* |
Integrations, back-office apps, the dashboard | X-Spree-Api-Key: sk_… or Authorization: Bearer <jwt> (aud: admin_api) |
Key scopes / role permission keys |
| Seller API | /api/v3/seller/* |
Marketplace seller panel | Seller JWT (aud: seller_api) + X-Spree-Seller-Id |
Seller role keys + current_seller scoping (see spree-marketplace) |
A token issued for one audience is rejected on the other surfaces. The v2 Storefront/Platform APIs don't exist in Spree 6. If you're migrating an old integration, see node_modules/@spree/docs/dist/api-reference/store-api/migrating-from-storefront-api-v2.md.