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

FieldsLabelsDataTypeDescriptionsRemarks
idOrder IDStringUnique identifier of Order Object.Automatically assigned by System.
fullIdFull IDStringAn auto-generated identifier for the order record.Automatically assigned by System.
statusStatusEnumStatus associated with the Order.New
Booked
In transit
Delivered
Invoiced
Tendered
Rejected
Archived
poNumPO No.StringProvided by the recipient, it represents an order, such as restocking inventory. This number is commonly used for searching quotes and orders.
refNumREF No.StringA general-purpose field designed to store reference IDs from other systems. Also commonly used as a search term.
loadTenderNumLoad tender No.StringA reference number for a load provided by the shipper, often used by carriers to reference a BOL or order.
totalMilesTotal milesNumberThe total distance in miles for the quote, calculated from the addresses of stops using a polyline distance calculation provided by our map API provider.
estimatedDurationEstimated durationNumberThe total estimated time from origin to destination in seconds.
customsBrokerCustoms brokerStringThe customs broker for the order.
portOfEntryPort of entryStringThe location where a shipment enters a country.
declaredValueDeclared valueMoneyThe value of the items being shipped.
lastSeenTimeLast Known Location TimestampDateTimeValueTimestamp indicating the last time the order's current location was updated in the system.
specialInstructionsSpecial instructionsStringSpecial instructions that should be included on the BOL and visible to the driver, once the manifest is created.
requestedPickupWindowRequested pickup[]DateTimeValueA date range within which the customer requests the load to be delivered.
actualPickupDateActual Pickup DateDateTimeValueThe specific date and time when the load is picked up.
actualDeliveryDateActual Delivery DateDateTimeValueThe specific date and time when the load is delivered.
totalEarningsTotal earningsMoneyThe sum of line items on the associated sell quotes.
totalCostTotal costMoneyThe sum of line items on the associated buy quote.
pickedUpAtPicked up atDateTimeValueProvides the timestamp when the pickup task is completed.Derived Field
deliveredAtDelivered atDateTimeValueProvides the timestamp when the delivery task is completed.Derived Field
pickupWindowsPickup windowsDateTimeValue\[]Lists all requested completion windows for pickup tasks on the order.Derived Field
deliveryWindowsDelivery windowsDateTimeValue\[]Lists all requested completion windows for delivery tasks on the order.Derived Field
firstPickupTaskOriginAddressFirst pickup task origin addressStringProvides the origin address of the first pickup task at the first origin stop.Derived Field
firstPickupTaskTimeFirst pickup task timeDateTimeValueProvides the requested pickup time of the first pickup task at the first origin stop.Derived Field
lastDeliveryTaskDestinationAddressLast delivery task destination addressStringProvides the destination address of the last delivery task at the last destination stop.Derived Field
shipperNotesShipper notesStringAggregates all special instructions from pickup tasks on the order.Derived Field
consigneeNotesConsignee notesStringAggregates all special instructions from delivery tasks on the order.Derived Field
totalCommoditiesWeightTotal commodities weightNumberIndicates the total weight of all commodities on the order.Derived FIeld
unitLabel: 'lbs'
totalCommoditiesQuantityTotal commodities quantityStringSpecifies the total quantity of all commodities on the quote as a formatted string.Derived Field
totalAmountTotal amountMoneySpecifies the total of all line items on the sell quote.Derived Field
earningsEarningsMoneyReturns all the line items for an Order's associated buy quote.Derived Field
isMultiStopIs multistop?BooleanDetermines if an order is multi-stop by checking if it has more than one leg task.Derived Field

Extra Includes & Nested Objects

FieldsLabelsDataTypeDescriptionsRemarks
customerCustomerCustomerThe customer associated with the order. Customers can be shippers, receivers, brokers, or other organizations within the supply chain.
tasksTasksTask\[]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.
tagsTagsTag\[]Tags that are associated with the order.
sellQuoteCustomer quoteQuoteThis is the quote presented to the customer, representing the revenue potential of the order.
buyQuotesPartner quotesQuote\[]An array of quotes from multiple partners for a multi-partner order.
documentsDocumentsDocument\[]Documents associated with the order.
billingPartyBilling partyAddressThe party responsible for the billing of the load, which could be the shipper, consignee, or a third party.
lineItemsLine itemsFinancialLineItems\[]Individual charges or items associated with an order, such as accessorials or fuel surcharges.
shipperFirst pickupAddressThe origin of the load.
consigneeLast deliveryAddressThe destination of the load.
csrsCSRUser\[]Customer Service Representative of the company on the order.
accountManagersAMUser\[]Account Manager of the company on the order.
commissioneesOn commissionUser\[]Employees that are on commission for the associated order. This could include CSRs, AMs, or other.
currentLocationCurrent locationAddressAddress of the assets or driver's current location
assetTypeAsset typeAssetTypeThe type of asset required for the order.
serviceTypeService typePartnerServiceThe type of service required for the order.
partnersPartnersPartner\[]Brokers can assign multiple partners to an order.Derived Field
assetWithLastKnownLocationAsset with last known locationAssetProvides the location of the first asset linked to the order.Derived Field
originsOriginsStop\[]Lists all stops labeled as "origin" that are connected to the order.Derived Field
destinationsDestinationsStop\[]Lists all stops labeled as "destination" directly connected to the order.Derived Field
allocatableTasksAllocatable tasksTask\[]Lists all tasks eligible for allocation to this order, including subtasks within leg tasks.Derived Field
firstLegFirst legTask\[]Identifies the first leg associated with the order.Derived Field
pickupsPickupsTask\[]Lists all tasks labeled as "pickup" directly connected to the stops on the order.Derived Field
deliveriesDeliveriesTask\[]Lists all tasks labeled as "delivery" directly connected to stops on the order.Derived Field
firstOriginStopFirst origin stopStop\[]Identifies the first origin stop on the order.Derived Field
firstPickupTaskFirst pickup taskTask\[]Identifies the first pickup task at the first origin stop.Derived Field
lastDestinationStopLast destination stopStop\[]Identifies the last stop of the type destination on the order.Derived Field
lastDeliveryTaskLast delivery taskTask\[]Identifies the last delivery task at the last destination stop.Derived Field
commoditiesCommoditiesCommodity\[]Lists all commodities that are connected to tasks on the order.Derived Field
costsCostsFinancialLineItem\[]Returns all the line items for an Order's associated sell quote.Derived Field
stopsStopsStop\[]A stop is a location where tasks are performed for an order or manifest.Derived Field
manifestsManifestsManifest\[]A manifest is a cost generating contract between a broker and a carrier, or a carrier and a driver/owner operator.Derived Field
driversDriversUser\[]Drivers associated with manifests related to the current order.Derived Field
equipmentEquipmentEquipment\[]Equipment for the manifests related to the current order.Derived Field
mapMarkersMap markersMapViewMarker\[]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

FieldsLabelsDataTypeDescriptionsRemarks
statusStatusEnumStatus associated with the Order.Default:New
Booked
In transit
Delivered
Invoiced
Tendered
Rejected
Archived
poNumPO No.StringProvided by the recipient, it represents an order, such as restocking inventory. This number is commonly used for searching quotes and orders.
refNumREF No.StringA general-purpose field designed to store reference IDs from other systems. Also commonly used as a search term.
loadTenderNumLoad tender No.StringA reference number for a load provided by the shipper, often used by carriers to reference a BOL or order.
totalMilesTotal milesNumberThe total distance in miles for the quote, calculated from the addresses of stops using a polyline distance calculation provided by our map API provider.
estimatedDurationEstimated durationNumberThe total estimated time from origin to destination in seconds.
customsBrokerCustoms brokerStringThe customs broker for the order.
portOfEntryPort of entryStringThe location where a shipment enters a country.
declaredValueDeclared valueMoneyThe value of the items being shipped.
lastSeenTimeLast Known Location TimestampDateTimeValueTimestamp indicating the last time the order's current location was updated in the system.
specialInstructionsSpecial instructionsStringSpecial instructions that should be included on the BOL and visible to the driver, once the manifest is created.
requestedPickupWindowRequested pickup[]DateTimeValueA date range within which the customer requests the load to be delivered.
actualPickupDateActual Pickup DateDateTimeValueThe specific date and time when the load is picked up.
actualDeliveryDateActual Delivery DateDateTimeValueThe specific date and time when the load is delivered.
totalEarningsTotal earningsMoneyThe sum of line items on the associated sell quotes.
totalCostTotal costMoneyThe sum of line items on the associated buy quote.

Optional Nested Object (Related Objects)

FieldsLabelsDataTypeDescriptionsRemarks
customerCustomerCustomerThe customer associated with the order. Customers can be shippers, receivers, brokers, or other organizations within the supply chain.
tasksTasksTask\[]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.
tagsTagsTag\[]Tags that are associated with the order.
sellQuoteCustomer quoteQuoteThis is the quote presented to the customer, representing the revenue potential of the order.
buyQuotesPartner quotesQuote\[]An array of quotes from multiple partners for a multi-partner order.
documentsDocumentsDocument\[]Documents associated with the order.
billingPartyBilling partyAddressThe party responsible for the billing of the load, which could be the shipper, consignee, or a third party.
lineItemsLine itemsFinancialLineItems\[]Individual charges or items associated with an order, such as accessorials or fuel surcharges.
shipperFirst pickupAddressThe origin of the load.
consigneeLast deliveryAddressThe destination of the load.
csrsCSRUser\[]Customer Service Representative of the company on the order.
accountManagersAMUser\[]Account Manager of the company on the order.
commissioneesOn commissionUser\[]Employees that are on commission for the associated order. This could include CSRs, AMs, or other.
currentLocationCurrent locationAddressAddress of the assets or driver's current location
assetTypeAsset typeAssetTypeThe type of asset required for the order.
serviceTypeService typePartnerServiceThe type of service required for the order.