Optimize Cluster

POST /optimize/cluster

Optimize Cluster

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.

handling_units arraynullable

A list containing information for every Handling Unit Type

parameters object

allow_interpolation Allow Interpolation

Default value: false

Allow interpolation of input locations

allow_extrapolation Allow Extrapolation

Default value: false

Allow extrapolation of 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.

generate_visualization Generate Visualization

Default value: false

Whether or not to generate a visualization for the route.

location_intersection_fallback Location Intersection Fallback

Default value: false

When enabling this, the algorithm will replace location sets that are not mutually exclusive by their intersection. As an example, if two picks with locations [A, B] and [B, C] are provided, the algorithm will replace these with [B].

asis_routing Asis Routing

Default value: false

Whether or not to use the asis routing when "optimizing" the route or cluster.

max_runtime Max Runtime

Default value: 60

The maximum runtime for the clustering algorithm in seconds.Note that this is an approximation and not the actual runtime.The algorithm will try to finish within this time.

stop_condition Stop Conditionnullable

A custom stop condition for the clustering algorithm.

max_orders Max Ordersnullable

The maximum number of orders that can be assigned to a single cluster.

max_locations Max Locationsnullable

The maximum number of locations that can be visited in a single cluster.

max_distance Max Distancenullable

The maximum distance that can be traveled in a single cluster.Note that this distance used is an approximation and not the actual distance.

max_volume Max Volumenullable

The maximum volume that can be transported in a single cluster. (1D packing)

max_weight Max Weightnullable

The maximum weight that can be transported in a single cluster.

max_pallet_surface Max Pallet Surfacenullable

The maximum surface area that can be transported in a single cluster. (2D packing)

max_weight_difference Max Weight Differencenullable

The maximum difference in weight between the heaviest and lightest orders in a single cluster.Can be used for stability purposes.

asis_clustering Asis Clustering

Default value: false

Whether or not to actually optimize the clustering. If False, the clustering will only be done as-is.

picks object[]required

Possible values: >= 1

A list of picks that need to be clustered.

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.

order_id Order Idrequired

For clustering, 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.

list_id List Idnullable

For clustering, the as-is list/cluster the pick belongs to.Required for calculating as-is clusters.

sku_width Sku Widthnullable

For clustering, The width of the SKU.

sku_height Sku Heightnullable

For clustering, The height of the SKU.

sku_depth Sku Depthnullable

For clustering, The depth of the SKU.

sku_weight Sku Weightnullable

For clustering, The weight of the SKU.

]

Responses

Successful Response

application/json

Schema
Example (from schema)

Schema

site_name Site Namenullable

The site name of the site.

site_id Site Idnullable

The site id 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.

visualization_url Visualization Urlnullable

Link to a visualization of the optimization, if enabled in request parameters.

asis_clusters object[]

The as-is clusters.

Array [

list_id List Idrequired

The list_id of the cluster. This is assigned by the clustering algorithm in the case of optimal clusters.In the case of as-is clusters, this is the list_id of the as-is cluster.

picks object[]

The picks in the cluster.

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.

order_id Order Idrequired

For clustering, 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.

list_id List Idnullable

For clustering, the as-is list/cluster the pick belongs to.Required for calculating as-is clusters.

sku_width Sku Widthnullable

For clustering, The width of the SKU.

sku_height Sku Heightnullable

For clustering, The height of the SKU.

sku_depth Sku Depthnullable

For clustering, The depth of the SKU.

sku_weight Sku Weightnullable

For clustering, The weight of the SKU.

]

order_ids string[]

Default value: ``

All the order_ids of the picks in the cluster.

estimated_distance Estimated Distance

The estimated distance of the cluster.

]

optimal_clusters object[]

The optimal clusters.

Array [

list_id List Idrequired

The list_id of the cluster. This is assigned by the clustering algorithm in the case of optimal clusters.In the case of as-is clusters, this is the list_id of the as-is cluster.

picks object[]

The picks in the cluster.

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.

order_id Order Idrequired

For clustering, 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.

list_id List Idnullable

For clustering, the as-is list/cluster the pick belongs to.Required for calculating as-is clusters.

sku_width Sku Widthnullable

For clustering, The width of the SKU.

sku_height Sku Heightnullable

For clustering, The height of the SKU.

sku_depth Sku Depthnullable

For clustering, The depth of the SKU.

sku_weight Sku Weightnullable

For clustering, The weight of the SKU.

]

order_ids string[]

Default value: ``

All the order_ids of the picks in the cluster.

estimated_distance Estimated Distance

The estimated distance of the cluster.

]

asis_distance Asis Distancenullablerequired

optimal_distance Optimal Distancerequired

{
  "site_name": "string",
  "site_id": "string",
  "wave_id": "string",
  "request_id": "string",
  "timestamp": "2024-12-06T08:45:23.473Z",
  "computation_time": 0,
  "error": "string",
  "visualization_url": "string",
  "asis_clusters": [
    {
      "list_id": "string",
      "picks": [
        {
          "pick_id": "string",
          "location_id": [
            "string"
          ],
          "asis_sequence": 0,
          "priority": 0,
          "sku_id": "string",
          "order_id": "string",
          "hu_id": "string",
          "hu_type": "string",
          "list_id": "string",
          "sku_width": 0,
          "sku_height": 0,
          "sku_depth": 0,
          "sku_weight": 0
        }
      ],
      "order_ids": [
        "string"
      ],
      "estimated_distance": 0
    }
  ],
  "optimal_clusters": [
    {
      "list_id": "string",
      "picks": [
        {
          "pick_id": "string",
          "location_id": [
            "string"
          ],
          "asis_sequence": 0,
          "priority": 0,
          "sku_id": "string",
          "order_id": "string",
          "hu_id": "string",
          "hu_type": "string",
          "list_id": "string",
          "sku_width": 0,
          "sku_height": 0,
          "sku_depth": 0,
          "sku_weight": 0
        }
      ],
      "order_ids": [
        "string"
      ],
      "estimated_distance": 0
    }
  ],
  "asis_distance": 0,
  "optimal_distance": 0
}

Validation Error

application/json

Schema
Example (from schema)

Schema

detail object[]

Array [

loc object[]required

Array [

anyOf

MOD2

string

]

msg Messagerequired

type Error Typerequired

]

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

Optimize Cluster