Get Cluster Response

GET 
/optimize/cluster/:request_id

Get Cluster Response

Request

Path Parameters

request_id Request Idrequired

Responses

200

Successful Response

application/json

Schema

Schema

type Type

Default value: CLUSTER

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.

asis_clusters object[]
The as-is clusters. Only calculated if the provided input picks respects the provided stop conditions
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.
quantity Quantitynullable
The quantity of the SKU to pick from 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.
location_id_processed arraynullable
list_id List Idnullable
For clustering, the as-is list/cluster the pick belongs to.Required for calculating as-is clusters.
optim_sequence Optim Sequencenullable
The sequence of the pick in the optimized cluster using the routing policy defined in the cluster parameters. (Only used in the optimized cluster output).
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_respected Asis Respected

Default value: true

Whether the as-is clusters respect the provided stop conditions.

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.
quantity Quantitynullable
The quantity of the SKU to pick from 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.
location_id_processed arraynullable
list_id List Idnullable
For clustering, the as-is list/cluster the pick belongs to.Required for calculating as-is clusters.
optim_sequence Optim Sequencenullable
The sequence of the pick in the optimized cluster using the routing policy defined in the cluster parameters. (Only used in the optimized cluster output).
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

Example (from schema)

{
  "type": "CLUSTER",
  "site_name": "string",
  "wave_id": "string",
  "request_id": "string",
  "timestamp": "2025-08-05T23:45:09.405Z",
  "computation_time": 0,
  "error": "string",
  "invalid_picks": [
    {
      "pick_id": "string",
      "location_id": [
        "string"
      ],
      "asis_sequence": 0,
      "priority": 0,
      "sku_id": "string",
      "quantity": 0,
      "order_id": "string",
      "hu_id": "string",
      "hu_type": "string",
      "location_id_processed": [
        null
      ],
      "reason": "Location not found"
    }
  ],
  "unit": "cm",
  "extra": {},
  "asis_clusters": [
    {
      "list_id": "string",
      "picks": [
        {
          "pick_id": "string",
          "location_id": [
            "string"
          ],
          "asis_sequence": 0,
          "priority": 0,
          "sku_id": "string",
          "quantity": 0,
          "order_id": "string",
          "hu_id": "string",
          "hu_type": "string",
          "location_id_processed": [
            null
          ],
          "list_id": "string",
          "optim_sequence": 0,
          "sku_width": 0,
          "sku_height": 0,
          "sku_depth": 0,
          "sku_weight": 0
        }
      ],
      "order_ids": [
        "string"
      ],
      "estimated_distance": 0
    }
  ],
  "asis_respected": true,
  "optimal_clusters": [
    {
      "list_id": "string",
      "picks": [
        {
          "pick_id": "string",
          "location_id": [
            "string"
          ],
          "asis_sequence": 0,
          "priority": 0,
          "sku_id": "string",
          "quantity": 0,
          "order_id": "string",
          "hu_id": "string",
          "hu_type": "string",
          "location_id_processed": [
            null
          ],
          "list_id": "string",
          "optim_sequence": 0,
          "sku_width": 0,
          "sku_height": 0,
          "sku_depth": 0,
          "sku_weight": 0
        }
      ],
      "order_ids": [
        "string"
      ],
      "estimated_distance": 0
    }
  ],
  "asis_distance": 0,
  "optimal_distance": 0
}

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