Skip to main content
Three ways to consume the droplinked API spec:

Live spec

OpenAPI 3.0 JSON

Public, always-current. Re-generated on each backend deploy from the NestJS controller decorators. Used by this Mintlify reference + the MCP server + any agent tooling.

Swagger UI (interactive)

Rendered HTML Swagger UI for trying requests directly against prod with your API key. Same data as the JSON above.

Code generation

Agent SDK setup

For Claude Code / Cursor / GitHub Copilot — add this docs site as an MCP server (see the floating contextual toolbar in the bottom-right of every page for one-click “Add to MCP” buttons). Or wire the OpenAPI JSON directly into your agent’s tool definitions:

MCP Server

droplinked exposes its public APIs to agents via MCP — see the dedicated page for tools available + connection instructions.

Spec stats

  • OpenAPI version: 3.0.0
  • Total endpoints: 83+ (verified live)
  • Auth: API key via X-API-Key header for public endpoints, JWT for merchant scope, customer-JWT for guest-checkout scope
  • Versioning: per-module (v2 suffix where present, e.g., /shops/v2, /customer-v2, /v2/carts, /v2/orders)
  • Updated: on every backend deploy (re-generated from NestJS @ApiTags decorators)

Stability + change policy

Endpoint contracts are stable across patch + minor backend releases. Major version bumps (e.g., v2 → v3) appear under new module paths to keep current clients green. Subscribe to backend repo’s release notes for breaking-change advance notice.