Endpoint Reference
Base URL: /api/v1
Submissions
| Method | Path | Description |
|---|
| GET | /submissions | List submissions (paginated) |
| POST | /submissions | Create a submission |
| GET | /submissions/:id | Get submission + items |
| PATCH | /submissions/:id | Transition state |
Status values
pending_review → accepted → awaiting_delivery → received → completed
rejected is a terminal state reachable from any non-terminal status.
Transition actions
| Action | From → To |
|---|
approve | pending_review → accepted (advances one step from any non-terminal state) |
markReceived | accepted → awaiting_delivery or awaiting_delivery → received |
markCompleted | received → completed |
reject | any → rejected |
Pricing Rules
| Method | Path | Description |
|---|
| GET | /pricing-rules | List rules |
| POST | /pricing-rules | Create rule |
| GET | /pricing-rules/:id | Get rule |
| PATCH | /pricing-rules/:id | Update rule |
| DELETE | /pricing-rules/:id | Delete rule |
API Keys
| Method | Path | Description |
|---|
| GET | /api-keys | List keys (full scope required) |
| POST | /api-keys | Create key (full scope required) |
| GET | /api-keys/:id | Get key |
| DELETE | /api-keys/:id | Revoke key |
Webhooks
| Method | Path | Description |
|---|
| GET | /webhooks | List subscriptions |
| POST | /webhooks | Create subscription |
| GET | /webhooks/:id | Get subscription |
| DELETE | /webhooks/:id | Revoke subscription |
| GET | /webhooks/:id/deliveries | List recent deliveries |
Customer Sessions
| Method | Path | Description |
|---|
| POST | /customer-sessions | Issue 1-hour customer JWT |
OpenAPI Spec
Machine-readable spec available at GET /api/v1/openapi.json.