Order
Overview
The Order object represents a revenue-generating agreement and can involve various parties, such as carriers, brokers, and shippers. Orders act as a container for data relating to the work to complete and tracks the work progress.
The object contains the details about the services agreed upon and the parties involved. These are detailed in the tasks
object.
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 order objects.
Fields | Label | Type | Description |
---|---|---|---|
order | Order | Order connected object *See Connected object section | Revenue generating contract between a customer and a broker or carrier, contains contractually agreed upon work to be performed, found in the Tasks connection NOTE: The shipper and consignee are directly accessible fields on the contract and generate tasks through triggers. |
id | ID | string | Globally unique identifier for record |
fullId | Full ID | string | User identified record ID |
status | Status | string, enumerated | Status associated with order, valid values: new , booked , in transit , delivered , invoiced , tendered , rejected , archived NOTE: Defaults to new, cannot be null |
partner | Partner | Partner connected object *See Connected object section | Partner assigned to order, populated when one partner is assigned to entire order |
customer | Customer | Customer connected object *See Connected object section | Order customer, customers can be shippers, receivers, brokers, or other organizations within supply chain |
csrs | CSR | User connected object array *See Connected object section | Customer Service Representative of company on order |
accountManagers | AM | User connected object array *See Connected object section | Account Manager of company on order |
commissionees | On commission | User connected object array*See Connected object section | Employees on commission for order, can include CSRs, AMs, or others |
poNum | PO No. | string | Receiver-provided information to capture an order, common number for users to search quotes and orders |
refNum | REF No. | string | General purpose field to store reference IDs from other systems, common search term |
loadTenderNum | Load tender No. | string | Reference number for load provided by shipper, carrier use for referencing BOL or order |
eTrackingLink | E-Tracking Link | string | Sharable link for customers to track order |
totalMiles | Total miles | integer | Total miles for quote, calculated from stops addresses using a polyline distance calculation provided by map API provider |
estimatedDuration | Estimated duration | integer | Total estimated time from origin to destination in seconds |
customsBroker | Customs broker | string | Customs Broker for order |
portOfEntry | Port of entry | string | Location that shipment enters country |
declaredValue | Declared value | integer | Value of items shipping |
currentLocation | Current location | Address connected object *See Connected object section | Address of asset or driver current location |
lastSeenTime | Last Known Location Timestamp | Timestamp indicating last system updated time of order current location | |
tags | Tags | Tag connected object array *See Connected object section | Tags associated with order |
specialInstructions | Special instructions | string | Special instructions for BOL, available for driver after manifest created |
tasks | Tasks | Task connected object array *See Connected object section | Work to be completed by an assignee to fulfill contract or win quote, can be grouped together to form legs, and other types of groups and completed together, can carry financial items for allocation at granular level |
sellQuote | Customer quote | Quote connected object *See Connected object section | Quote visible to customer, captures revenue potential of order |
buyQuotes | Partner quotes | Quote connected object array *See Connected object section | Array of buy quotes for multi-partner order, captures cost of order |
documents | Documents | Document connected object array *See Connected object section | Documents associated with order |
billingParty | Billing party | Address connected object *See Connected object section | Party billed for load, can be shipper, consignee, or third party |
currency | Currency | Money | Currency for shipment payment. NOTE: Default options are CAD and USD |
lineItems | Line items | FinancialLineItem connected object array *See Connected object section | Model various types of charges, such as accessorials, fuel surcharges, etc. |
shipper | First pickup | Address connected object *See Connected object section | Origin of load |
consignee | Last delivery | Address connected object *See Connected object section | Destination of load, can populate last destination stop through ECAs |
requestedPickupWindow | Requested pickup | date | Date range customer requests for load to be delivered |
actualPickupDate | Actual Pickup Date | date | Specific date and time for load pick up |
actualDeliveryDate | Actual Delivery Date | date | Specific date and time for load delivery |
assetType | Asset type | AssetType connected object *See Connected object section | Order-required asset type |
serviceType | Service type | PartnerService connected object *See Connected object section | Order-required service type |
totalEarnings | Total earnings | integer | Sum of line items on associated sell quote |
totalCost | Total cost | integer | Sum of line items on associated buy quote |
margin | Margin | integer | Difference between total earnings and total cost |
multiCurrencyMargin | Multi currency margin | string | Order margin in multiple currencies |
partners | Partners | Partner connected object array *See Connected object section | Brokers assign multiple partners to order, for example multiple legs with different partners and each leg has own manifest or ratecon, when this.partner is set, acts as default partner for all tasks on orderNOTE: This field is derived from tasks.subTasks.parentTasks.manifest , tasks.parentTasks.manifest , tasks.subTasks.manifest , tasks.manifest , tasks.subTasks.parentTasks.manifest.partner , tasks.parentTasks.manifest.partner , tasks.subTasks.manifest.partner , tasks.manifest.partner attributes. |
assetWithLastKnownLocation | Asset with last known location | AssetType connected object *See Connected object section | Return location for first asset NOTE: This field is derived from tasks , tasks.assets , tasks.assets.currentLocation attributes. |
origins | Origins | Stop connected object array *See Connected object section | Returns all stops of type origin connected to order NOTE: This field is derived from tasks.stops , tasks.subTasks.stops , tasks.subTasks.subTasks attributes. |
destinations | Destinations | Stop connected object array *See Connected object section | Returns all stops of type destination connected to order NOTE: This field is derived from tasks.stops , tasks.subTasks.stops , tasks.subTasks.subTasks , tasks.subTasks.subTasks attributes. |
allocatableTasks | Allocatable tasks | Task connected object array *See Connected object section | Returns all tasks allocatable for order, for example subtasks within leg tasks NOTE: This field is derived from tasks.manifest , tasks.subTasks , tasks.subTasks.manifest , tasks.subTasks.subTasks attributes. |
firstLeg | First leg | Task connected object array *See Connected object section | Returns first leg NOTE: This field is derived from tasks.stops , tasks.subTasks.stops , tasks.subTasks.subTasks attributes. |
pickups | Pickups | Task connected object array *See Connected object section | Returns all tasks of type pickup connected to stops on order NOTE: This field is derived from tasks.subTasks attribute. |
pickedUpAt | Picked up at | date | Returns time pickup task was completed NOTE: This field is derived from pickups attribute. |
deliveries | Deliveries | Task connected object array *See Connected object section | Returns all tasks of type delivery connected to stops on order NOTE: This field is derived from tasks.subTasks attribute. |
deliveredAt | Delivered at | date | Returns time delivery task was completed NOTE: This field is derived from deliveries attribute.*See Read-only fields. |
pickupWindows | Pickup windows | date | Returns all requested completion windows for pickup tasks on order NOTE: This field is derived from pickups attribute. *See Read-only fields. |
deliveryWindows | Delivery windows | date | Returns all requested completion windows for delivery tasks on order NOTE: This field is derived from deliveries attribute.*See Read-only fields. |
firstOriginStop | First origin stop | Stop connected object array *See Connected object section | Returns first origin stop on order NOTE: This field is derived from tasks.stops , tasks.subTasks.stops , tasks.subTasks.subTasks attributes. |
firstPickupTask | First pickup task | Task connected object array *See Connected object section | Returns first pickup task at first origin stop NOTE: This field is derived from tasks.stops , tasks.subTasks.stops , tasks.subTasks.subTasks attributes. |
firstPickupTaskOriginAddress | First pickup task origin address | string | Returns origin address of first pickup task at first origin stop NOTE: This field is derived from tasks.stops , tasks.subTasks.stops , tasks.subTasks.subTasks , tasks.stops.location , firstPickupTask attributes.*See Read-only fields |
firstPickupTaskTime | First pickup task time | date | Returns requested pickup time of first pickup task at first origin sto NOTE: This field is derived from firstPickupTask , tasks.subTasks attributes.*See Read-only fields. |
lastDestinationStop | Last destination stop | Stop connected object array *See Connected objectt section | Returns last stop of type destination on order NOTE: This field is derived from tasks.stops , tasks.subTasks.stops , tasks.subTasks.subTasks attributes. |
lastDeliveryTask | Last delivery task | Task connected object array *See Connected object section | Returns last delivery task at last destination stop NOTE: This field is derived from tasks.stops , tasks.subTasks.stops , tasks.subTasks.subTasks attributes. |
lastDeliveryTaskDestinationAddress | Last delivery task destination address | string | Returns destination address of last delivery task at last destination stop NOTE: This field is derived from tasks.stops , tasks.subTasks.stops , tasks.subTasks.subTasks , tasks.stops.location , lastDeliveryTask attributes.*See Read-only fields. |
shipperNotes | Shipper notes | string | Aggregates all special instructions from pickup tasks on order NOTE: This field is derived from pickups.specialInstructions attribute.*See Read-only fields. |
consigneeNotes | Consignee notes | string | Aggregates all special instructions from delivery tasks on order NOTE: This field is derived from deliveries.specialInstructions attribute.*See Read-only fields. |
commodities | Commodities | Commodity connected object array *See Connected object section | Returns all commodities connected to tasks on order NOTE: This field is derived from tasks.subTasks.commodities , tasks.commodities , tasks.subTasks.subTasks attributes. |
totalCommoditiesWeight | Total commodities weight | integer | Returns total weight of all commodities on order NOTE: This field is derived from tasks.subTasks.commodities , tasks.commodities , tasks.subTasks.subTasks attributes.*See Read-only fields. |
totalCommoditiesQuantity | Total commodities quantity | integer | Returns total quantity of all commodities on quote as formatted string NOTE: This field is derived from tasks.subTasks.commodities , tasks.commodities , tasks.subTasks.subTasks attributes.*See Read-only fields. |
totalAmount | Total amount | money | Returns total of all line items on sell quote NOTE: This field is derived from earnings , sellQuote , lineItems attributes.*See Read-only fields. |
earnings | Earnings | money | Only applicable to sell quotes, provides convenience access to actions and widgets NOTE: This field is derived from sellQuote , sellQuote.lineItems attributes.*See Read-only fields. |
costs | Costs | FinancialLineItem connected object array *See Connected object section | Only applicable to sell quotes, provides convenience access to selectedBuyQuote.lineItems for actions and widgetsNOTE: This field is derived from buyQuotes.lineItems.total attribute. |
stops | Stops | Stop connected object array *See Connected object section | Location where tasks are performed for a contract, either order or manifest NOTE: This field is derived from tasks.subTasks , tasks.stops , tasks.subTasks.stops , tasks.subTasks.stops.tasks , tasks.subTasks.stops.location , tasks.subTasks.subTasks attributes. |
manifests | Manifests | Manifest connected object array *See Connected object section | Cost generating contract between broker and carrier, or carrier and either driver or owner operator NOTE: This field is derived from tasks.subTasks.parentTasks.manifest , tasks.parentTasks.manifest , tasks.subTasks.manifest , tasks.manifest attributes. |
drivers | Drivers | User connected object array *See Connected object section | Returns drivers for manifests related to current order NOTE: This field is derived from tasks.subTasks.parentTasks.manifest.drivers , tasks.subTasks.manifest.drivers , manifests.drivers , tasks.subTasks.subTasks , tasks.parentTasks.manifest.drivers , tasks.manifest.drivers attributes. |
equipment | Equipment | Equipment connected object array *See Connected object section | Returns equipment for manifests related to current order NOTE: This field is derived from tasks.subTasks.parentTasks.manifest.equipment , manifests.equipment attributes. |
mapMarkers | Map markers | MapViewMarker connected object array *See Connected objectt section | Derive mapView approved LKL pins for relevant items on order, such as assets, stops, etc.NOTE: This field is derived from lastKnownLocation , tasks.assets.currentLocation , tasks.subTasks.assets.currentLocation attributes. |
isMultiStop | Is multistop? | Boolean | Determines if order is multi-stop, checks if order has more than one leg task NOTE: This field is derived from tasks attribute.*See Read-only fields. |
Updated 26 days ago