Manifest
Overview
A manifest is a contract that formalizes the terms and costs of transportation services, including specific requirements, responsibilities, and compensation arrangements for the movement of goods. It typically involves agreements between brokers and carriers, or between carriers and independent driver/owner operators within the logistics chain on the Rose Rocket platform.
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 manifest objects.
| Fields | Label | DataType | Description | Remarks |
|---|---|---|---|---|
id | ID | String | Unique identifier of the manifest record. | Auto-generated and assigned by the system |
fullID | ID | String | Identifier for the manifest record. | Auto-generated and assigned by the system |
name | Name | String | Name of this manifest. | Typically this is auto-generated by the system but can be updated manually. A manifest associated to just one order would get the name “M-O-19” where O-19 is the fullId of the order. |
status | Status | Enum | The status associated with the manifest. Cannot be null. | Defaulted to newEnum Options: new planned dispatched inTransit completed problem |
task | Task | Task/[] | Specifies the tasks associated with the manifest. A manifest includes multiple tasks, which may involve various types of work to be executed. | Associated with the Tasks array. |
documents | Documents | Document\[] | Specifies the documents associated with the manifest. | Associated with the Documents array. |
bill | Bill | Bill | Specifies the bill associated with the manifest. | Associated with the Bill object. |
buy quotes | Buy Quote | Quote\ [] | Specifies the list of all partner quotes associated with the manifest. | Associated with the Quote array. |
cost | Cost | FinancialLineItem\[] | Specifies the list of all financial line items associated with the manifest. | Associated with the FinancialLineItem array. |
dispatchedAt | Dispatched At | DateTimeValue | Specifies the time and date when the manifest status was changed to dispatched. | Uses local time |
completedAt | Completed At | String | Specifies the time and date when the manifest status was changed to completed. | Uses system time (UTC) |
partner | Partner | Partner | This is a broker-specific field. Indicates the partner carrier assigned to the manifest. | Associated with the partner Object. |
driver | Driver | User\[] | Specifies the list of all drivers assigned to the manifest. | Associated with the User array. |
dispatcher | Dispatcher | User | Oversees manifests and coordinates assigned drivers for delivery completion. | Associated with the User object. |
totalmiles | Total Miles | Number | Sum of distances between stops for a manifest. | n/a |
estimatedDuration | Estimated Duration | Number | Total projected time for driving and completing tasks at all stops on the manifest. | n/a |
currentLocation | Current location | Address | Address where the manifest is presently located. | Associated with the Address object |
lastSeenTime | Last Known Location Timestamp | DateTimeValue | Timestamp indicating the last time the manifest's current location was updated in the system | Not a range of dates (isRange: False) |
tags | Tags | Tag\[] | Tags that are associated with the manifest. | Associated with the Tags array. |
specialInstructions | Special instructions | String | Special instructions for the manifest. | n/a |
stops | Stops | Stop\[] | Lists all distinct stops associated with this manifest. | Derived field from: 'manifest.tasks.stops' and 'manifest.tasks.subTasks.stops' Each stop represents a location for task execution |
activeRateConfirmation | Active Rate Confirmation | RateConfirmation | Specifies the active rate confirmation for the manifest. | Derived from manifest.rateConfirmations'. |
lastKnownLocation | Last known Location | Address | The last recorded location based on the most recently updated task. | Derived field from: manifest.currentLocation manifest.tasks.stops.location manifest.tasks.subTasks.stops.location |
origins | Origins | Stop\[] | Lists all stops labeled as "origin" that are connected to the manifest. | Derived field from: manifest.tasks.stops manifest.tasks.subTasks.stops |
destinations | Destinations | Stop\[] | Lists all stops labeled as "destination" that are connected to the manifest. | Derived field from: manifest.tasks.stops manifest.tasks.subTasks.stops |
pickups | Pickups | Task\[] | Lists all tasks labeled as "pickup" that are connected to stops on the manifest. | Derived field manifest.tasks.subTasks |
firstOriginStop | First Origin Stop | Stop | Specifies the first origin stop on the manifest. | Derived field manifest.tasks.stops manifest.tasks.subTasks.stops |
deliveries | Deliveries | Task\[] | Lists all delivery tasks that are connected to stops on the manifest | Derived field manifest.tasks.subTasks |
lastDestinationStop | Last Destination Stop | Stop | Specifies the last stop of destination on this manifest | Derived field from: manifest.tasks.stops manifest.tasks.subTasks.stops |
pickupWindows | Pickup Windows | DateTimeValue\[] | Timeframes within which pickup tasks should be completed. | Derived field from: manifest.pickups |
startAt | Start At | DateTimeValue | Specifies the earliest time when pickups are scheduled to start, based on the first task. | Derived field from: manifest.pickupWindows |
deliveryWindows | Delivery Windows | DateTimeValue\[] | Timeframes within which delivery tasks should be completed. | Derived field from: manifest.deliveries |
firstPickupTask | First Pickup Task | Task | Specifies the first pickup task at the first origin stop. | Derived field from: manifest.tasks.stops manifest.tasks.subTasks.stops |
lastDeliveryTask | Last Delivery Task | Task | Specifies the last delivery task at the last destination stop. | Derived field from: manifest.tasks.stops manifest.tasks.subTasks.stops |
orders | Orders | Order\[] | Lists the orders related to the manifest. | Derived field from: manifest.tasks.order manifest.tasks.subTasks.order manifest.parentTasks.order |
commodities | Commodities | Commodity\[] | Lists all commodities that are connected to tasks on the manifest. | Derived field from: manifest.tasks.commodities manifest.tasks.subTasks.commodities |
totalCommoditiesQuantity | Total Commodities Quantity | String | Displays the total quantity of all commodities on the manifest as a formatted string. | Derived field from: manifest.tasks.commodities manifest.tasks.subTasks.commodities |
manifestStartDate | Manifest Start Date | DateTimeValue | Specifies the earliest requested start time from the tasks associated with the manifest. | Derived field from: manifest.tasks.subTasks manifest.tasks.parentTasks |
manifestEndDate | Manifest End Date | DateTimeValue | Specifies the latest requested end time from the tasks associated with the manifest. | Derived field from: manifest.tasks.subTasks manifest.tasks.parentTasks |
firstStopType | First Stop Type | String | Specifies the type of the first stop on the manifest, such as pickup, delivery, and so on. | Derived field from: manifest.tasks.stops manifest.tasks.subTasks.stops |
firstStopLocation | First Stop location | String | Specifies the first stop location on the manifest. | Derived field from: manifest.tasks.stops.location |
lastStopType | Last Stop Type | String | Specifies the type of the last stop on the manifest. | Derived field from: manifest.tasks.stops manifest.tasks.subTasks.stops |
lastStopLocation | Last Stop Location | String | Specifies the location of the stop on the manifest. | Derived field from: manifest.tasks.stops.location |
totalRevenue | Total Revenue | Money | Specifies the total earnings calculated on the manifest. | Derived field from: manifest.tasks.earnings manifest.tasks.subTasks.earnings |
totalCost | Total Cost | Money | Specifies the total cost of all line items on the manifest. | Derived field from: manifest.costs |
driverPayTotalCost | Driver Pay Total Cost | Money | Specifies the total costs of driver payments on the manifest. | Derived field from: manifest.driverPayLineItems |
driverPayTotalCostPerOrder | Driver pay Total Cost Per Order | Money | Specifies the total driver pay costs allocated across the orders associated with the manifest. | Derived field from: manifest.orders manifest.driverPayLineItems |
margin | Margin | Money | Specifies the margin calculated as total revenue minus total costs for this manifest. | Derived field from: margin.totalRevenue |
assets | Assets | Asset\[] | Lists all assets that are assigned to tasks on the manifest. | Derived field from: manifest.tasks.assets manifest.tasks.subTasks.assets |
mapMarkers | Map Markers | MapViewMarker\[] | Map location pins for assets on the order, which are displayed in the object map views. | Derived field from: manifest.lastKnownLocation manifest.tasks.assets.currentLocation |
driverPayLineItems | Driver Pay Line Items | FinancialLineItem\[] | Lists all drivers pay financial line items on the current manifest. | Derived field from: manifest.drivers manifest.costs |
totalStops | Total Stops | Number | Specifies the total number of stops included in the manifest. | Derived field from: manifest.stops |
accessorialsLabel | Accessorials | String | Specifies the list of additional service charges associated with the order on the manifest. | Retrieves classic accessorials from the order on the manifest. Derived field from: manifest.orders.accessorials |
firstPickup | First Pickup | String | Specifies the location of the first pickup task on the manifest. | Derived field from: manifest.tasks.stops.location |
firstPickupTaskTime | First Pickup Task Time | DateTimeValue | Specifies the requested pickup time of the first pickup task at the first origin stop. | Derived field from: manifest.firstPickupTask |
firstPickupTaskActualTime | First Pickup Task Actual Time | DateTimeValue | Specifies the actual pickup time of the first pickup task at the first origin stop. | Derived field from: manifest.firstPickupTask |
lastDeliveryTask | Last Delivery Task | String | Specifies the location of the last delivery task on the manifest. | Derived field from: manifest.tasks.stops.location |
lastDeliveryTaskTime | Last Delivery Task Time | DateTimeValue | Specifies the requested delivery time of the last delivery task. | Derived field from: manifest.lastDeliveryTask |
lastDeliveryTaskActualTime | Last Delivery Task Actual Time | DateTimeValue | Specifies the actual delivery time of the last delivery task. | Derived field from: manifest.lastDeliveryTask |
commodityNames | Commodity Names | String | A comma-separated list of all commodities associated with tasks on the manifest. | Derived field from: manifest.tasks.commodities manifest.tasks.subTasks.commodities |
customerNames | Customer Names | String | A comma-separated list of customer names from all orders associated with the manifest. | Derived field from: manifest.tasks.order.customer manifest.tasks.subTasks.order.customer manifest.tasks.parentTasks.order.customer |
poNumbersLabel | Po Numbers Label | String | A comma-separated list of purchase order numbers from all associated orders. | Derived field from: manifest.orders |
refNumbersLabel | Reference Numbers Label | String | A comma-separated list of reference numbers from all associated orders. | Derived field from: manifest.orders |
loadTenderNumbersLabel | Load Tender Number Label | String | A comma-separated list of load tender numbers from all associated orders. | Derived field from: manifest.orders |
weightLbs | Weight Lbs | Number | Specifies the weight of all the commodities on this manifest. | Derived field from: manifest.orders |
serviceTypesLabel | Service Types Label | String | A comma-separated list of service types from all associated orders. | Derived field from: manifest.orders |
assetTypesLabel | Asset Types Label | String | A comma-separated list of asset types from all associated orders. | Derived field from: manifest.orders |
taskSpecialInstructionsLabels | Task Special Instructions | String | A comma-separated list of special instructions from tasks associated with this manifest. | Derived field from: manifest.tasks |
estimatedCustomerQuote | Estimated Customer Quote | Money | The estimated cost quoted to the customer for the first order associated with this manifest. | Derived field from: manifest.orders |
Updated 3 months ago