Skip to main content
The Droplinked API is a REST API over JSON. The endpoint pages in this section are generated from the production OpenAPI specification (droplinked Core API, v2.0.1) and grouped by domain — shops, products, collections, carts, orders, customers, shipping, and more.

​
Base URL

See Environments for every surface, and for the current state of the development plane.

​
Authentication

  • Public read endpoints need no credentials.
  • Shop API key — x-droplinked-api-key: <key>.
  • Merchant / customer JWT — Authorization: Bearer <token>.
  • Integration Services — integration-api-key: <key> (server-to-server only).
See Authentication for how to obtain and rotate each.

​
Response envelope

Success — the payload is always in data:
Error — a different shape. Note the extra status field and that the human-readable message sits one level deeper, inside data:
Parse errors as body.data.message, not body.message. A client that only reads body.message will log undefined for every failure. The full catalogue is on Errors.

​
Pagination

List endpoints take ?page= and ?limit=, and return a page object inside data — so the array of rows is at data.data:
Page until hasNextPage is false rather than computing totalPages yourself — some collections are filtered after the count.

​
Conventions

  • Versioned resources use v2 / -v2 paths (shops/v2, product-v2, v2/orders).
  • Timestamps are ISO-8601 UTC.
  • Money is expressed in the shop’s currency; resolve the currency from the shop or from the checkout intent resolver rather than assuming USD.
  • Rate limits and 429 semantics: Rate limits.

​
Trying requests

The rendered reference covers the 83 paths / 108 operations published in the OpenAPI specification. The platform mounts a larger surface than that — partner-relevant routes that are not yet in the spec are documented by hand elsewhere in these docs (for example Webhooks and Merchant PSP onboarding). If you need a route that appears in neither place, ask rather than inferring it.