Orders API fields and multi-stop payloads
Required order structure and how to model intermediate stops.
This article explains required order payload structure and how to model multi-stop routes without breaking tracking.
What this is
Order creation requires canonical pickup/dropoff anchors with optional intermediate stops for route expansion.
What to provide
pickupanddropofflocation objects.vehicleTypeIdas canonical vehicle type identifier.contact,notes, and optionalscheduledTime.paymentMethod, optionalcashPayer, and selected extras where applicable.stopsfor intermediate waypoints when needed.
What happens next
- Validate payload and route order before submitting to avoid dispatch corrections.
- Keep
stopsfor intermediate waypoints only; do not duplicate pickup/dropoff. - Maintain real-world stop sequence to preserve tracking integrity and ETA behavior.
Validate route and stop order before submission to avoid downstream dispatch corrections.
Was this article helpful?
Related articles
API access quickstart and authentication
How to start integration access and understand current authentication modes.
Status updates, retries, and webhook strategy
Current status retrieval pattern and recommended retry behavior.
API security, rate limits, idempotency, and support
Integration hardening practices for production-safe API clients.
← Back to API and Integrations
Still need help? Contact support