ShipmentContent

Parameter

Type

Description

FreightProviderReferenceNumber

String

External reference number of the shipment's BOL.

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.

StopReference

String

External reference for orders.

StopScheduledDatePart

TimeSpan

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.

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.

StreetAddress2

String

The secondary street address of the stop.

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

The external fixed location's reference number.

ShipmentStopAppointment

Object

Used when adding an appointment to a stop.

Orders

Object

Used when adding an order(s) on a shipment.

DriverFirstName

String

First name of the driver.

DriverLastName

String

Last name of the driver.

DriverPhoneNumber

Integer

Phone number of the driver in E.164 format. US numbers will default to +1 if not provided. All numbers outside of the US must be in E.164 format.

DriverEmailAddress

String

Email of driver of shipment.

TenantExternalId

Integer

The external ID of the freight provider that will be posting the freight on behalf of a client.

HasTeamDrivers

Boolean

Gets or sets a value indicating whether or not the shipment has team drivers.

MinimumTemperature

Integer

Minimum temperature of the shipment allows.

MaximumTemperature

Integer

Maximum temperature the shipment allows.

Equipment

Enumeration

The type of equipment carrying the shipment.

EquipmentSize

Integer

The length of the container.

ModeType

Enumeration

The type of mode carrying the shipment.

TractorReferenceNumber

String

External reference to carrier tractor. If the associated reference does not already exist, one will be automatically generated.

TrailerReferenceNumber

String

External reference to carrier trailer. If the associated reference does not already exist, one will be automatically generated.

IsDropTrailer

Boolean

If there is a drop trailer associated with the load.

StopDescription

String

The description of the specific stop.

IsCarrierEtaOverride

Boolean

Does the carrier's supplied ETA override the derived Freight Portal ETA?

StopName

String

The name of the specific stop.

StopContactName

String

The contact's name of the specific stop.

StopContactPhoneNumber

String

Phone number of the stop contact in E.164 format. US numbers will default to +1 if not provided. All numbers outside of the US must be in E.164 format.

StopContactEmailAddress

String

The contact's email address of the specific stop.

StopContactFaxNumber

String

The contact's fax number of the specific stop.

StopContactPhoneExtension

String

The contact's phone extension of the specific stop.