Updating an Arrival/Departure Timestamp

Updating Stop Arrival and Departure Times

To PATCH a shipment's specific StopStatus, you'll need to first provide the specific FreightProviderReferenceNumber with your 10-4 provided FreightHaulerProviderXID or the TenFourLicensePlate.

To PATCH a StopStatus, the following fields are required:

1. FreightProviderReferenceNumber and FreightHaulerProviderXID
2. TenFourLicensePlate

Parameter	Type	Description
FreightProviderReferenceNumber	String	The external reference number of the shipper's given shipment (BOL).
FreightHaulerProviderXID	String	10-4's external reference id between a shipper and a carrier.
TenFourLicensePlate	String	The uniquely generated 10-4 response when creating a shipment within Freight Portal.

Here is an example JSON Object:

{
  "FreightProviderReferenceNumber":"12345670",
  "FreightHaulerProviderXID":"ABD3820AI"
}

{
  "TenFourLicensePlate":"T9302NB"
}

Adding the Carrier

Next, in order to assign a shipment to a specific carrier, you'll need to supply one of the following carrier identification parameters listed below:

Parameter	Type	Description
CarrierMC	String	The external reference to the carrier's MC-Number.
CarrierDOT	String	The external reference to the carrier's USDOT-Number.
CarrierSCAC	String	The external reference to the carrier's SCAC.

Here is an example of the JSON Object thus far:

{
  "FreightProviderReferenceNumber":"12345670",
  "FreightHaulerProviderXID":"ABD3820AI",
  "CarrierMC":"3829182"
}

{
  "FreightProviderReferenceNumber":"12345670",
  "FreightHaulerProviderXID":"ABD3820AI",
  "CarrierDOT":"110392"
}

{
  "FreightProviderReferenceNumber":"12345670",
  "FreightHaulerProviderXID":"ABD3820AI",
  "CarrierSCAC":"ABCD"
}

Other Required Fields

To update a specific shipment's Arrival or Departure information, the following additional fields are required:

Parameter	Type	Description
StopSequence	Integer	The stop sequence number that is associated with this update.
PositionEventTypeId	Enumeration	Enumeration type of the given shipment's position event type.
ReportTime	DateTimeOffset	DateTime of the event.

Here is an example of the JSON Object thus far:

{
  "FreightProviderReferenceNumber":"12345670",
  "FreightHaulerProviderXID":"ABD3820AI",
  "CarrierSCAC":"ABCD",
  "StopSequence":1,
  "PositionEventTypeId":"1",
  "ReportTime": "2017-03-20T17:52:22"
}

Completed Updated Arrival/Departure Timestamp JSON Object

Here you can see an example of a completely valid Arrival or Departure set for the origin stop:

{
  "FreightProviderReferenceNumber":"12345670",
  "FreightHaulerProviderXID":"ABD3820AI",
  "CarrierSCAC":"ABCD",
  "StopSequence":1,
  "PositionEventTypeId":"1",
  "ReportTime": "2017-03-20T17:52:22"
}

{
  "FreightProviderReferenceNumber":"12345670",
  "FreightHaulerProviderXID":"ABD3820AI",
  "CarrierSCAC":"ABCD",
  "StopSequence":1,
  "PositionEventTypeId":"2",
  "ReportTime": "2017-03-20T17:52:22"
}

Updated about 2 months ago

What’s Next

POST - Shipment Tracking