PATCH - Stop Status

The StopStatus Service comprises JSON Objects that allow users to update attributes of a ShipmentStop Object such as their ETA, AppointmentTime, ActualArrivalTime, and ActualDepartureTime in 10-4 System's Freight Portal.

In order to get started. you'll have to create a StopStatus Object. The following guides below help you update (PATCH) a specific ShipmentStop Object's information.

The PATCH stopStatus endpoint allows the updating of a specific shipment's stop status information in the Freight Portal.

The PATCH stopStatus endpoint has multiple parameter values that can be included in the object. As a base level requirement, the following parameters are required

1. FreightProviderReferenceNumber and FreightHaulerProviderXID or TenFourLicensePlate
2. CarrierMC or CarrierSCAC or CarrierDOT
3. StopSequence

1. FreightProviderReferenceNumber and FreightHaulerProviderXID or TenFourLicensePlate
2. CarrierMC or CarrierSCAC or CarrierDOT
3. StopSequence
4. ReportTime
5. ShipmentStopAppointment Object
6. EstimatedDeliveryDate
7. RetainEstimatedDeliveryDate
8. PositionEventTypeId

The PATCH HTTP Endpoint for the StopStatus is listed below:

HTTP Verb: PATCH
URI: /atlas/frexapi/shipment/stopstatus
Authentication: Validation Through Request Parameters

Success Response:

True