Get Route Response

GET 
/optimize/route/:request_id

Get Route Response

Request

Path Parameters

request_id Request Idrequired

Responses

200

Successful Response

application/json

Schema

Schema

type Type

Default value: ROUTE

site_name Site Namenullable

The site name of the site.

wave_id Wave Idnullable

The id of the wave.

request_id Request Idnullable

The ObjectId of the corresponding request.

timestamp date-time

The timestamp of the response.

computation_time Computation Time

Time our algorithm spent calculating.

error Errornullable

An error message, if an error occurred.

invalid_picks object[]
Invalid picks that were not included in the output route, because they were not valid.
Array [
pick_id Pick Idrequired
ID to unique identify this pick
location_id string[]required
The location(s) of the pick in the warehouse.
asis_sequence Asis Sequencenullable
The sequence number of the pick in the as-is route.Required for calculating as-is distances.
priority Prioritynullable
Higher priority picks are picked first.
sku_id Sku Idnullable
The id of the SKU on the location.
quantity Quantitynullable
The quantity of the SKU to pick from the location.
order_id Order Idnullable
The order id of the pick.
hu_id Hu Idnullable
The handling unit id of the pick.
hu_type Hu Typenullable
The handling unit type of the pick.
location_id_processed arraynullable
reason InvalidPickReason
Possible values: [Location not found, No matching regex, Order contains invalid pick]
The reason why the pick is invalid.
]
unit Unitnullable

Default value: cm

The unit of the distance values

extra objectnullable

Data passed through from the input.

route_id Route Idnullable

The id of the route.

picks object[]
The optimized sequence of picks.
Array [
pick_id Pick Idrequired
ID to unique identify this pick
location_id Location Idrequired
The location of the pick in the warehouse.
asis_sequence Asis Sequencenullable
The sequence number of the pick in the as-is route.Required for calculating as-is distances.
priority Prioritynullable
Higher priority picks are picked first.
sku_id Sku Idnullable
The id of the SKU on the location.
quantity Quantitynullable
The quantity of the SKU to pick from the location.
order_id Order Idnullable
The order id of the pick.
hu_id Hu Idnullable
The handling unit id of the pick.
hu_type Hu Typenullable
The handling unit type of the pick.
location_id_processed Location Id Processednullable
optim_sequence Optim Sequencerequired
The optimal sequence of this pick in the optimized route.
path arraynullable
The path to the pick in the warehouse.
instructions object
Instructions for the pick.Relevant instuctions are only generated if the required parameter(s) are set.
hallways arraynullable
The hallways that should be crossed to reach the pick in the shortest path.
end_loop End Loopnullable
Whether the pick should ends the loop.
start_loop Start Loopnullable
Whether the pick should starts a new loop.A pick can both end a loop and start a new one.
]
asis_distance Asis Distance

The distance of the as-is route.

optimal_distance Optimal Distance

The distance of the optimized route.

property name* any

Example (from schema)

{
  "asis_distance": 100,
  "computation_time": 0.05,
  "optimal_distance": 80,
  "picks": [],
  "request_id": "675177e2aea9bc14fe7c0c02",
  "route_id": "Route01",
  "site_id": "675177e91539871b3ce6e156",
  "site_name": "Example Site",
  "timestamp": "2024-12-05T09:41:39.792Z",
  "wave_id": "wave001"
}

422

Validation Error

application/json

Schema

Schema

detail object[]
Array [
loc object[]required
Array [
anyOf
MOD2
string
integer
]
msg Messagerequired
type Error Typerequired
]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...