API Reference

The platform exposes two API surfaces — an internal worker (staff, CF Access) and a platform worker (public, API key/OAuth). Both are documented as OpenAPI v3.1.0 specs organized by domain.

Open the interactive API viewer

Domain specs

Domain	Spec	Tables	Worker
Commerce	product	10	internal + platform
	order	12	internal + platform
	customer	4	internal + platform
	payment	7	internal + platform
	fulfillment	10	internal + platform
	promotion	6	internal + platform
	region	7	internal + platform
	store	3	internal
	inventory	5	internal + platform
	pricing	5	internal + platform
	return	7	internal + platform
Publisher	publisher	5	internal + platform
	ad-server	10	internal + platform
	membership	6	internal + platform
	settlement	7	internal
	invoice	3	internal
	dispute	5	internal
Platform	identity	5	internal
	governance	2	internal + platform
	macrodata	2	internal
Operational	analytics	—	internal
	creative-ops	—	internal
Webhooks	inbound	—	internal

Conventions

All specs follow these conventions:

• snake_case for JSON properties, path parameters, and query parameters
• Response envelope: { data: {...} } for single resources, { data: [...], pagination: {...} } for lists
• Cursor-based pagination: ?limit=20&cursor={opaque} with { limit, next_cursor, prev_cursor, has_more }
• Error responses: { error: { code, message, details } } with standard HTTP status codes
• Soft deletes: DELETE returns 204; resources are archived (archive_ts set), not removed
• Idempotency: POST endpoints accept Idempotency-Key header

Worker split

Worker	Base URL	Auth	Scope
internal	https://internal.bluntcases.com/api	CF Access (Google SSO)	Full CRUD, admin operations
platform	https://platform.bluntcases.com/v1	API key / OAuth	Public catalog, customer-facing

Specs annotate each operation with x-worker: [internal], x-worker: [platform], or both. See the path prefix conventions for how this maps to URL paths.

Shared components

Common schemas, parameters, and responses are extracted to _shared/components.yaml and referenced across all 23 specs:

• Parameters: Limit, Cursor, Order, Fields, Include, Search, IdempotencyKey
• Schemas: Pagination, Error, StatusJsonb, Labels, Annotations
• Responses: NotFound (404)