Optimize Route

POST 
/optimize/route

Optimize Route

Request

Query Parameters

synchronous Synchronous

Default value: true

application/json

Body

required

wave_id Wave Idnullable

The id of the wave.

site_name Site Namerequired

The name of the site.

start_points arraynullable

Single or list of starting locations.

end_points arraynullable

Single or list of ending locations.

parameters object

allow_interpolation Allow Interpolation

Default value: false

Allow interpolation of missing input locations

location_regex arraynullable

How a location name should be processed before looking it up in the warehouseAn example could be that locations are stored as 'A1-24-006A', but the last character is irrelevant.In this case, the matching regex would be r'^(A1-[0-9]{2}-[0-9]{3})([A-Z])$'and the replacement regex would be r'\1'.Multiple regexes can be provided. If two or more regexes match, the first match is used.

allow_regex_default Allow Regex Default

Default value: true

If false, a location that does not match any of the provided regexes will be considered invalid.If true, the location will be used as-is if no regex matches.

routing_policy RoutingPolicy

Possible values: [ASIS, OPTIMIZED, AUTOSTORE]

Default value: OPTIMIZED

The routing policy to use when generating the route. Options are: RoutingPolicy.ASIS (do not optimize the route), RoutingPolicy.OPTIMIZED (optimize the route using the default optimization algorithm), RoutingPolicy.AUTOSTORE (use an autostore specific algorithm, this also removes a lot of input restrictions).

asis_routing Asis Routingnullabledeprecated

[DEPRECATED] Whether or not to use the asis routing when "optimizing" the route or cluster. Use "routing_policy" instead. If set, this will override "routing_policy" to ASIS for backward compatibility.

pick_violation_handling PickViolationHandling

Possible values: [IGNORE, REMOVE_PICKS, REMOVE_ORDERS]

Default value: IGNORE

How to handle pick violations. Options are: PickViolationHandling.IGNORE, any pick violation will throw a validation exception. PickViolationHandling.REMOVE_PICKS, any pick violation will be removed from the input. PickViolationHandling.REMOVE_ORDERS, any order with a pick violation will be removed from the input.

generate_instructions Generate Instructions

Default value: false

Whether or not to generate instructions for the route.

allow_loop_closing Allow Loop Closing

Default value: false

Only relevant when generating_instructions is True. Allow loop closing.

max_loop_picks Max Loop Picksnullable

Only relevant if allow_loop_closing is True. The maximum number of picks in a loop. If None, no limit is imposed.

max_loop_distance Max Loop Distancenullable

Only relevant if allow_loop_closing is True. The maximum distance of a loop. If None, no limit is imposed.

max_loop_deviation Max Loop Deviationnullable

Only relevant if allow_loop_closing is True. The maximum deviation by the closing of a loop. If None, no limit is imposed.

generate_paths Generate Paths

Default value: false

Whether or not to generate a path for the picks in the route.

extra objectnullable

Extra pass-through data. This is not used by the algorithm, but will be passed to the output.

timestamp date-time

The timestamp of the response.

route_id Route Idnullable

The id of the route.

picks object[]required
Possible values: >= 1
A list of picks that need to be routed.
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
]

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...