Skip to main content
POST
Check a suggest request without running it
V3 is in beta. General availability (GA) is planned for January 2027.

Authorizations

Authorization
string
header
required

Body

application/json

Request body for POST /v3/routing/suggest.

The same body as POST /v3/routing/evaluate, plus optional options. Given the committed plan over problem, ranks the feasible insertion positions for every task of problem that is not in plan — the tasks a solve would place and an evaluate would report as unassigned. Each task (or unit — a shipment, or tasks tied by one sequence/same_vehicle/ same_day/same_route relation) is ranked independently against the same committed plan; the plan is never modified.

plan
object
required

The committed plan. Never modified, never reordered. On suggest, locked_count keeps insertions after a route's dispatched prefix.

problem
object
required

Problem definition — identical to POST /v3/routing/solve. Every task of it that is not in plan is a task to place.

Example:
options
null | object

Suggest options. Absent: the defaults.

Example:

Response

The request passed every check made before travel times are fetched. warnings may contain warnings; none are produced today.

The 200 body of POST /v3/routing/validate/{solve,evaluate,suggest}: the request passed every check a real call runs before the matrix fetch.

valid
boolean
required

Always true: an invalid request gets a 400 instead.

warnings
object[]
required

May contain warnings about the request; none are produced today.