Skip to main content
POST
Auto-assign Jobs
This API endpoint allows for the automated assignment of a set of jobs to a specified group of workers.

REQUEST

Initiate a POST request to auto-assign jobs based on specified criteria.
array
required
Array of job IDs to be assigned.
array
required
Array of worker usernames for job assignment.
string
default:"distance"
Assignment method: distance, zones, or size.
integer
Pickup capacity constraint for assignment.
integer
Dropoff capacity constraint for assignment.
integer
default:0
The specific day for assignment, format YYYYMMDD. Defaults to today when set to 0 or omitted.

Configuration

The auto-assignment algorithm considers:
  • Working Hours: Respects worker availability and shift times
  • Capacity Constraints: Honors pickup and dropoff capacity limits if specified
  • Zones: Considers assigned zones for workers (when using zones method)
  • Distance: Optimizes for minimal travel distance (when using distance method)

RESPONSE

Response detailing the assignment status of the jobs.
array
List of job IDs that were successfully assigned.
array
List of job IDs that could not be assigned.
array
A comprehensive list of all jobs considered during the assignment process.