Adding an Exception to an Order

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

To create an exception on the shipment's specific order, the following fields are required:

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

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 external reference number of the shipper's given shipment (BOL).

Adding the Carrier

Next, in order to assign a shipment's order-level exception 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.

Adding Exception-Detail Data

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

Parameter

Type

Description

OrderNumber

String

The name of the externally referenced order number.

OrderExceptionType

Enumeration

Enumeration type of the exception being created. For a list of valid exception types for your organization, see the GET - Organization Exceptions endpoint which returns all exceptions for an organization.

Description

String

Description of the exception.

Here you can see an example of a completely DocumentUpload Object:

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

Success Response:

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