Get a planner request

GET /v1/planner_requests/{id}

One planning run: its input statistics, job_status, and — once it has succeeded — the solution and output_stats.

Authentication

Send a token issued in the Zoopit dashboard as Authorization: Bearer <token>.

Path parameters

Name	Type	Required
id	string	yes

Query parameters

Name	Type	Required
select	array of "attributes" | "auto_save_routes" | "continued_from_parent" | "created_at" | "created_by" | "deleted_at" | "deleted_by" | "edges" | "error" | "fleets" | "id" | "ignore_capacity" | "ignore_delivery_window" | "ignore_driver_shifts" | "ignore_pickup_window" | "ignore_skills" | "ignore_sorting" | "initial_solution" | "input_stats" | "job_status" | "jobs" | "main_plan_id" | "modified_at" | "modified_by" | "objectives" | "output_stats" | "owners" | "parent_planner_request_id" | "problem" | "relations" | "request_id" | "requested_solver_name" | "routes_conditions" | "solution" | "solver_id" | "solver_request_id" | "sort_by" | "sort_type" | "tags" | "with_traffic_eta"
related	boolean

Responses

200

resource: PartialPlannerRequestWithId

Field	Type	Required
attributes	object
error	object
created_at	string
modified_at	null or string
deleted_at	null or string
created_by	string
modified_by	null or string
deleted_by	null or string
owners	array of string
tags	array of string
request_id	string
requested_solver_name	string
solver_id	string
solver_request_id	string
input_stats	object
output_stats	object
solution	object
problem	object
job_status	"failure" | "queued" | "running" | "success"
jobs	array of object or null
fleets	array of object or null
with_traffic_eta	null or boolean
auto_save_routes	null or boolean
objectives	array of Objective or null
parent_planner_request_id	null or string
main_plan_id	null or string
routes_conditions	array of object or null
sort_type	"delivery" | "pickup" or null
sort_by	null or string
ignore_sorting	null or boolean
ignore_skills	null or boolean
ignore_capacity	null or boolean
ignore_driver_shifts	null or boolean
ignore_pickup_window	null or boolean
ignore_delivery_window	null or boolean
edges	array of object or null
initial_solution	object or null
continued_from_parent	boolean
relations	array of object
id	string	yes

Example

curl -X GET 'https://routes-api.cloud.zoopit.no/v1/planner_requests/{id}'
  -H 'Authorization: Bearer <token>'

Try it in the interactive Routes API reference.

Field descriptions, guides and worked examples are in the full reference, available to customers in the Zoopit dashboard under Accounts → Developer.