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

  • Spec title / version: droplinked Core API, 2.0.1
  • OpenAPI version: 3.0.0
  • Published surface: 83 paths / 108 operations
  • Auth schemes declared in the spec: BearerAuth (HTTP bearer, JWT) and ApiKeyAuth (header x-droplinked-api-key). Public read endpoints need neither. There is no X-API-Key header — see Authentication.
  • Versioning: per-module (v2 suffix where present, e.g. /shops/v2, /customer-v2, /v2/carts, /v2/orders)
  • Regenerated from the NestJS decorators on every backend deploy
The published spec is a subset of what the platform mounts. Partner-relevant routes that are not in it are documented by hand — see Webhooks and Merchant PSP onboarding. If a route appears in neither, ask rather than inferring it from a URL pattern.

How this reference is built

The API Reference tab renders api-reference/openapi.json, vendored in the docs repository, rather than fetching the live spec at build time. scripts/curate-openapi.py pulls the live production spec, groups tags, and rewrites the servers block. That rewrite is load-bearing: the upstream spec advertises a host that does not resolve, so without it every “Try it” request would fail before leaving the browser. A scheduled drift check fails when the vendored copy falls behind the live one.

Stability + change policy

Endpoint contracts are stable across patch and minor backend releases. Major version bumps (v2 → v3) appear under new module paths so current clients stay green. Change notice. The backend repository is private, so there is no release feed to subscribe to. Breaking changes that affect a partner integration are communicated directly to that partner’s technical contact ahead of the change. If you are integrating and are not on that list, ask your Droplinked counterpart to add you — that is currently the only notification channel, and we would rather say so than point you at a feed you cannot read.