Skip to main content
All CollectionsIntegrations
API Status And Tracking Status
API Status And Tracking Status

Information of the status and tracking_status of the JSON response.

Charles avatar
Written by Charles
Updated over 3 months ago

Flow of status

Value

Dashboard display

Description

info_recv

Info Received

New job created in Detrack.
New job created in Detrack. Used when information reached courier for performing delivery. Goods yet to arrive in warehouse.
assign_to is null.

in_transit

In Transit

Awaiting arrival of goods to warehouse.

dispatched

In Progress

Job information ready to be sent to Driver App for drivers to perform job.
If status is dispatched and assign_to is not null, tracking_status will change to either Out for delivery or Out for collection.

completed

Completed

Job completed by driver.

completed_partial

Partially Completed

Job completed by driver, but with at least 1 item rejected in items array.

failed

Failed

Job failed.

on_hold

On Hold

When admin changes the status to on-hold manually through the dashboard.
Used when there is some issue with the job, and the admin wishes to delay the job.

return

Return

When admin changes the status to return manually though the dashboard.
Used when there is some issue with the job, and that the goods are to be returned to the shipper.

Flow of tracking_status

he tracking status is the end result of the various combinations of different fields. (e.g. status, assign_to, date).

Value

Description

Info Received

New job created in Detrack.
status is info_recv

Out for delivery /
Out for collection

Job being assigned to a vehicle, assign_to is not null; status is dispatched; and date is <= current date.

Scheduled

Job being assigned to a vehicle, assign_to is not null; status is dispatched; and date is > current date.

Completed

Job completed by driver. status is completed.

Partially Completed

Job completed by driver, but with at least 1 item rejected in items array.
status is completed_partial.

Failed

Job failed.
status is failed.

On hold

When admin changes the status to on-hold manually through the dashboard.
status is on_hold.

Return

When admin changes the status to return manually though the dashboard.
status is return.

COMBINED STATUS AND TRACKING STATUS

status

tracking_status

assign_to

Description

info_recv

Info Received

Used when the job information reached courier, and goods has yet to arrive.

in_transit

Info Received

Used when goods is being sent to warehouse.

dispatched

Info Received

null

When the job is ready to be sent out to the Driver App for drivers to perform the job.

dispatched

Out for delivery / Out for collection

Not null

When the job has been sent out to the Driver App for drivers.

completed

Completed

Not null

When the job has been completed.

completed_partial

Partially Completed

Not null

When the job has been completed, but with at least one rejected item in the items array.

failed

Failed

Not null

When the job has failed.

on_hold

On Hold

When there is some issue with the job, and the admin wishes to delay the job.

return

Return

When there is some issue with the job, and the admin wishes to return the goods.

MILESTONES

This section is about the milestones array. This array will serve as a log to record the various events that happened to your job.

Value

Description

info_recv

New job created in Detrack.

dispatched

Triggered when status is changed from info_recv to dispatched.

out_for_delivery

assign_to: Not null
status: dispatched
tracking_status is Out for delivery or Out for collection.

head_to_delivery

Driver triggers “Head to location” from Driver App for Delivery type job.

head_to_pick_up

Driver triggers “Head to location” from Driver App for Collection type job.

completed

Job completed by driver.

completed_partial

Job completed by driver, but with at least 1 item rejected in items array.

failed

Job failed.

on_hold

When admin changes the status to on-hold manually through the dashboard.
Used when there is some issue with the job, and the admin wishes to delay the job.

return

When admin changes the status to return manually though the dashboard.
Used when there is some issue with the job, and that the goods are to be returned to the shipper.

LOGGING OF INFORMATION IN THE MILESTONES ARRAY

NORMAL MODE

  1. Info Received (info_recv) will be added when job is created.

  2. Heading to delivery (head_to_delivery) / pick up (head_to_pick_up) will be added when driver triggers heading to.

  3. When job status (dispatched/completed/failed ..etc) has changed, milestone will be added.

  4. When driver has changed and “Add vehicle change milestone” is enabled, corresponding entry will be added.

COURIER MODE

  1. Milestone will be added based on the job status when job is created.

  2. Heading to delivery (head_to_delivery) / pick up (head_to_pick_up) will be added when driver triggers heading to.

  3. When job status (dispatched/picked_up/completed/failed ..etc) has changed, milestone will be added.

  4. When driver has changed and “Add vehicle change milestone” is enabled, corresponding entry will be added.

Did this answer your question?