Developers

Blink Business API

Quote, book and track deliveries from your store or system. Sandbox, scoped keys, idempotency and signed webhooks.

Download openapi.yamlGet an API key

Changelog

  1. Developer platform
    • Sandbox: blink_test_ keys create sandbox orders that a simulator moves to delivered with a fake rider and proof of delivery, firing real webhooks. Never dispatched, billed or counted in reports. POST /v1/sandbox/orders/{code}/status forces a status.
    • API keys v2: names, scopes (orders:read, orders:write, quotes, webhooks, reports), expiry, IP allowlist, last used. Publishable pk_ keys for widgets, limited to quotes and allowed domains.
    • Idempotency-Key on every POST/PATCH under /v1: replays for 24 h, 422 on a different body, 409 while in flight.
    • Webhooks v2: up to 20 endpoints per business with per-endpoint secrets, event filters and live/test mode; delivery log with attempts, latency and responses; replay, send test event; dead-letter after max attempts. X-Blink-Signature-V2 (timestamped) alongside the unchanged X-Blink-Signature.
    • Embeddable delivery-fee/ETA widget (widget.js) and booking widget (iframe) with optional merchant approval.
    • SDKs for TypeScript, PHP and Python; WooCommerce plugin with live rates and auto-booking.
    • Recurring runs can book ahead as scheduled orders (leadMin); calendar of scheduled and recurring orders; remembered spreadsheet import mappings.
    • OpenAPI spec now covers every business endpoint, including stops, plan-day, recurring and recipients.
  2. Plan my day & recurring runs
    • POST /v1/business/plan-day splits up to 200 drop-offs from up to 5 pickups into vehicle runs; /plan-day/book books them.
    • Recurring runs (/v1/business/recurring) book a saved order on chosen weekdays; recurring.booked / recurring.failed webhooks.
    • Recipient book: GET /v1/business/recipients.
  3. Multi-stop orders & management tools
    • Up to 20 stops with items, time windows, per-stop COD and references; stop.* webhooks.
    • Edit, add, cancel and re-attempt stops on your own orders; automatic return trips.
    • Stop reports and delivery performance: GET /v1/business/reports/stops.
  4. API v2
    • 8 vehicle tiers with free wait time and wait fees.
    • optimize, priorityFeeSen and scheduledAt on quotes and orders; trackUrl on orders and webhooks.
    • Public tracking (/v1/track/{token}) and tracking WebSocket.
    • Cancellation fees after assignment; route optimisation endpoint; saved places; chat.