API reference
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 documents every endpoint, generated from the same specification.
Sending an API key
Examples use x-api-key: pk.... Agent tokens use Authorization: Bearer, from code rather than this console.
Base URL
| Environment | URL |
|---|---|
| Local development | http://localhost:3005/v1 |
| Production | https://api.prood.com/v1 |
OpenAPI spec
Download the raw specification:
GET /v1/openapi.jsonEach operation below has its own page, built from this spec.
Authentication
All endpoints require authentication except /v1/health and /v1/openapi.json. See Authentication for details on:
- Session cookies (dashboard)
x-storefront-hostheader (storefront)- API keys (
x-api-key) - Agent JWT (
Authorization: Bearer)
Endpoint groups
The pages below are organized by OpenAPI tags:
| Tag | Scope | Description |
|---|---|---|
| Storefront | storefront | Products, categories, store info, carts, shipping, placing an order, order history. Coupon routes exist, but no merchant can create coupons yet |
| Admin | admin | Reads and changes catalog, inventory, orders and store settings, and reads customers. Payment accounts, domains, team and keys stay in the dashboard. Starts on Grow. |
| 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
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 |