[OPTIONAL] Commodities

Adding a Basic OrderCommodity

Orders can have commodities added to them to deliver data-rich order-detail line items. To create shipments with basic commodity information, simply invoke the OrderCommodity Object with the required parameters as seen below:

Parameter	Type	Description
CommodityName	String	External Reference to Freight Provider SKU. Will create a SKU for the freight provider when a SKU does not already exist. Max Length: 50.

Parameter

Type

Description

CommodityName

String

External Reference to Freight Provider SKU. Will create a SKU for the freight provider when a SKU does not already exist.

Max Length: 50.

Additional Options

Orders can have order commodity data points added to deliver data-rich detail at the individual order level. To create shipments with additional commodity details, add the optional parameters below:

Parameter	Type	Description
PieceDescription	String	When creating an SKU, this description will be used. If not supplied, “CommodityName” will be used as the description.
Height	Integer	Height of the commodity.
IsHazardous	Boolean	Whether the commodity is hazardous.
HazmatTypes	Enumeration HazmatTypes	Allows the user to define the hazmat type when IsHazzardous is in use.
IsStackable	Boolean	Whether the commodity is stackable.
Length	Integer	Length of the commodity.
LinearUnit	Enumeration	Enumeration type for a given commodity's type of linear unit.
PieceCount	Integer	Number of pieces.
PieceUnit	Enumeration	Enumeration type for a given commodity's type of piece unit.
ProductBrand	String	Product Brand associated with the commodity. Max Length: 50.
ProductLine	String	Product Line associated with the commodity. Max Length: 50.
PurchaseOrderNumber	String	The external reference for order. Max Length: 50.
Volume	Integer	The volume of commodity.
VolumeUnit	Enumeration VolumeUnit	Enumeration type for a given commodity's type measurement unit of volume.
WeightAmount	Integer	The weight of commodity.
WeightUnit	Enumeration	Enumeration type for a given commodity's type of weight unit.
Width	Integer	The width of commodity.
AllowDeliveredQuantity	Boolean	This determines whether the user would like to have delivered quantity captured by a driver using the Visibility Drive app. If true, mobile driver users will have the ability to enter the delivered quantities at the commodity level. If false, this information will not be available for the driver to enter.

Completed OrderCommodity Object

Here is an example of the JSON Object:

{
  "FreightProviderReferenceNumber":"5757575",
  "CarrierScac":"TEST",
  "Stops":
  [
    {
      "StopReference":"1",
      "StopScheduledDatePart":"2018-08-11",
      "StopSequence":1,
      "StopType":1,
      "Latitude":50.1234,
      "Longitude":-45.1234
    },
    {
      "StopReference":"2",
      "StopScheduledDatePart":"2018-08-12",
      "StopSequence":2,
      "StopType":3,
      "Latitude":50.4920,
      "Longitude":-44.5543
    }
  ],
  "Orders": 
  [
    {
      "Commodities": 
      [
        {
          "CommodityName":"Funny Warehouse Employee = Commodian"
          "AllowDeliveredQuantity": false,
        }
      ],
      "PickupStopReference" : "1",
      "DeliveryStopReference" : "2",
      "OrderNumber" : "JUSTANORDERNARYORDER"
    }
  ]
}

{
  "FreightProviderReferenceNumber":"757575",
  "CarrierScac":"TEST",
  "Stops":
  [
    {
      "StopReference":"1",
      "StopScheduledDatePart":"2018-08-11",
      "StopSequence":1,
      "StopType":1,
      "Latitude":50.1234,
      "Longitude":-45.1234
    },
    {
      "StopReference":"2",
      "StopScheduledDatePart":"2018-08-12",
      "StopSequence":2,
      "StopType":3,
      "Latitude":50.4920,
      "Longitude":-44.5543
    }
  ],
  "Orders": 
  [
    {
      "Commodities": 
      [
        {
          "PieceDescription":".14ISPIECEOFPI",
          "Height":32,
          "IsHazardous":0,
          "IsStackable":1,
          "CommodityName":"Commodian",
          "Length":12,
          "LinearUnit":"2",
          "PieceCount":8,
          "PieceUnit":"3",
          "ProductBrand":"VISIBILITY ALE",
          "ProductLine":"DOUBLE VISION",
          "PurchaseOrderNumber":"10-4Av2",
          "Volume":313,
          "VolumeUnit":"1",
          "WeightAmount":11644,
          "WeightUnit":"1",
          "Width":29
        }
      ],
      "PickupStopReference" : "1",
      "DeliveryStopReference" : "2",
      "OrderNumber" : "DEGN92575474"
    }
  ]
}

Updated about 2 months ago

What’s Next

[OPTIONAL] Driver Details