Skip to content

Enums, limits and rules

Reference · API reference

Objective

Value Meaning
1 Minimize total travel time (default)
2 Minimize number of routes (vehicles used)
3 Balance workload among routes
string An account-configured custom strategy name

Configuration values

Field Allowed Default
polylineType none, plain, encoded none
units metric, imperial metric
enforceLockedTasks full, order, vehicle —
unassignedTasks true / false false
statistics true / false false
freezeWindowLength integer (minutes) —

Task status (re-optimization)

Value Meaning
pending Not yet started.
in_progress Currently being performed.
performed Completed.

Location format

  • Array [latitude, longitude] or object { "lat": …, "lng": … }.
  • Use at least 5 decimal places for accuracy.

Timestamps

  • ISO 8601 with timezone offset — e.g. 2026-07-31T14:45:30-08:00.
  • Keep one consistent timezone across the whole payload; the output uses the same one.

Job rules

  • At least one job and one vehicle are required.
  • All ids must be unique within their kind (jobs, tasks, vehicles).
  • A job supports pickup-only, delivery-only, or pickup-and-delivery — but not multiple pickups and multiple deliveries together.
  • For pickup-and-delivery, the anchor is determined by which side carries the service window.

Other limits

  • Total time span of a problem: max 33 hours from the earliest timestamp.
  • maxRideTable bands must not overlap or leave gaps.

Related: The Problem object · The Solution object · Rate limits and errors