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
- Switch from Locksmith : Import your Locksmith locks and keys into Shopbird, check them, and switch over without a gap.
- Receive webhooks : Get a signed POST when locks, audiences, codes, drops or syncs change.
- Grant access from a bot or CRM : Tag a customer from a Discord bot or CRM so a tag audience lets them in.
- Run a drop by API : Create a raffle drop, wait for its locks, follow its stages and draw the winners.
- Check access from the storefront : Ask from theme code whether pages are locked for the current shopper.
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.