Guides API Reference hypertrack.com

Core

Get Orders GET Batch and Sequence Orders POST Track Orders POST Get Plans GET Create an order export job POST Get Routes GET Create Route POST Estimate Route GET Get Order Timeline GET Update Order PATCH Get Plan GET Get export job status GET Get Tasks Definitions List GET Create Tasks Definition POST List Order Tasks GET Create Order Tasks POST Add Custom Order Events POST Cancel Order POST Enable Order POST Get Order by Route Handle GET Update Route PATCH Disable Order POST Get Order Webhooks GET Complete Order POST Reassign Order POST Trigger Planning for a Plan POST Reschedule Order POST Add Order POST Remove Order POST Complete Route POST Reassign Route POST Optimise Orders Sequence POST Update Order Task PATCH Delete Order Task DELETE Get Candidate Workers GET Resequence Orders POST Get estimated route polyline GET Get Tasks Definition GET Update Tasks Definition PATCH Delete Tasks Definition DELETE

Legacy

Resources

Orders

Create an order export job

Creates an asynchronous job to export orders to CSV.gz file. Returns a job_id that can be used to check status. Download link will be sent via email when ready.

The interactive schema for this endpoint is being finalized. In the meantime, see the full request and response definition in the OpenAPI specification.

Get Plans GET

API to fetch list of plans based on a set of filters ### Planning failure reasons When an order is left unplanned by automated planning, `planning_failure_reason` may contain one of these values: - `No Worker was available for this plan.` - `No Worker schedule overlaps with this order's time window.` - `This order is outside the available Worker working hours.` - `Worker location is unavailable, so travel time could not be evaluated.` - `Worker start location is unavailable for the configured route start setting.` - `No Worker supports the required product type for this order.` - `Route was being modified concurrently and this order needs to be re-planned.` - `The optimizer dropped this order to satisfy planning constraints for the overall plan.` - `The optimizer could not find a feasible plan for the provided constraints.` - `Travel time calculation failed for this planning attempt.` - `Ops group configuration is incomplete for automated planning.` - `Assigning this order would exceed route or Worker capacity.` - `No Worker can reach this order before scheduled_at.` - `Assigning this order would delay an already planned downstream order.` - `Assigning this order would exceed the Worker's shift end time.` - `Automated planning could not assign this order with the provided constraints.`

Get Routes GET

Retrieve routes based on the filter parameters provided ### Planning failure reasons When an order is left unplanned by automated planning, `planning_failure_reason` may contain one of these values: - `No Worker was available for this plan.` - `No Worker schedule overlaps with this order's time window.` - `This order is outside the available Worker working hours.` - `Worker location is unavailable, so travel time could not be evaluated.` - `Worker start location is unavailable for the configured route start setting.` - `No Worker supports the required product type for this order.` - `Route was being modified concurrently and this order needs to be re-planned.` - `The optimizer dropped this order to satisfy planning constraints for the overall plan.` - `The optimizer could not find a feasible plan for the provided constraints.` - `Travel time calculation failed for this planning attempt.` - `Ops group configuration is incomplete for automated planning.` - `Assigning this order would exceed route or Worker capacity.` - `No Worker can reach this order before scheduled_at.` - `Assigning this order would delay an already planned downstream order.` - `Assigning this order would exceed the Worker's shift end time.` - `Automated planning could not assign this order with the provided constraints.`