HYhypertrack
Orders

Get Candidate Workers

Get candidate workers for an order identified by the given order_handle. Optionally pass destination_geometry to use a different destination for this request.

get/orders/{order_handle}/candidate_workers

Request

Path parameters

order_handlestring required

Query parameters

typestring nullable

Type of the order which can be drop or pick

type_indexinteger nullable

Integer representing the pick or drop order index when having a pick/drop scenario

fulfillment_attemptinteger nullable

The attempt number for fulfilling the order

profile_filterstring nullable

Profile filter to be applied on the list of workers before returning the candidates

limitinteger nullable

Number of candidate workers to return

skip_already_assigned_workerboolean nullable

If true, only return workers which are different than already assigned to the order.

allow_ongoing_orderboolean nullable

If true, skip the guard that rejects requests for orders in ongoing state.

destination_geometrystring nullable

GeoJSON Point geometry [longitude, latitude] to use as the order destination for this request

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.