Docs › Getting started

Introduction

What the Dragonfly Partner API does and how orders flow.

The Dragonfly Partner API lets approved merchants — and the systems and AI agents that work for them — send delivery orders straight into Dragonfly. Orders land in your Dragonfly account exactly like orders placed in the merchant portal. Dragonfly dispatches them to professional drivers, or builds the day's optimized routes from them, then reports status back to you in real time.

What you can do

  • Send orders — a single catering or on-demand drop, or a multi-stop route of up to 25 stops.
  • Track them — poll an order's status, or receive signed webhooks for every pickup, dropoff, proof-of-delivery photo, failure and cancellation.
  • Cancel before pickup.
  • Require proof — signature, photo, an ID/age check, a PIN code, barcode scans or an item checklist at any stop.
  • Automate with AI — an MCP server, a CLI, an OpenAPI 3.1 spec and an llms.txt let coding agents and LLM agents integrate without a human reading docs.

How an order flows

  1. Your system calls POST /v1/orders with your own order id (externalId), a pickup and one or more dropoffs.
  2. Dragonfly stores the order in your account and answers immediately with an orderId and a status.
  3. Depending on your account's routing mode:

- Dispatched on receipt — a single drop goes to a driver right away, and a multi-stop order goes out as one route. - Routed by Dragonfly — the order waits while Dragonfly builds the day's optimized routes from all of your orders. Once a route is assigned, your order follows its own stop.

  1. You receive status changes through webhooks or by polling. Every delivery ends with a proof of delivery: photo, signature, or both.
  2. Billing follows your account's rate card. Your API calls never carry a price.

Base URL

text
https://api.trydragonfly.com

All endpoints are versioned under /v1. Requests and responses are JSON. All money is in integer cents, and all timestamps are ISO 8601.

Who can use it

Only approved merchants can send live orders. Anyone can get a sandbox key in one request to build and test against simulated deliveries. See Getting access.

Next steps

Next →Quickstart (5 minutes)

Something unclear or missing? Tell us.