Developer documentation
Dragonfly Partner API
Send delivery orders from your own system or AI agent. Orders land in your Dragonfly account; we dispatch them or build your day's routes, and report every step back over signed webhooks. Single catering drops and multi-stop routes, one API.
Your first order
- Get a sandbox key in one request. No approval needed.
- Create an order with your own order number as
externalId. - Follow it with webhooks or polling.
- Ready for real deliveries? Request production access.
bash
curl -s https://api.trydragonfly.com/v1/orders \
-H "Authorization: Bearer $DRAGONFLY_API_KEY" -H 'content-type: application/json' -d '{
"externalId": "order-1001",
"pickup": { "address": "100 W Randolph St, Chicago, IL 60601", "contactPhone": "+13125550100" },
"dropoff": { "address": "445 N Michigan Ave, Chicago, IL 60611", "contactName": "Reception",
"contactPhone": "+13125550111", "windowEnd": "2026-10-09T12:00:00-05:00" }
}'🚀 Getting started
- IntroductionWhat the Dragonfly Partner API does and how orders flow.
- Quickstart (5 minutes)Sandbox key, first order, first status read.
- Getting access & approvalSandbox, new businesses, and existing Dragonfly merchants.
- AuthenticationBearer API keys and HMAC-signed requests.
- Sandbox vs. productiondfk_test_ and dfk_live_ keys, simulated deliveries.
📦 Orders
- Create an orderPOST /v1/orders — single drops and multi-stop routes.
- The order object & statusesFields, lifecycle and dispatchedTo values.
- Stops, windows & addressesPickup and dropoff fields, time windows, time zones.
- Proof & requirementsSignature, photo, ID/age check, PIN, barcodes, item checklists.
- Dispatch vs. Dragonfly routingImmediate dispatch, or orders held for daily optimized routes.
- Track an orderGET /v1/orders/{externalId}.
- Cancel an orderPOST /v1/orders/{externalId}/cancel.
- Idempotency & retriesexternalId makes every create safe to retry.
📡 Webhooks
- Webhooks overviewRegister endpoints and receive signed delivery events.
- Event catalogEvery event, with Nash and Onfleet equivalents.
- Verifying signaturesdragonfly-signature / Svix-compatible verification.
- Retries & delivery logsRetry schedule, auto-disable, delivery attempts.
- Legacy callback URLSingle signed callback per API key.
🤖 AI agents & tools
🧭 Guides
🤖 Building with an AI agent?
Give your agent llms.txt and the OpenAPI spec, or plug in the MCP server. It can create its own sandbox key and test end to end.
Building with AI agents →