Overview

The Stop object represents a critical point in a logistics route where specific tasks are executed to facilitate the delivery and service process. These tasks can vary widely, including those related to contracts such as orders or manifests, as well as other operational activities ensuring efficiency in logistics operations.

Fields

Below is a detailed list of the fields associated with a Stop, outlining the structure and key data points necessary for stop management within Rose Rocket. These fields capture essential information such as the stop's location, information about the tasks, special instructions, and sequence within the journey.

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.

Object Key Name: stop

Read Fields

Returned in GET requests- Default Response

Fields	Labels	DataType	Descriptions	Remarks
`id`	Stop ID	`String`	Unique identifier for the Stop.	system generated
`fullId`	Full ID	`String`	An auto-generated identifier for the stop record.
`description`	Description	`String`	A brief summary providing additional details about the stop.
`specialInstructions`	Special Instructions	`String`	Instructions specific to the stop that the driver needs to be aware of.
`gate`	Gate	`String`	Identifies a gate number or name at the stop, if applicable, such as at terminals or borders.	Some stops, especially large terminals or natural resource yards may have gates to organize truck entry.
`ordinal`	Ordinal	`Number`	Assigns a sequence number to each stop, determining its order within an order.	Automatically generated by System
`manifestOrdinal`	Manifest Ordinal	`Number`	Assigns a sequence number to each stop, determining its order within a manifest.	Automatically generated by System
`nextDistance`	Next Distance	`Number`	Indicates a calculated distance from the current stop to the next one in the sequence.	Automatically updated by System
`nextDuration`	Next Duration	`Number`	Indicates a calculated travel time from the current stop to the next one in the sequence.	Automatically updated by System
`status`	Status	`Enum`	Status of the stop.	`pending` `onroute` `arrived` `completed` `canceled`
`stopType`	Stop Type	`Enum`	Categorizes the stop by its primary activity, such as pickup, delivery, or other specific tasks.	MultiSelect `waypoint` `origin` `destination` `terminal`
`nextDurationFormatted`	Next Duration Formatted	`String`	Human-readable format that represents the duration to the next stop.	Derived from nextDuration property and converted into a readable format.
`pickupWindows`	Pickup Windows	`DateTimeValue\[]`	Indicates all requested completion windows for pickup tasks at the stop.	Derived from stop.tasks.subTasks
`firstPickupWindow`	First Pickup Window	`DateTimeValue`	Indicates the scheduled time window for the initial pickup task at the stop.	Derived from: stop.pickupWindows stop.tasks.subTasks
`lastPickupWindow`	Last Pickup Window	`DateTimeValue`	Indicates the scheduled time window for the last pickup at the stop.	Derived from: stop.pickupWindows stop.tasks.subTasks
`deliveryWindows`	Delivery Windows	`DateTimeValue\[]`	Indicates all requested time windows for delivery tasks at the stop.	Derived from: stop.tasks.subTasks
`uniqueCommodities`	Unique Commodities	`Commodity\[]`	Indicates the unique commodities for all tasks on the stop.	Derived from: stop.tasks.commodities

Extra Includes & Nested Objects

Fields	Labels	DataType	Descriptions	Remarks
`location`	Location	`Address`	Physical address where the stop is located.
`tasks`	Tasks	`Task\[]`	Stops can have multiple tasks associated with them, and could be used to contain many different types of work to be performed at the stop
`documents`	Documents	`Documents\[]`	A connection to documents for any uploaded files like pod's and pop's.
`pickups`	Pickups	`Task\[]`	List of pickup tasks associated with this stop.	Derived from stop.nextDuration

Write Fields

Object-specific body in POST and PUT requests

Fields	Labels	DataType	Descriptions	Remarks
`description`	Description	`String`	A brief summary providing additional details about the stop.
`specialInstructions`	Special Instructions	`String`	Instructions specific to the stop that the driver needs to be aware of.
`gate`	Gate	`String`	Identifies a gate number or name at the stop, if applicable, such as at terminals or borders.
`status`	Status	`Enum`	Status of the stop.	Default:_`pending` `onroute` `arrived` `completed` `canceled`
`stopType`	StopType	`Enum`	Categorizes the stop by its primary activity, such as pickup, delivery, or other specific tasks.	MultiSelect Default:_`waypoint` `origin` `destination` `terminal`

Optional Nested Object (Related Objects)

Fields	Labels	DataType	Descriptions
`location`	Location	`Address`	Physical address where the stop is located.
`tasks`	Tasks	`Task\[]`	Stops can have multiple tasks associated with them, and could be used to contain many different types of work to be performed at the stop
`documents`	Documents	`Documents\[]`	A connection to documents for any uploaded files like pod's and pop's.