Skip to main content

Get Cluster Response

GET 
/optimize/cluster/:request_id

Get Cluster Response

Request​

Path Parameters

    request_id Request Idrequired

Responses​

Successful Response

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

    [DEPRECATED]

    sequence_priority Sequence Prioritynullable

    Lower values (higher priority) will be picked earlier in an optimized pick route.

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

    [DEPRECATED]

    sequence_priority Sequence Prioritynullable

    Lower values (higher priority) will be picked earlier in an optimized pick route.

    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
    order_priority Order Prioritynullable

    Priority of this picks order. Orders will never be clustered with orders of a lower priority.

    release_time Release Timenullable

    Time at which the pick/order was created.

    due_time Due Timenullable

    Time at which the pick/order needs to be picked.

    wave_id Wave Idnullable

    For clustering, the wave id the pick belongs to.

    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.

    distance Distance

    The estimated distance of the cluster.

    duration Durationnullable

    The estimated pick duration of the cluster.

  • ]
    • optimal_distance Optimal Distance

    Distance in the asis scenario

    asis_distance Asis Distance

    Distance in the asis scenario

    optimal_duration Optimal Durationnullable

    Distance in the asis scenario

    asis_duration Asis Durationnullable

    Distance in the asis scenario

    schedule objectnullable

    The scheduled assignments of the clusters to workers.

    schedule_start_time Schedule Start Timenullable

    Default value: 9999-12-31T23:59:59.999999

    The start time of the schedule.

    assignments object[]

    The assignments of the clusters to workers.

  • Array [
    • list_id List Idrequired

    The list_id of the cluster.

    worker_idx Worker Idxrequired

    The idx of the worker assigned to the list.

    start_time date-timerequired

    The scheduled start time of the list.

    finish_time date-timerequired

    The scheduled end time of the list. (start_time + duration)

    release_time_max Release Time Maxnullable

    The maximum release time of all orders in the list.

    due_time_min Due Time Minnullable

    The minimum due time of all orders in the list.

    n_late_orders N Late Ordersrequired

    The number of late orders in the list.

    tardiness Tardinessrequired

    The total tardiness of all orders in the list.

  • ]
    • n_late_orders N Late Ordersrequired
    total_tardiness Total Tardinessrequired
    n_orders N Ordersrequired
Loading...