[OPTIONAL] Trip ID

Defining the TripID on a Shipment

For users that wish to track trips for freight that spans multiple modes and shipments, we provide the ability to define the Trip ID on the shipment object. Sending in this optional value on more than one shipment will tie any shipments with the same trip ID together for tracking within the UI.

Parameter

Type

Description

tripID

String

tripID is a string value that allows for multiple shipments to be tied to one another for the purpose of display in the UI.

Here is an example of a shipment that was posted with a tripID

{
  "FreightProviderReferenceNumber":"1",
  "CarrierMC":"TEST",
  "tripID":"ExampleTripID1",
  "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"
    }
  ]
}

Example Response:

{
    "TenFourLicensePlate": "CO6CF7E6"
}