Armada Armada API v2

Automated Ordering API v2

Send deliveries from your platform to Armada drivers, track their lifecycle through webhooks, and reconcile spend through the merchant wallet. One HMAC-signed REST API, official SDKs for Node / PHP / Go, and a CLI that wraps all three.

Start here
Quickstart
Go from zero to a delivered test order in about five minutes.
Basics
Authentication & signing
How the HMAC headers are computed and why. Includes worked examples.
Resource
Deliveries
Create, track, cancel, retry orders. Address formats, status lifecycle, webhooks.
Tools
SDKs & CLI
One-line install straight from GitHub. Node, PHP, Go, and an armada CLI.

What's in v2

  • Merchant-scoped API keys with per-capability permissions (read deliveries, create deliveries, cancel, retry, invoices, wallet).
  • HMAC-SHA256 signing on every request — a leaked key alone doesn't let anyone dispatch on your behalf.
  • Multi-country address formats — location (lat/lng), Kuwait, Bahrain, KSA full, KSA short.
  • Webhooks for every state transition: accepted, en_route, completed, failed, canceled.
  • Test mode — flag a key as test, and every order that key creates is simulated end-to-end. A bot driver plays the dispatched → en_route → completed lifecycle in ~30 seconds, no real driver is dispatched, no wallet charge. Orders appear in your normal dashboard with a "Test" badge. Turn Test mode off on the same key when you're ready to go live — no second environment, no migration.

Conventions used across this site

  • Base URL is https://api.armadadelivery.com (production). Examples use this URL by default. An isolated sandbox deployment exists at https://sandbox.api.armadadelivery.com if you need full data separation, but the standard integration path is production + a Test-mode key.
  • All IDs are 24-character hex Mongo ObjectIds.
  • Timestamps are ISO-8601 UTC unless labelled otherwise. Signing uses milliseconds since epoch, not ISO.
  • Request + response bodies are always JSON.
  • Every example on this site ships with curl, Node (@armada/sdk), PHP (armada/sdk), and Go variants.
Quickstart →