The Exception Services comprises a JSON Object that ultimately allow users to create, update, and delete exceptions at both the shipment-level and order-level within the 10-4 System's Freight Portal.

In order to get started. you'll have to create an Exception Object. The following guides below, help you create (POST), update (PATCH), and delete (DELETE) an exception for a shipment/order.

The POST shipment exception endpoint allows the uploading of an exception on both the order-level and the entire shipment in the 10-4 Freight Portal.

The POST shipment exception endpoint has multiple parameter values that can be included in the object. As a base level requirement, the following parameters are required in order to successfully create an exception for uploading as the shipment level:

1. FreightProviderReferenceNumber and FreightHaulerProviderXID or TenFourLicensePlate
2. CarrierMC or CarrierDOT or CarrierSCAC
3. OrderExceptionType
4. Description

HTTP Endpoint:

HTTP Verb: POST
URI: /atlas/frexapi/shipment/exception
Authentication: Validation Through Request Parameters

To create an exception on the entire shipment, you'll need to first provide the specific FreightProviderReferenceNumber with your 10-4 provided FreightHaulerProviderXID. Or provide the TenFourLicensePlate.

To create an exception on the shipment, the following fields are required:

1. TenFourLicensePlate
or
2. FreightProviderReferenceNumber and FreightHaulerProviderXID

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

To create an exception on a specific shipment, the following additional fields are required:

Here you can see an example of a completely Shipment Exception JSON:

{
  "FreightProviderReferenceNumber":"12345670",
  "FreightHaulerProviderXID":"ABD3820AI",
  "OrderExceptionType":1018,
  "Description":"This is an order exception added to a shipment."
}

Success Response:

{
   "Label":"Exception Guid:",
   "ExceptionGuid":"4a8fd40e-e188-4a1c-9195-c9ab2b9e458d"
}