API Keys for Delivery Planning: Connect Your Warehouse or TMS
StopSorted API keys let your warehouse or TMS create runs, add stops, and sort them without opening the Fleet dashboard. Learn how to set up and use them.
Your warehouse system shouldn't need a dashboard login
If you run a warehouse or use a transport management system (TMS), you already have a system of record for orders. But when it's time to plan the day's deliveries, someone still has to open a separate dashboard, type in stops, and hit sort. That's double entry, and it's where mistakes creep in.
Every manual touch adds delay. A driver waits for a run sheet. The office chases updates. And if you're paying per driver phone, idle time still costs you.
This article shows how StopSorted API keys let your own systems create runs, add stops, and sort them — without anyone opening the Fleet dashboard. You'll learn how to set up a key, use it safely, and see what changes for your team.
How it works
Think of an API key as a secure pass that lets your software talk to StopSorted. Each key belongs to your fleet only. You create it once, store it safely, and then your warehouse or TMS can send delivery stops directly into StopSorted.
Once stops are in, StopSorted sorts them into the best order for real roads. Your drivers see numbered stops on their phones. The office sees the live map. No one had to log into the dashboard to make that happen.
You can have multiple keys — one per integration. That way, if you stop using a TMS, you revoke just that key without affecting anything else.
Step-by-step: create and use your first key
- Open Devices in the Fleet dashboard.
- Under API keys, click + Create key.
- Give it a short label, like “Warehouse TMS”. This helps you remember what it's for.
- Copy the full key immediately. It's only shown once. Store it in your password manager or secrets vault.
- In your system, add the header
Fleet-API-Key: ss_…to planning API calls. - Use the key to create runs, add stops, and trigger sorting.
That's it. Your system can now push delivery jobs straight into StopSorted.
For full examples, see the Public API guide on the server docs (docs/PUBLIC_API.md).
What the driver sees vs what the office sees
Driver: Opens the StopSorted app on their approved phone. Sees a numbered list of stops in the sorted order. Can tap to open Google Maps or Waze, or use in-app turns. No dashboard, no manual sorting.
Office/controller: Sees a live map of all runs. Can track progress, see arrival times, and share a tracking link with customers if needed. No need to touch the planning API — that's handled by the warehouse or TMS.
Customer: Gets a tracking link if you choose to share one. Sees where their delivery is.
Everyone gets what they need without extra calls or double entry.
A realistic example
Before: A warehouse manager exports orders from the TMS, opens the StopSorted dashboard, and manually enters 25 stops. Takes 30 minutes. Then sorts. If a new order comes in, they repeat the process. Drivers wait for run sheets.
After: The TMS uses a StopSorted API key to send new orders automatically as they're confirmed. StopSorted sorts them. Drivers see updated runs on their phones. The warehouse manager doesn't touch the dashboard. New orders are added without rework. The office sees the live map.
Result: Less manual work, fewer errors, faster dispatch. No one had to log into a separate system.
FAQs
Do I need a separate key for each driver? No. API keys are for systems, not people. Create one key per integration (like your TMS or warehouse system). Drivers use the app with their approved phones — they don't need keys.
What if a key is compromised? Revoke it immediately under Devices → API keys. Revoked keys stop working right away. Then create a new key and update your system.
Can I use the same key for multiple systems? It's better to use one key per integration. That way you can revoke one without breaking others. It also makes it easier to track usage.
How do I handle driver phones? Device activation for phones still uses access requests in the app. Don't paste API keys into the portal for phones — that's not what they're for. Drivers request access, and you approve them.
Safety first
- Never put a key in a public repo, driver phone, or shared chat.
- Store keys in a password manager or secrets vault.
- Prefer one key per integration.
- Revoke keys when an integration ends.
For more details, see our guide on API keys.
Ready to connect your systems?
StopSorted API keys are available on all paid plans. If you're not sure which plan fits, check our pricing — fleet pricing starts at $69/month for 2 phones, then $20/month per extra phone that runs. Solo is $24.99/month on Google Play.
Want to see how it works end-to-end? Visit how it works.
Coverage grows country-by-country. Australia is live today. If you're elsewhere, request your country.
Stop double entry. Let your systems talk to StopSorted.
Ready to try this on your fleet?
Create a free fleet account, approve the phones that will run, and sort the first morning. You add a card only when you turn on paid seats. Pricing is by phone that runs, not by login.
Office staff start at the landing page. Solo drivers can get the Android app.
How-to
Step-by-step for this topic: fleet/api keys.