Skip to main content

Activity

An activity represents a planned job/order. Once a route is saved, an activity is alse persisted along with it. It stores information about the location for tasks to be executed for an order.

Fields​

job​

A reference to the associated order.

location_id​

A reference to location

logs​

A collection of reference to activity logs.

status​

Activity status. Can be either COMPLETED, CREATE, FAILED

  • COMPLETED implies the activity was fulfiled
  • CREATED implies that an order was assigned
  • FAILED implies that fulfilment failed

status_at​

Time stamp for when the status was updated

status_description​

A text description of current status

task_id​

Reference to task.

time​

An array with start and end times

example

{
  ...
  "time": ["2025-09-25T04:00:00.000Z", "2025-09-25T05:00:00.000Z"]
  ...
}