API Reference
Interactive OpenAPI documentation for the Prood Commerce REST API v1.
The Commerce API exposes a RESTful interface at /v1/* with a machine-readable OpenAPI 3.1 specification. This section provides interactive documentation for every endpoint — generated automatically from the API's Zod schemas via Fumadocs OpenAPI.
Base URL
| Environment | URL |
|---|---|
| Local development | http://localhost:3005/v1 |
| Production | https://api.example.com/v1 |
OpenAPI spec
Download the raw specification:
GET /v1/openapi.jsonThe docs site syncs this spec at build time (pnpm sync:openapi) and renders each operation as an interactive page below.
Authentication
All endpoints require authentication except /v1/health and /v1/openapi.json. See Authentication for details on:
- Session cookies (dashboard)
- Host header (storefront)
- API keys (
x-api-key) - Agent JWT (
Authorization: Bearer)
Endpoint groups
The pages below are organized by OpenAPI tags:
| Tag | Scope | Description |
|---|---|---|
| Catalog | storefront | Products, categories, store info, countries |
| Carts | storefront | Cart CRUD, coupons, shipping, place order |
| Orders | storefront | Customer order history |
| Admin | admin | Product/order/customer CRUD, inventory, stats |
| Webhooks | checkout-secret | Payment webhook ingress |
Using the reference
Each operation page includes:
- Description — what the endpoint does
- Parameters — path, query, and header parameters with types
- Request body — JSON schema for POST/PATCH requests
- Responses — status codes and response schemas
- Try it — execute requests against your local or production API
Client libraries
| Client | Package | Description |
|---|---|---|
| TypeScript | @prood/api-client | Typed fetch client generated from this spec |
| MCP | Built-in | /mcp endpoint exposes tools mirroring these operations |
| Agent Auth | Built-in | Each operationId becomes an agent capability |