Docs

Shopbird API docs

Automate locks, audiences, codes and drops from your own scripts, and get signed webhooks when things change. Included with every paid plan.

Requests go to https://app.shopbird.app/api/v1. Create a token in Shopbird under Settings > API access. The OpenAPI document is at /api/v1/openapi.json on the same host.

New here? Start with the quickstart.

Start

  • Quickstart : Create a token, list your locks and create a lock that checkout enforces.
  • Authentication : The token header, the token format and every scope.
  • Concepts : How versions, sync, ETags, retries, dry runs, pages, errors and limits work.
  • JavaScript SDK : Call the API and check webhook signatures from Node, Bun, Deno or Cloudflare Workers.
  • Python SDK : Call the API and check webhook signatures from Python 3.9 or later.

Guides

Reference

  • Locks : Every locks endpoint, with a request and a response.
  • Audiences : Every audiences endpoint, with a request and a response.
  • Codes : Every codes endpoint, with a request and a response.
  • Settings : Every settings endpoint, with a request and a response.
  • Sync : Every sync endpoint, with a request and a response.
  • Customers : Every customers endpoint, with a request and a response.
  • Access : Every access endpoint, with a request and a response.
  • Drops : Every drops endpoint, with a request and a response.
  • Webhooks : Every webhooks endpoint, with a request and a response.
  • Errors : Every error code, its status and what it means.
  • Changelog : Every change to the API, newest first.