Overview

A Task in Rose Rocket is an essential activity that must be completed as part of fulfilling a contract or securing a new business opportunity. Tasks can be organized into related groups or sequences, which are designed to be completed collectively.

Fields

Below is a detailed list of the fields associated with a Task, outlining the structure and key data points necessary for task management within Rose Rocket.

Note: The tables below provide an overview of the fields used for reading and writing data through the API endpoints. To ensure clarity and based on our object model, the fields are organized into four separate tables.

Read Fields

  • Returned in GET requests- Default Response
  • Extra Includes & Nested Objects

Write Fields

  • Object-specific body in POST and PUT requests
  • Optional Nested Object (Related Objects)

These tables offer a detailed perspective on the available fields for API interactions, categorized based on their usage in data retrieval and modification operations.

Read Fields

Returned in GET requests- Default Response

FieldsLabelDataTypeDescriptionRemarks
idTask IDStringUnique identifier of the task.System Generated
FullIdFull IDStringAn auto-generated identifier for the task record.
statusStatusEnumStatus of the task.new
incomplete
inprogress
assigned
complete
problem
canceled
taskTypeTask TypeEnumDefines the type of task, determining its purpose and actions.pickup
delivery
drive
unload
load
leg
group
dropTrailer
hookTrailer
other
descriptionDescriptionStringA brief general description of the task.
specialInstructionsSpecial InstructionsStringProvides Instructions specific to this task that the user needs to be aware of.
requestedCompletionWindowRequested Completion WindowDateTimeValueThe customer’s or requester’s desired time frame for completing the task. For example, pickup task completion time, delivery task completion time.
actualArrivalTimeActual ArrivalDateTimeValueThe actual time the task is initiated or started.
actualCompletionTimeActual Completion TimeDateTimeValueThe exact time the task is successfully finished.
appointmentTimeAppointment TimeDateTimeValueIndicates a specific scheduled appointment time for the task, if applicable.
ordinalOrdinalNumberEnables users to sort tasks in a designated order.
manifestOrdinalManifest OrdinalNumberEnables users to sort tasks in a manifest.
incompleteAtIncomplete AtStringDatetime when the task’s status was changed to incomplete.
inProgressAtIn-Progress AtStringDate and time when the task’s status was changed to in progress.
assignedAtAssigned AtStringDate and time when the task was last assigned to someone.
arrivedAtArrived AtStringDate and time when the driver arrived to perform the task.
completedAtCompleted AtStringDate and time when the task’s status was changed to completed.
problemAtProblem AtStringDate and time when an issue or problem was identified with the task.
cancelledAtCanceled AtStringDate and time when the task was canceled or terminated.
refNumReference NumberStringUnique reference number associated with the task.
taskETAStatusTask ETA StatusEnumStatus reflecting the estimated time of arrival for the task.enroute
onTime
atRisk
late
early
isETARequestedIs ETA RequestedBooleanIndicates whether an estimated time of arrival (ETA) was requested for this task.
partnerNotesPartner NotesStringNotes field for partners to add additional information about the task.
relatedCustomerRelated CustomerStringIdentifies the customer associated with the order linked to this taskThis is a derived field.
References:

- task.order.customer
-task.subTasks.order.customer
totalEarningsTotal EarningsMoneyProvides the sum of all earnings associated with the task.Derived Field
totalCostTotal CostMoneyAggregates the total cost incurred for the task.Derived Field
totalCommoditiesWeightTotal Commodities WeightNumberCalculates the combined weight of all commodities involved in the task.Derived Field
totalCommoditiesQuantityTotal Commodities QuantityStringPresents the total count of all commodities for the task, formatted for clarity.Derived Field
originAddressOrigin AddressStringDisplays the complete address for the task's initial pickup location.Derived Field
originAddressPostCodeOrigin Address PostCodeStringSpecifies the postal code for the task's starting pickup location.Derived Field
destinationAddressDestination AddressStringShows the full address for the task's final delivery stop.Derived Field
legOriginAnd Destination AddressLeg Origin And Destination AddressStringProvides a readable format of the starting and ending locations for a leg task.Derived Field
destinationAddressPostCodeDestination Address PostCodeStringProvides the postal code for the task's final delivery stop.Derived Field
relatedCommoditiesLabelRelated Commodities LabelStringProvides a formatted list of distinct commodities associated with the subtasks.Derived Field
relatedShipperRelated ShipperStringProvides the shipper's name and address associated with the first pickup task of the order.Derived Field
relatedConsigneeRelated ConsigneeStringProvides the consignee name and address for the orders last delivery-like task.Derived Field
relatedAssigneesRelated AssigneesUser \[]Identifies the users assigned to complete the task.Derived field. Includes assignees from the first pickup task if this is a leg task.
relatedAssetsRelated AssetsAssets \[] Identifies the assets utilized for a task.Derived field. Includes assets from the first pickup task if this is a leg task.
previousLegPrevious LegTask \[] Indicates the preceding leg in a sequence of tasks, if exists.Derived field. Only present if there is a leg prior to the current one.
previousLegDriversPrevious Leg DriversUser \[]Indicates the drivers associated to the previous leg, if they exist.Derived field. Only applicable if the previous leg has assigned drivers.

Extra Includes & Nested Objects

FieldsLabelDataTypeDescriptionRemarks
assetsAssetsAsset \[]Assets allocated for carrying out the task.
tagsTagsTag \[] Tags associated with the task for easy categorization or grouping.
assigneesAssigneesUser \[]Individuals assigned to handle the task.
subscribersSubscribersUser \[]Individuals interested in tracking the task's status.
accessorialsAccessorialsAccessorial \[]Additional services or tasks linked with the main task.
For example, when a task involves services beyond the standard delivery or pickup, such as appointments, white-glove services.
stopsStopsStop \[]Provides the location information relevant to the task along its journey.
[Commodities](https://roserocket.readme.io/v2.0/docs/commodities)CommoditiesCommodity \[]Tracks commodities that are picked up, delivered, or handled at a stop as part of the task.
subTasksSub TasksTask \[]Tasks are grouped together to form a larger task. For example, a shipment task may consist of a group of pickup and delivery tasks. This enables a more granular breakdown of tasks and also supports task segmentation.
manifestManifestManifestA document listing the items or tasks associated with the task.
orderOrderOrderThe associated order for the current task.
parentTasksParent TasksTask \[]The parent tasks or higher-level tasks associated with the current task.
documentsDocumentsDocument \[]Any relevant documents or files linked to the task.
connectedTasksConnected TasksTask \[]Indicates the tasks related to this leg:
- For leg type tasks, return all subtasks
- For non-leg type tasks, find parent and return all siblings (but not itself)
This is a derived field.
References:
- task.subTasks
- task.parentTasks.tasks
relatedOrderTagsRelated Order TagsTag \[]Lists the tags of the order related to the task.This is a derived field.
References:
- task.order.tags
-task.subTasks.order.tags
relatedCommoditiesRelated CommoditiesCommodity \[]Lists the unique commodities associated with the sub tasks of the task.Derived field
relatedOrderRelated OrderOrderRetrieves the order linked to the current task or its parent task within the task hierarchy.This is a derived field.
References:
- task.order
- task.subTasks.order
relatedManifestRelated ManifestManifestProvides the manifest that includes this task, detailing the shipment's journey.This is a derived field.
References:
- task.manifest
- task.subTasks.manifest

Write Fields

Object-specific body in POST and PUT requests

FieldsLabelDataTypeDescriptionRemarks
statusStatusEnumStatus of the task.Default:new
incomplete
inprogress
assigned
complete
problem
canceled
specialInstructionsSpecial InstructionsStringProvides Instructions specific to this task that the user needs to be aware of.
taskTypeTask TypeEnumDefines the type of task, determining its purpose and actions.Default:other
pickup
delivery
drive
unload
load
leg
group
dropTrailer
hookTrailer
descriptionDescriptionStringA brief general description of the task.
requestedCompletionWindowRequested Completion WindowDateTimeValueThe customer’s or requester’s desired time frame for completing the task. For example, pickup task completion time, delivery task completion time.
actualArrivalTimeActual ArrivalDateTimeValueThe actual time the task is initiated or started.
actualCompletionTimeActual Completion TimeDateTimeValueThe exact time the task is successfully finished.
appointmentTimeAppointment TimeDateTimeValueIndicates a specific scheduled appointment time for the task, if applicable.
incompleteAtIncomplete AtStringDatetime when the task’s status was changed to incomplete.Uses system time (UTC)
inProgressAtIn-Progress AtStringDate and time when the task’s status was changed to in progress.Uses system time (UTC)
assignedAtAssigned AtStringDate and time when the task was last assigned to someone.Uses system time (UTC)
arrivedAtArrived AtStringDate and time when the driver arrived to perform the task.Uses system time (UTC)
completedAtCompleted AtStringDate and time when the task’s status was changed to completed.Uses system time (UTC)
problemAtProblem AtStringDate and time when an issue or problem was identified with the task.Uses system time (UTC)
cancelledAtCanceled AtStringDate and time when the task was canceled or terminated.Uses system time (UTC)
refNumReference NumberStringUnique reference number associated with the task.
taskETAStatusTask ETA StatusEnumStatus reflecting the estimated time of arrival for the task.Default:enroute
onTime
atRisk
late
early
isETARequestedIs ETA RequestedBooleanIndicates whether an estimated time of arrival (ETA) was requested for this task.
partnerNotesPartner NotesStringNotes field for partners to add additional information about the task.

Extra Includes & Nested Objects

FieldsLabelDataTypeDescriptionRemarks
assetsAssetsAsset \[]Assets allocated for carrying out the task.
tagsTagsTag \[] Tags associated with the task for easy categorization or grouping.
assigneesAssigneesUser \[]Individuals assigned to handle the task.
subscribersSubscribersUser \[]Individuals interested in tracking the task's status.
accessorialsAccessorialsAccessorial \[]Additional services or tasks linked with the main task.
For example, when a task involves services beyond the standard delivery or pickup, such as appointments, white-glove services.
stopsStopsStop \[]Provides the location information relevant to the task along its journey.
commoditiesCommoditiesCommodity \[]Tracks commodities that are picked up, delivered, or handled at a stop as part of the task.
subTasksSub TasksTask \[]Tasks are grouped together to form a larger task. For example, a shipment task may consist of a group of pickup and delivery tasks. This enables a more granular breakdown of tasks and also supports task segmentation.
manifestManifestManifestA document listing the items or tasks associated with the task.
orderOrderOrderThe associated order for the current task.
parentTasksParent TasksTask \[]The parent tasks or higher-level tasks associated with the current task.
documentsDocumentsDocument \[]Any relevant documents or files linked to the task.
connectedTasksConnected TasksTask \[]Indicates the tasks related to this leg:
- For leg type tasks, return all subtasks
- For non-leg type tasks, find parent and return all siblings (but not itself)
This is a derived field.
References:
- task.subTasks
- task.parentTasks.tasks
relatedOrderTagsRelated Order TagsTag \[]Lists the tags of the order related to the task.This is a derived field.
References:
- task.order.tags
-task.subTasks.order.tags
relatedCommoditiesRelated CommoditiesCommodity \[]Lists the unique commodities associated with the sub tasks of the task.Derived field
relatedOrderRelated OrderOrderRetrieves the order linked to the current task or its parent task within the task hierarchy.This is a derived field.
References:
- task.order
- task.subTasks.order
relatedManifestRelated ManifestManifestProvides the manifest that includes this task, detailing the shipment's journey.This is a derived field.
References:
- task.manifest
- task.subTasks.manifest