Defining the Haul and Weight Display

In order to better meet the needs of users in all areas of the globe, we allow the haul length type and weight display type to be defined at the shipment level. This will allow users to see their shipment using the proper units when displayed within the Freight Portal UI.

Parameter	Type	Description
HaulLinearUnitType	Enumeration	See: Linear Units Miles and Kilometers are the only accepted options for this linear unit.
WeightDisplayUnitType	Enumeration	See: WeightDisplayUnit

Here is an example of a shipment that was posted with the HaulLinearUnitType set to 3 for Kilometers and WeightDisplayUnitType set to 1 for pounds, when set, this will control how the haul length displays within the freight portal:

{
  "FreightProviderReferenceNumber":"1",
  "CarrierScac":"TEST",
  "HaulLinearUnitType": 3,
  "WeightDisplayUnitType": 1,
  "Stops":
  [
    {
      "StopReference":"Stop1",
      "StopScheduledDatePart":"2018-11-12",
      "StopSequence":1,
      "StopType":1,
      "StreetAddress1":"4888 Pearl East Cir",
      "City":"Boulder",
      "PostalCode":"80301",
      "State":"CO",
      "Country":"US"
    },
    {
      "StopReference":"Stop2",
      "StopScheduledDatePart":"2018-12-12",
      "StopSequence":2,
      "StopType":3,
      "StreetAddress1":" 935 Stewart Dr",
      "City":"Sunnyvale",
      "PostalCode":"94085",
      "State":"CA",
      "Country":"US"
    }
  ]
}

Please note that WeightDisplayUnitType does not affect the data received on the WeightUnit within the commodity. Since we have many contributors to data on a shipment, WeightDisplayUnitType allows the Freight Portal to normalize this information for the user within the portal without modifying the data what was sent in by the user.