Order OLD

Overview

The Order object represents a revenue-generating agreement that may involve various parties such as carriers, brokers, and shippers. It serves as a container for data relating to the work to be executed and tracks the progression of that work.
The object contains the details about the services agreed upon and the parties involved, which is detailed in the tasks object.

Fields

Below is a detailed list of the fields associated with Order object, outlining the structure and key data points necessary for order 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

Fields	Labels	DataType	Descriptions	Remarks
id	Order ID	String	Unique identifier of Order Object.	Automatically assigned by System.
fullId	Full ID	String	An auto-generated identifier for the order record.	Automatically assigned by System.
status	Status	Enum	Status associated with the Order.	New Booked In transit Delivered Invoiced Tendered Rejected Archived
poNum	PO No.	String	Provided by the recipient, it represents an order, such as restocking inventory. This number is commonly used for searching quotes and orders.
refNum	REF No.	String	A general-purpose field designed to store reference IDs from other systems. Also commonly used as a search term.
loadTenderNum	Load tender No.	String	A reference number for a load provided by the shipper, often used by carriers to reference a BOL or order.
totalMiles	Total miles	Number	The total distance in miles for the quote, calculated from the addresses of stops using a polyline distance calculation provided by our map API provider.
estimatedDuration	Estimated duration	Number	The total estimated time from origin to destination in seconds.
customsBroker	Customs broker	String	The customs broker for the order.
portOfEntry	Port of entry	String	The location where a shipment enters a country.
declaredValue	Declared value	Money	The value of the items being shipped.
lastSeenTime	Last Known Location Timestamp	DateTimeValue	Timestamp indicating the last time the order's current location was updated in the system.
specialInstructions	Special instructions	String	Special instructions that should be included on the BOL and visible to the driver, once the manifest is created.
requestedPickupWindow	Requested pickup[]	DateTimeValue	A date range within which the customer requests the load to be delivered.
actualPickupDate	Actual Pickup Date	DateTimeValue	The specific date and time when the load is picked up.
actualDeliveryDate	Actual Delivery Date	DateTimeValue	The specific date and time when the load is delivered.
totalEarnings	Total earnings	Money	The sum of line items on the associated sell quotes.
totalCost	Total cost	Money	The sum of line items on the associated buy quote.
pickedUpAt	Picked up at	DateTimeValue	Provides the timestamp when the pickup task is completed.	Derived Field
deliveredAt	Delivered at	DateTimeValue	Provides the timestamp when the delivery task is completed.	Derived Field
pickupWindows	Pickup windows	DateTimeValue\[]	Lists all requested completion windows for pickup tasks on the order.	Derived Field
deliveryWindows	Delivery windows	DateTimeValue\[]	Lists all requested completion windows for delivery tasks on the order.	Derived Field
firstPickupTaskOriginAddress	First pickup task origin address	String	Provides the origin address of the first pickup task at the first origin stop.	Derived Field
firstPickupTaskTime	First pickup task time	DateTimeValue	Provides the requested pickup time of the first pickup task at the first origin stop.	Derived Field
lastDeliveryTaskDestinationAddress	Last delivery task destination address	String	Provides the destination address of the last delivery task at the last destination stop.	Derived Field
shipperNotes	Shipper notes	String	Aggregates all special instructions from pickup tasks on the order.	Derived Field
consigneeNotes	Consignee notes	String	Aggregates all special instructions from delivery tasks on the order.	Derived Field
totalCommoditiesWeight	Total commodities weight	Number	Indicates the total weight of all commodities on the order.	Derived FIeld unitLabel: 'lbs'
totalCommoditiesQuantity	Total commodities quantity	String	Specifies the total quantity of all commodities on the quote as a formatted string.	Derived Field
totalAmount	Total amount	Money	Specifies the total of all line items on the sell quote.	Derived Field
earnings	Earnings	Money	Returns all the line items for an Order's associated buy quote.	Derived Field
isMultiStop	Is multistop?	Boolean	Determines if an order is multi-stop by checking if it has more than one leg task.	Derived Field

Extra Includes & Nested Objects

Fields	Labels	DataType	Descriptions	Remarks
customer	Customer	Customer	The customer associated with the order. Customers can be shippers, receivers, brokers, or other organizations within the supply chain.
tasks	Tasks	Task\[]	A task is work that needs to be completed by an assignee to fulfill a contract or win a quote. Tasks can be grouped together to form legs or other types of groups. Tasks can carry financial items for allocation at a more granular level.
tags	Tags	Tag\[]	Tags that are associated with the order.
sellQuote	Customer quote	Quote	This is the quote presented to the customer, representing the revenue potential of the order.
buyQuotes	Partner quotes	Quote\[]	An array of quotes from multiple partners for a multi-partner order.
documents	Documents	Document\[]	Documents associated with the order.
billingParty	Billing party	Address	The party responsible for the billing of the load, which could be the shipper, consignee, or a third party.
lineItems	Line items	FinancialLineItems\[]	Individual charges or items associated with an order, such as accessorials or fuel surcharges.
shipper	First pickup	Address	The origin of the load.
consignee	Last delivery	Address	The destination of the load.
csrs	CSR	User\[]	Customer Service Representative of the company on the order.
accountManagers	AM	User\[]	Account Manager of the company on the order.
commissionees	On commission	User\[]	Employees that are on commission for the associated order. This could include CSRs, AMs, or other.
currentLocation	Current location	Address	Address of the assets or driver's current location
assetType	Asset type	AssetType	The type of asset required for the order.
serviceType	Service type	PartnerService	The type of service required for the order.
partners	Partners	Partner\[]	Brokers can assign multiple partners to an order.	Derived Field
assetWithLastKnownLocation	Asset with last known location	Asset	Provides the location of the first asset linked to the order.	Derived Field
origins	Origins	Stop\[]	Lists all stops labeled as "origin" that are connected to the order.	Derived Field
destinations	Destinations	Stop\[]	Lists all stops labeled as "destination" directly connected to the order.	Derived Field
allocatableTasks	Allocatable tasks	Task\[]	Lists all tasks eligible for allocation to this order, including subtasks within leg tasks.	Derived Field
firstLeg	First leg	Task\[]	Identifies the first leg associated with the order.	Derived Field
pickups	Pickups	Task\[]	Lists all tasks labeled as "pickup" directly connected to the stops on the order.	Derived Field
deliveries	Deliveries	Task\[]	Lists all tasks labeled as "delivery" directly connected to stops on the order.	Derived Field
firstOriginStop	First origin stop	Stop\[]	Identifies the first origin stop on the order.	Derived Field
firstPickupTask	First pickup task	Task\[]	Identifies the first pickup task at the first origin stop.	Derived Field
lastDestinationStop	Last destination stop	Stop\[]	Identifies the last stop of the type destination on the order.	Derived Field
lastDeliveryTask	Last delivery task	Task\[]	Identifies the last delivery task at the last destination stop.	Derived Field
commodities	Commodities	Commodity\[]	Lists all commodities that are connected to tasks on the order.	Derived Field
costs	Costs	FinancialLineItem\[]	Returns all the line items for an Order's associated sell quote.	Derived Field
stops	Stops	Stop\[]	A stop is a location where tasks are performed for an order or manifest.	Derived Field
manifests	Manifests	Manifest\[]	A manifest is a cost generating contract between a broker and a carrier, or a carrier and a driver/owner operator.	Derived Field
drivers	Drivers	User\[]	Drivers associated with manifests related to the current order.	Derived Field
equipment	Equipment	Equipment\[]	Equipment for the manifests related to the current order.	Derived Field
mapMarkers	Map markers	MapViewMarker\[]	Visual indicators on a map that represent items like assets and stops.	This field derives "mapView approved" Last Known Location pins (LKL) for relevant items on the order such as assets, stops.

Write Fields

Object-specific body in POST and PUT requests

Fields	Labels	DataType	Descriptions	Remarks
status	Status	Enum	Status associated with the Order.	Default:New Booked In transit Delivered Invoiced Tendered Rejected Archived
poNum	PO No.	String	Provided by the recipient, it represents an order, such as restocking inventory. This number is commonly used for searching quotes and orders.
refNum	REF No.	String	A general-purpose field designed to store reference IDs from other systems. Also commonly used as a search term.
loadTenderNum	Load tender No.	String	A reference number for a load provided by the shipper, often used by carriers to reference a BOL or order.
totalMiles	Total miles	Number	The total distance in miles for the quote, calculated from the addresses of stops using a polyline distance calculation provided by our map API provider.
estimatedDuration	Estimated duration	Number	The total estimated time from origin to destination in seconds.
customsBroker	Customs broker	String	The customs broker for the order.
portOfEntry	Port of entry	String	The location where a shipment enters a country.
declaredValue	Declared value	Money	The value of the items being shipped.
lastSeenTime	Last Known Location Timestamp	DateTimeValue	Timestamp indicating the last time the order's current location was updated in the system.
specialInstructions	Special instructions	String	Special instructions that should be included on the BOL and visible to the driver, once the manifest is created.
requestedPickupWindow	Requested pickup[]	DateTimeValue	A date range within which the customer requests the load to be delivered.
actualPickupDate	Actual Pickup Date	DateTimeValue	The specific date and time when the load is picked up.
actualDeliveryDate	Actual Delivery Date	DateTimeValue	The specific date and time when the load is delivered.
totalEarnings	Total earnings	Money	The sum of line items on the associated sell quotes.
totalCost	Total cost	Money	The sum of line items on the associated buy quote.

Optional Nested Object (Related Objects)

Fields	Labels	DataType	Descriptions	Remarks
customer	Customer	Customer	The customer associated with the order. Customers can be shippers, receivers, brokers, or other organizations within the supply chain.
tasks	Tasks	Task\[]	A task is work that needs to be completed by an assignee to fulfill a contract or win a quote. Tasks can be grouped together to form legs or other types of groups. Tasks can carry financial items for allocation at a more granular level.
tags	Tags	Tag\[]	Tags that are associated with the order.
sellQuote	Customer quote	Quote	This is the quote presented to the customer, representing the revenue potential of the order.
buyQuotes	Partner quotes	Quote\[]	An array of quotes from multiple partners for a multi-partner order.
documents	Documents	Document\[]	Documents associated with the order.
billingParty	Billing party	Address	The party responsible for the billing of the load, which could be the shipper, consignee, or a third party.
lineItems	Line items	FinancialLineItems\[]	Individual charges or items associated with an order, such as accessorials or fuel surcharges.
shipper	First pickup	Address	The origin of the load.
consignee	Last delivery	Address	The destination of the load.
csrs	CSR	User\[]	Customer Service Representative of the company on the order.
accountManagers	AM	User\[]	Account Manager of the company on the order.
commissionees	On commission	User\[]	Employees that are on commission for the associated order. This could include CSRs, AMs, or other.
currentLocation	Current location	Address	Address of the assets or driver's current location
assetType	Asset type	AssetType	The type of asset required for the order.
serviceType	Service type	PartnerService	The type of service required for the order.