HyperTrack Orders API
The Orders API from HyperTrack — 32 operation(s) for orders.
HyperTrack Orders API is one of 10 APIs that HyperTrack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes 41 operations across 32 paths, and defines 208 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against a single base URL, https://v3.api.hypertrack.com.
41 operations
32 paths
208 schemas
2 DELETE15 GET4 PATCH20 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
HyperTrack Orders API declares
3 security schemes
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
It accepts HTTP bearer tokens (TokenAuth).
It accepts HTTP bearer tokens (BearerAuth).
Paths & Operations 41
Across 32 paths, the API surfaces 41 operations — 2 DELETE, 15 GET, 4 PATCH, 20 POST. Each is listed below with its method, path, parameters, and response codes.
Orders 41
GET
/orders/
Get Orders
POST
/orders/
Batch and Sequence Orders
POST
/orders/track
Track Orders
GET
/orders/plans
Get Plans
GET
/orders/plans/
Get Plans
POST
/orders/export
Create an order export job
GET
/orders/routes/
Get Routes
POST
/orders/routes/
Create Route
GET
/orders/estimate
Estimate Route
GET
/orders/{order_handle}
Get Order Timeline
PATCH
/orders/{order_handle}
Update Order
GET
/orders/plans/{plan_id}
Get Plan
GET
/orders/export/{job_id}
Get export job status
GET
/orders/tasks-definitions
Get Tasks Definitions List
POST
/orders/tasks-definitions
Create Tasks Definition
GET
/orders/{order_handle}/tasks
List Order Tasks
POST
/orders/{order_handle}/tasks
Create Order Tasks
POST
/orders/{order_handle}/events
Add Custom Order Events
POST
/orders/{order_handle}/cancel
Cancel Order
POST
/orders/{order_handle}/enable
Enable Order
GET
/orders/routes/{route_handle}
Get Order by Route Handle
PATCH
/orders/routes/{route_handle}
Update Route
POST
/orders/{order_handle}/disable
Disable Order
GET
/orders/{order_handle}/webhooks
Get Order Webhooks
POST
/orders/{order_handle}/complete
Complete Order
POST
/orders/{order_handle}/reassign
Reassign Order
POST
/orders/plans/{plan_id}/trigger
Trigger Planning for a Plan
POST
/orders/{order_handle}/reschedule
Reschedule Order
POST
/orders/routes/{route_handle}/add
Add Order
POST
/orders/routes/{route_handle}/remove
Remove Order
POST
/orders/routes/{route_handle}/complete
Complete Route
POST
/orders/routes/{route_handle}/reassign
Reassign Route
POST
/orders/routes/{route_handle}/optimise
Optimise Orders Sequence
PATCH
/orders/{order_handle}/tasks/{task_id}
Update Order Task
DELETE
/orders/{order_handle}/tasks/{task_id}
Delete Order Task
GET
/orders/{order_handle}/candidate_workers
Get Candidate Workers
POST
/orders/routes/{route_handle}/resequence
Resequence Orders
GET
/orders/estimated-routes/{estimated_route_id}
Get estimated route polyline
GET
/orders/tasks-definitions/{task_definition_id}
Get Tasks Definition
PATCH
/orders/tasks-definitions/{task_definition_id}
Update Tasks Definition
DELETE
/orders/tasks-definitions/{task_definition_id}
Delete Tasks Definition
Schemas 208
The contract defines 208 schemas that model the data the API accepts and returns. The most detailed are GetOrderTimelineResponse (76 properties), RescheduleOrderResponse (71 properties), CompleteOrderResponse (71 properties), EnableOrderResponse (71 properties). Each schema is shown below with its type and property counts.
OrderListEstimate
object
7 properties
TriggerPlanningRequest
object
3 properties
InferredEventDeviation
object
2 properties
PatchRouteResponse
object
34 properties
6 required
PolygonGeometry
object
2 properties
2 required
PointGeometry
object
2 properties
1 required
OrderMetrics
object
6 properties
6 required
Error
object
3 properties
OrderCustomEvent
object
3 properties
2 required
OrderWithHandleInput
object
1 property
1 required
OptimiseRouteResponse
object
34 properties
6 required
GetEstimatedRouteResponse
object
6 properties
1 required
OrderExportResponse
object
3 properties
3 required
OrderDeviceSwitchedWebhookEventData
object
8 properties
6 required
Source
object
7 properties
AddOrderToRouteRequest
object
2 properties
1 required
PolylineProperties
object
1 property
OrderHandleInput
object
3 properties
1 required
CustomOrderEvent
object
6 properties
2 required
PlanSummaryOrders
object
6 properties
6 required
CompleteRouteResponse
object
34 properties
7 required
ValidationError
object
2 properties
AgentBreakEntry
object
4 properties
PolylineGeometry
object
2 properties
1 required
CompletionResponse
object
4 properties
3 required
DriverActivityEvent
object
19 properties
3 required
SignatureAttachment
object
2 properties
2 required
TrackOrdersRequest
object
13 properties
1 required
DeviceDisconnectedEvent
object
16 properties
7 required
CheckinResponse
object
4 properties
3 required
OrderExitedWebhookEventData
object
11 properties
5 required
RouteDetail
object
34 properties
6 required
EstimatePolyline
object
2 properties
2 required
OrderEtaChangeWebhookEventData
object
11 properties
6 required
OrderExportStatusResponse
object
8 properties
2 required
AddOrderToRouteResponse
object
34 properties
6 required
DriverOutageEvent
object
19 properties
8 required
UpdateOrderTaskRequest
object
6 properties
PolylineGeoJSON
object
3 properties
3 required
DriverTotal
object
1 property
1 required
BaseOrderAcceptance
object
3 properties
2 required
OrderDestinationSpecialType
object
6 properties
1 required
OrderCompletedWebhookEventData
object
10 properties
5 required
TrackOrder
object
17 properties
2 required
BatchOrdersRequest
object
7 properties
2 required
ReassignOrderResponse
object
71 properties
3 required
OrderParkingResponse
object
3 properties
3 required
PointLocationGeometryResponse
object
2 properties
2 required
CreateManualRouteResponse
object
34 properties
7 required
OrdersTotalWithTTFE
object
9 properties
9 required
RemoveOrderFromRouteResponse
object
34 properties
6 required
ResequenceOrdersInRouteRequest
object
1 property
1 required
ImageAttachment1
object
4 properties
2 required
OrderAssignedWebhookEventData
object
7 properties
5 required
RouteOrder
object
53 properties
3 required
OrderDisabledWebhookEventData
object
6 properties
4 required
OrderTaskList
object
2 properties
HypertrackLocationTimesheet
object
8 properties
5 required
OrderAggregate
object
15 properties
1 required
PlanRoute
object
27 properties
9 required
LocationGeometryResponse
object
2 properties
2 required
OrderCreatedEvent
object
11 properties
1 required
OrderDeviceSession
object
3 properties
2 required
OrderFirstEtaWebhookEventData
object
9 properties
6 required
OrderExportRequest
object
57 properties
ReassignRouteResponse
object
34 properties
7 required
CreateManualRouteRequest
object
6 properties
1 required
GetRoutesResponse
object
2 properties
2 required
GetOrderTimelineResponse
object
76 properties
2 required
SignatureAttachment1
object
3 properties
2 required
OrderDetailPolygonDestination
object
9 properties
1 required
DeviceInfo
object
11 properties
8 required
OrderRequest
object
14 properties
3 required
ActivityBatteryDetails
object
2 properties
OrderTaskListResponse
object
1 property
1 required
Region
object
3 properties
1 required
OrderEnterExitEvent
object
13 properties
2 required
OrderTask
object
7 properties
2 required
OrderDelayedWebhookEventData
object
9 properties
5 required
Plan
object
2 properties
2 required
EventLocationGeometry
object
3 properties
OrderWebhookEvent
object
13 properties
7 required
GetPlansResponse
object
2 properties
2 required
HTTPError
object
2 properties
OrderTaskCreatedWebhookEventData
object
8 properties
5 required
PlanResponse
object
5 properties
RouteListOrder
object
14 properties
2 required
DriverLocation
object
5 properties
5 required
OrderDetailGeofenceIdDestination
object
6 properties
1 required
ImageAttachment
object
3 properties
2 required
OrderBillingDetails
object
4 properties
3 required
RouteList
object
27 properties
6 required
OrderOnDeviceGeofenceCheckedWebhookEventData
object
8 properties
5 required
OrderCancelledEvent
object
12 properties
1 required
TrackOrdersResponse
object
34 properties
9 required
CloseoutTimesheetBreak
object
4 properties
2 required
OrderCancelledWebhookEventData
object
8 properties
5 required
StatusDetail
object
1 property
OrderBillingDetailsUpdatedWebhookEventData
object
8 properties
6 required
TrackOrderRoute
object
2 properties
CompleteRouteRequest
object
CancelOrderRequest
object
PointLocation1
object
2 properties
1 required
UpdateTasksDefinitionRequest
object
4 properties
OrderCheckinResponse
object
3 properties
3 required
OrderInferredEvent
object
8 properties
2 required
RemoveOrderFromRouteRequest
object
1 property
1 required
OrderNMinutesAwayWebhookEventData
object
10 properties
7 required
GetOrdersByRouteHandleResponse
object
34 properties
6 required
BillingBreakTimeModel
object
3 properties
3 required
NoteAttachment1
object
3 properties
2 required
BaseStats
object
5 properties
CustomOrderEventRequest
object
1 property
1 required
PlanOrdersResponse
object
2 properties
TasksDefinitionListResponse
object
2 properties
1 required
OrderDetailPointDestination
object
10 properties
1 required
OrderEnabledWebhookEventData
object
6 properties
4 required
ActivityDetail
object
3 properties
BaseOrderApproval
object
3 properties
2 required
BaseOrderTask
object
5 properties
1 required
BillingBreakTimeModelFine
object
4 properties
1 required
OrderTaskAggregate
object
2 properties
2 required
BillingConstituents
object
6 properties
5 required
OrderRiskUpdatedWebhookEventData
object
7 properties
5 required
RescheduleOrderRequest
object
2 properties
1 required
DriverDeviceUnlinkedEvent
object
10 properties
3 required
ReassignOrderRequest
object
5 properties
PlanSummaryEstimate
object
2 properties
2 required
OptimiseRouteRequest
object
CompleteOrderResponse
object
71 properties
3 required
Event
object
2 properties
2 required
CandidateWorkerRoute
object
2 properties
2 required
OrderObjectMini
object
6 properties
4 required
BreakTimeTuple
object
2 properties
2 required
WebhookArrivalData
object
3 properties
2 required
PatchOrderResponse
object
71 properties
2 required
OrderListPlaceHandleDestination
object
2 properties
1 required
DriverStatusUpdatedEvent
object
8 properties
1 required
GetOrderWebhooksResponse
object
2 properties
WebhookExitData
object
3 properties
1 required
CloseoutMessage
object
7 properties
LocationGeometryModel
object
2 properties
2 required
CloseoutTimesheetEvent
object
4 properties
OrderUpdatedWebhookEventData
object
6 properties
4 required
TasksDefinitionResponse
object
7 properties
4 required
RouteTotal
object
1 property
1 required
OrderStartedEvent
object
11 properties
1 required
RouteListEstimate
object
3 properties
2 required
PlanListRoute
object
2 properties
2 required
CompleteOrderRequest
object
OrderAddressDestination
object
2 properties
1 required
GetOrdersResponse
object
3 properties
OrderTaskCompletedWebhookEventData
object
8 properties
5 required
EnableOrderResponse
object
71 properties
3 required
OrderListPolygonDestination
object
5 properties
1 required
PlanSummary
object
6 properties
6 required
OrderTaskResponse
object
10 properties
3 required
OrderCountAggregateModel
object
18 properties
18 required
OrderCompletedEvent
object
13 properties
1 required
ServiceAreaResponse
object
3 properties
2 required
CreateTasksDefinitionRequest
object
4 properties
2 required
NoteAttachment
object
2 properties
2 required
CreateOrderTasksRequest
object
1 property
1 required
DriverDeviceLinkedEvent
object
9 properties
3 required
PatchOrderRequest
object
15 properties
OrderStartedWebhookEventData
object
6 properties
4 required
Order
object
54 properties
3 required
OrderDetailEstimate
object
10 properties
OrderArrivedWebhookEventData
object
10 properties
5 required
ParkingResponse
object
4 properties
3 required
OrderResponse
object
55 properties
3 required
OrderListPointDestination
object
6 properties
1 required
PolygonHeatMap
object
2 properties
2 required
PatchRouteRequest
object
2 properties
ResequenceOrdersInRouteResponse
object
34 properties
6 required
OrderEtaWebhookEventData
object
12 properties
6 required
RouteDetailEstimate
object
6 properties
3 required
CloseoutTimesheet
object
11 properties
1 required
EstimateRouteResponse
object
2 properties
2 required
PlanListResponse
object
11 properties
8 required
AgentInsight
object
2 properties
2 required
BreakEntry
object
4 properties
4 required
AgentTimesheetEntry
object
12 properties
2 required
OrderOutageSummary
object
6 properties
4 required
CancelOrderResponse
object
71 properties
3 required
CloseoutWorkerLocation
object
4 properties
1 required
AgentReview
object
2 properties
RescheduleOrderResponse
object
71 properties
2 required
OrderServiceEvent
object
6 properties
4 required
OrderServiceAreaResponse
object
2 properties
2 required
ReassignRouteRequest
object
3 properties
CandidateWorkersResponse
object
1 property
1 required
CreateOrderTasksResponse
object
1 property
1 required
GetPlanResponse
object
11 properties
8 required
FulfillmentAttempt
object
2 properties
2 required
EnableOrderRequest
object
OrderTaskUpdatedWebhookEventData
object
8 properties
5 required
OrderDetailPlaceHandleDestination
object
6 properties
1 required
DisableOrderRequest
object
TrackedOrder
object
55 properties
3 required
Polyline
object
2 properties
2 required
PointLocationGeometry
object
2 properties
2 required
OrderOutageSummaryAgg
object
8 properties
4 required
OrderAssignedEvent
object
11 properties
1 required
CandidateWorker
object
4 properties
1 required
OrderListResponse
object
1 property
OrderListGeofenceIdDestination
object
2 properties
1 required
DisableOrderResponse
object
71 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HyperTrack 9
Other APIs HyperTrack publishes across the network.
HyperTrack Authentication API
HyperTrack Export API
HyperTrack Geotags API
HyperTrack Nearby API
HyperTrack Places API
HyperTrack Tracking API
HyperTrack Visits API
HyperTrack Worker Export API
HyperTrack Workers API
#Order
Where this information came from
This is an independent, third-party profile of HyperTrack Orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.