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.

API configuration

When using the API to make requests, see the pages below for the process. These guides walk through the requirements and setup to access the Rose Rocket API with your application.

Authentication - Access Rose Rocket with OAuth 2.0
Object operations - Configure your requests

Object structure

Use the table below for information about the task objects.

Object Key Name: task

Fields	Label	DataType	Remarks
`id`	Task ID	string	Unique identifier of the task. NOTE:System generated
`FullId`	Full ID	string	An auto-generated identifier for the task record.
`status`	Status	string, enumerated	Status associated with the task, valid values:`new`, `incomplete`, `inprogress`, `assigned`, `complete`, `problem`, `canceled`
`taskType`	Task Type	string, enumerated	Defines the type of task, determining its purpose and actions, valid value:`pickup`, `delivery`, `drive`, `unload`, `load`, `leg`, `group`, `dropTrailer`, `hookTrailer`, `other`
`description`	Description	string	A brief general description of the task.
`specialInstructions`	Special Instructions	String	Provides Instructions specific to this task that the user needs to be aware of.
`requestedCompletionWindow`	Requested Completion Window	`DateTimeValue`	The customer’s or requester’s desired time frame for completing the task. For example, pickup task completion time, delivery task completion time.
`actualArrivalTime`	Actual Arrival	`DateTimeValue`	The actual time the task is initiated or started.
`actualCompletionTime`	Actual Completion Time	`DateTimeValue`	The exact time the task is successfully finished.
`appointmentTime`	Appointment Time	`DateTimeValue`	Indicates a specific scheduled appointment time for the task, if applicable.
`ordinal`	Ordinal	`Number`	Enables users to sort tasks in a designated order.
`manifestOrdinal`	Manifest Ordinal	`Number`	Enables users to sort tasks in a manifest.
`incompleteAt`	Incomplete At	`String`	Date and time when the task’s status was changed to incomplete.
`inProgressAt`	In-Progress At	`String`	Date and time when the task’s status was changed to in progress.
`assignedAt`	Assigned At	`String`	Date and time when the task was last assigned to someone.
`arrivedAt`	Arrived At	`String`	Date and time when the driver arrived to perform the task.
`completedAt`	Completed At	`String`	Date and time when the task’s status was changed to completed.
`problemAt`	Problem At	`String`	Date and time when an issue or problem was identified with the task.
`cancelledAt`	Canceled At	`String`	Date and time when the task was canceled or terminated.
`refNum`	Reference Number	`String`	Unique reference number associated with the task.
`taskETAStatus`	Task ETA Status	`Enum`	Status reflecting the estimated time of arrival for the task, valid values:`enroute`, `onTime`, `atRisk`, `late`, `early`
`isETARequested`	Is ETA Requested	`Boolean`	Indicates whether an estimated time of arrival (ETA) was requested for this task.
`partnerNotes`	Partner Notes	`String`	Notes field for partners to add additional information about the task.
`relatedCustomer`	Related Customer	`String`	Identifies the customer associated with the order linked to this task. NOTE:This is a derived field. See Read-only fields .
`totalEarnings`	Total Earnings	`Money`	Provides the sum of all earnings associated with the task. See Read-only fields .
`totalCost`	Total Cost	`Money`	Aggregates the total cost incurred for the task. See Read-only fields
`totalCommoditiesWeight`	Total Commodities Weight	`Number`	Calculates the combined weight of all commodities involved in the task. See Read-only fields
`totalCommoditiesQuantity`	Total Commodities Quantity	`String`	Presents the total count of all commodities for the task, formatted for clarity. See Read-only fields
`originAddress`	Origin Address	`String`	Displays the complete address for the task's initial pickup location. See Read-only fields
`originAddressPostCode`	Origin Address PostCode	`String`	Specifies the postal code for the task's starting pickup location. See Read-only fields
`destinationAddress`	Destination Address	`String`	Shows the full address for the task's final delivery stop. See Read-only fields
`legOriginAnd Destination Address`	Leg Origin And Destination Address	`String`	Provides a readable format of the starting and ending locations for a leg task. See Read-only fields
`destinationAddressPostCode`	Destination Address PostCode	`String`	Provides the postal code for the task's final delivery stop. *See Read-only fields
`relatedCommoditiesLabel`	Related Commodities Label	`String`	Provides a formatted list of distinct commodities associated with the subtasks. See Read-only fields
`relatedShipper`	Related Shipper	`String`	Provides the shipper's name and address associated with the first pickup task of the order. See Read-only fields
`relatedConsignee`	Related Consignee	`String`	Provides the consignee name and address for the orders last delivery-like task. See Read-only fields
`relatedAssignees`	Related Assignees	`User \[]`	Identifies the users assigned to complete the task. NOTE: Includes assignees from the first pickup task if this is a leg task. See Read-only fields
`relatedAssets`	Related Assets	`Assets \[]`	Identifies the assets utilized for a task. NOTE: Includes assets from the first pickup task if this is a leg task. See Read-only fields
`previousLeg`	Previous Leg	`Task \[]`	Indicates the preceding leg in a sequence of tasks, if exists. NOTE: Only present if there is a leg prior to the current one. See Read-only fields
`previousLegDrivers`	Previous Leg Drivers	`User \[]`	Indicates the drivers associated to the previous leg, if they exist. NOTE: Only applicable if the previous leg has assigned drivers. See Read-only fields