Skip to main content

Orders API fields and multi-stop payloads

Required order structure and how to model intermediate stops.

M
Written by Max Valjan
Updated today

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

  • `pickup` and `dropoff` location objects.

  • `vehicleTypeId` as canonical vehicle type identifier.

  • `contact`, `notes`, and optional `scheduledTime`.

  • `paymentMethod`, optional `cashPayer`, and selected extras where applicable.

  • `stops` for intermediate waypoints when needed.

What happens next

  • Validate payload and route order before submitting to avoid dispatch corrections.

  • Keep `stops` for 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.

Did this answer your question?