The Shipment Services allows users to create, update, retrieve, and delete shipments within the 10-4 System's Freight Portal. Orders and Commodities can also be managed.

In order to get started. you'll have to create a Basic ShipmentContent Object. The following guides below, help you create (POST), retrieve (GET), delete (DELETE), and update (PUT) a shipment.

Create Shipment

The POST shipment endpoint allows the creation of a specific shipment in the Freight Portal and prepares a shipment for position and shipment statuses to be tracked against.

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

1. ShipmentContent Object
2. ShipmentStop Object

1. ShipmentContent Object
2. ShipmentStop Object
3. ShipmentStopAppointment Object
4. Order Object
5. OrderCommodity Object

The POST HTTP Endpoint for shipment creation is listed below:

HTTP Verb: POST
URI: /atlas/frexapi/shipment
Authentication: Basic Auth or Bearer Token

Adding the FreightProviderReferenceNumber

To create a basic shipment, the customer internal reference must be supplied in the form of a FreightProviderReferenceNumber. Below are the details of this parameter:

Parameter	Type	Description
FreightProviderReferenceNumber	String	This is the reference number that is supplied by a user of the Freight Portal in order to tie the shipment from the Freight Portal back to the users source system.

Adding the Carrier

Next, in order to assign a shipment to a specific carrier, you'll need to supply at least 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 the Stops

Next you will need to invoke the ShipmentStop Object for at least two stops (the origin and destination). Below are the parameters that help identify the type of stop:

Parameter	Type	Description
StopReference	String	Stop reference name, must one unique.
StopScheduledDatePart	Date	The scheduled date of stop.
StopScheduledStartTimePart	TimeSpan	The scheduled window start time of stop.
StopScheduledEndTimePart	TimeSpan	The scheduled window end time of stop.
StopSequence	Integer	Sequence number of the stop. The sequence range is 1 through the number of stops. Sequence must be unique within the collection of stops.
StopType	Enumeration	The enumeration type of the stop.

Adding the Stop Location Data

To have the ShipmentStop Object validate properly, you must supply a method to infer the physical location of the stop. Below are the three examples of what you may choose from and their respected parameters, data types, and descriptions.

1. Latitude and Longitude
2. StreetAddress1, City, PostalCode, State, and Country
1. FixedLocationCode

Parameter	Type	Description
Latitude	Decimal	Latitude of the shipment's stop. Can be up to 6 decimal places long.
Longitude	Decimal	Longitude of the shipment's stop. Can be up to 6 decimal places long.
StreetAddress1	String	Street address of the stop. Max Length: 500.
City	String	City of the stop.
State	String	State of the stop.
PostalCode	String	PostalCode of the stop.
Country	String	Country of the stop.
LocationCode	String	This is the location code of a location within Locations in the Freight Portal. To use this, a location must be created prior to the shipment creation.

Completed Basic Shipment Object

Here is an example of a completely valid basic shipment JSON Object:

{
  "FreightProviderReferenceNumber":"12345678",
  "CarrierScac":"TEST",
  "Stops":
  [
    {
      "StopReference":"STOP1",
      "StopScheduledDatePart":"2018-08-11",
      "StopSequence":1,
      "StopType":1,
      "Latitude":50.1234,
      "Longitude":-45.1234
    },
    {
      "StopReference":"STOP2",
      "StopScheduledDatePart":"2018-08-12",
      "StopSequence":2,
      "StopType":3,
      "Latitude":50.4920,
      "Longitude":-44.5543
    }
  ]
}

{
  "FreightProviderReferenceNumber":"1",
  "CarrierScac":"TEST",
  "Stops":
  [
    {
      "StopReference":"Stop1",
      "StopScheduledDatePart":"2018-08-11",
      "StopSequence":1,
      "StopType":1,
      "StreetAddress1":"4888 Pearl East Cir",
      "City":"Boulder",
      "PostalCode":"80301",
      "State":"CO",
      "Country":"US"
    },
    {
      "StopReference":"Stop2",
      "StopScheduledDatePart":"2018-08-12",
      "StopSequence":2,
      "StopType":3,
      "StreetAddress1":" 935 Stewart Dr",
      "City":"Sunnyvale",
      "PostalCode":"94085",
      "State":"CA",
      "Country":"US"
    }
  ]
}

{
  "Stops":
  [
    {
      "StopReference":"BAF2219",
      "StopScheduledDatePart":"2016-12-23",
      "StopSequence":1,
      "StopType":1,
      "LocationCode":"NNAOZ88"
    },
    {
      "StopReference":"ABZZ83",
      "StopScheduledDatePart":"2016-12-24",
      "StopSequence":2,
      "StopType":3,
      "LocationCode":"IO9938"
    }
  ]
}

Example Success Response:

{
    "TenFourLicensePlate": "NL7JP62"
}

👍
Congratulations!
You've successfully created your first shipment! Please see the additional areas of the shipment services documentation to build out the shipment further based on your companies needs.

POST - Create Shipment

Create Shipment

Adding the FreightProviderReferenceNumber

Adding the Carrier

Adding the Stops

Adding the Stop Location Data

Completed Basic Shipment Object

👍
Congratulations!

Create Shipment

Adding the FreightProviderReferenceNumber

Adding the Carrier

Adding the Stops

Adding the Stop Location Data

Completed Basic Shipment Object

👍Congratulations!

👍
Congratulations!