[OPTIONAL] ShipmentStatus

Setting the Shipment Status

By default, newly created Shipments will have a Status of In Transit. If you want to set a different value for the ShipmentStatus upon creation, you will need to override the default by explicitly setting a ShipmentStatus.

Parameter

Type

Description

ShipmentStatus

Enumeration

See: ShipmentStatusType
Defaults to 5 (InTransit)

Here is an example of a shipment that was posted with the ShipmentStatus set to 1 for Pending.
When set, this will control how the Shipment displays within the freight portal:

{
  "FreightProviderReferenceNumber":"1",
  "CarrierScac":"TEST",
  "HaulLinearUnitType": 3,
  "WeightDisplayUnitType": 1,
  "ShipmentStatus": 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"
    }
  ]
}