If you build against the CoCart REST API, you no longer have to hand-roll requests from the documentation. We’ve published official OpenAPI 3.0.3 specifications covering the entire CoCart ecosystem, available now at github.com/cocart-headless/cocart-openapi.
What’s in the spec
The specs are organized by plugin and API version, so you only need to import what you’re actually using:
- CoCart Starter — API v2, reflecting the upcoming CoCart Starter tier.
- CoCart Community — API v2, the stable community release, reflecting v4.9.0
- CoCart Community — API v1 (legacy, no longer supported), reflecting v4.9.0 — kept available for anyone still integrating against v1.
- CoCart Plus — API v1, reflecting CoCart Plus 1.6.0 — 22 paths covering coupons, fees, shipping and payment methods, weight, removed items, quantities, cross-sells, calculations, and the full totals breakdown.
- CoCart Plus — API v2 (in development, tracking the upcoming v2.0.0) — 27 paths covering the new cart operations, product shipping calculation, My Account (address, orders, downloads, subscriptions), customer registration, and checkout.
- CoCart JWT Authentication, reflecting v3.0.2 — token refresh and validation, with rate limiting and PAT session management documented.
Every plugin directory gives you a choice: a single collection file with everything in one spec, or endpoint-specific files if you’d rather import just Cart, or just Products, and so on.
Why this matters
Each spec comes pre-configured so you’re not filling in the blanks yourself:
- Every endpoint, organized into folders by tag
- Query, path, and header parameters already set up
- JSON request body templates generated from the schema definitions
- Authentication schemes (Basic Auth, Bearer Token) ready to wire up with your own credentials
- A server URL variable so you just swap in your store’s domain instead of editing every request
Import a spec into your client of choice, point the host variable at your store, plug in your credentials, and you have a working request collection for the entire CoCart API in minutes instead of hours.
Using them
The specs are plain OpenAPI 3.0.3 YAML, so they work with anything that speaks OpenAPI:
- Yaak — import via Settings > Import
- Swagger UI
- Postman — import directly.
- Code generators like OpenAPI Generator
- Kiota, if you want to generate your own typed client.
A couple of things to know before you import: some parameters show type placeholders (<string>, <integer>) rather than sample values — that’s expected, replace them with real values for your store.
Get it
Clone or download from github.com/cocart-headless/cocart-openapi — the specs are licensed under GPL-3.0, same as CoCart itself.
If you’re using a code generator to build your own client from these specs, also see the CoCart SDKs currently in development on our organization profile — there’s a decent chance we’re already building what you’re about to generate. Feel free to join in.