Updating Stop Appointment 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 StopStatus information, the following additional fields are required:

Parameter	Type	Description
StopSequence	Integer	The stop sequence number that is associated with this update.

Here is an example of the JSON Object thus far:

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

Updating an Appointment Time

A shipment's stop can have additional data points updated to deliver data-rich stop-specific data. To update the StopStatus Object with appointment time information, simply add the optional ShipmentStopAppointment Object below:

Parameter	Type	Description
AppointmentDatePart	DateTime	This is the date and time of the appointment. If missing and "AppointmentType" is 'OpenWindow', then it will be copied from the "ShipmentStop.StopScheduledDatePart" parameter.
AppointmentStartTimePart	TimeSpan	This is the start date and time of the appointment. If missing and "AppointmentType" is 'OpenWindow', then it will be copied from the "ShipmentStop.StopScheduledStartTimePart" parameter.
AppointmentEndTimePart	TimeSpan	This is the end date and time of the appointment. If missing and "AppointmentType" is 'OpenWindow', then it will be copied from the "ShipmentStop.StopScheduledEndTimePart" parameter.
AppointmentType	Enumeration	Enumeration type of the given shipment's appointment type.

Here is an example JSON Object thus far:

{
  "FreightProviderReferenceNumber":"12345670",
  "FreightHaulerProviderXID":"ABD3820AI",
  "CarrierSCAC":"ABCD",
  "StopSequence":1,
  "Appointment": 
  {
    "AppointmentType": 1,
    "AppointmentDatePart": "2016-12-25",
    "AppointmentStartTimePart": "11:12:30",
    "AppointmentEndTimePart": "12:22:30"
  }
}

Completed Updated Appointment Time JSON Object

Here you can see an example of a completely valid StopStatus ETA update with an ETA set on the origin stop:

{
  "FreightProviderReferenceNumber":"12345670",
  "FreightHaulerProviderXID":"ABD3820AI",
  "CarrierSCAC":"ABCD",
  "StopSequence":1,
  "Appointment": 
  {
    "AppointmentType": 1,
    "AppointmentDatePart": "2016-12-25",
    "AppointmentStartTimePart": "11:12:30",
    "AppointmentEndTimePart": "12:22:30"
  }
}