PRproject44
LTL: Dispatch

Create a shipment.

<h4><b>Required Fields</h4></b> <ul><li><b> capacityProviderAccountGroup: </b></li><ul><li><b> accounts: </b></li><ul><li> code </li></ul></ul><li><b> originLocation: </b></li><ul><li><b> address: </b></li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul><li><b> contact: </b> (if no default origin contact is set for provided capacity provider account)</li><ul><li> companyName </li><li> contactName </li><li> phoneNumber </li></ul></ul><li><b> destinationLocation: </b></li><ul><li><b> address: </b></li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul><li><b> contact: </b> (if no default destination contact is set for provided capacity provider account)</li><ul><li> companyName </li><li> contactName </li><li> phoneNumber </li></ul></ul><li><b> requesterLocation: </b></li><ul><li><b> address: </b></li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul><li><b> contact: </b> (if no default requester contact is set for provided capacity provider account)</li><ul><li> companyName </li><li> contactName </li><li> phoneNumber </li><li> email </li></ul></ul><li><b> lineItems: </b></li><ul><li> totalWeight </li><li><b> packageDimensions: </b></li><ul><li> length </li><li> width </li><li> height </li></ul><li> freightClass </li><li><b> hazmatDetail: </b> (if line item contains hazardous materials)</li><ul><li> identificationNumber </li><li> properShippingName </li><li> hazardClass </li><li> packingGroup </li></ul></ul><li><b> enhancedHandlingUnits <u> NOTE: PLEASE CONTACT YOUR ACCOUNT MANAGER AT PROJECT44 BEFORE USING.</u></b> </b></li><ul><li> weightPerHandlingUnit </li><li> pickupStopNumber </li><li> deliveryStopNumber </li><li><b> handlingUnitDimensions: </b></li><ul><li> length </li><li> width </li><li> height </li></ul><li> freightClasses </li><li><b> packages </b></li><ul><li> <b> packageContents </b></li><ul><li><b> hazmatDetail: </b> (if line item contains hazardous materials)</li></li><ul><li> identificationNumber </li><li> properShippingName </li><li> hazardClass </li><li> packingGroup </li></ul></ul></li></ul></ul><li><b> pickupWindow: </b></li><ul><li> date </li><li> startTime </li><li> endTime </li></ul><li><b> deliveryWindow: </b> (by some capacity providers if requesting guaranteed or expedited services)</li><ul><li> date </li><li> startTime </li><li> endTime </li></ul><li> carrierCode (if capacity provider supports multiple SCACs) </li><li><b> emergencyContact: </b> (if shipment contains hazardous materials)</li><ul><li> companyName </li><li> contactName </li><li> phoneNumber </li></ul><li> capacityProviderQuoteNumber (by a few capacity providers only) </li></ul><h4>Error Responses</h4><p>A failed dispatch returns a <code>400</code> response. In JSON, each entry of the <code>errors</code> list may include an <code>errorCode</code>: the normalized project44 error code, identical across capacity providers. XML error responses do not include <code>errorCode</code>. Clients must tolerate this additional field.</p>
post/api/v4/ltl/dispatchedshipments

Request

Request body

capacityProviderQuoteNumberstring

The quote number for this shipment assigned by the capacity provider. Only a few LTL capacity providers accept a quote number when placing a shipment for pickup. Most volume LTL capacity providers, however, require a quote number.

carrierCodestring

SCAC of the carrier that is to pick up this shipment. Required only for capacity providers that support multiple SCACs.

currencyCode'USD' | 'CAD' | 'MXN' | 'EUR'

Line items monetary value currency, contains optional currency code (ex. 'USD'). This functionality is typically used with cross-border shipments.

deliveryNotestring

Note that applies to the delivery of this shipment. Currently, since nearly all capacity provider APIs have only a pickup note field and not a delivery note field, this delivery note will be inserted into the capacity provider's pickup note API field, according to the shipment note configuration.

directionOverride'SHIPPER' | 'CONSIGNEE' | 'THIRD_PARTY'

An override of direction for the capacity provider account used by this request, if it has 'Enable API override of direction' set as 'true' in the project44 Self-Service Portal.This functionality is typically used in situations where both inbound and outbound shipments are common for a given capacity provider and account number.

lengthUnit'IN' | 'CM' | 'FT' | 'M'

Length measurement unit for all length values in this shipment request. (default: 'IN')

paymentTermsOverride'PREPAID' | 'COLLECT' | 'THIRD_PARTY'

An override of payment terms for the capacity provider account used by this request, if it has 'Enable API override of payment terms' set as 'true' in the project44 Self-Service Portal. This functionality is typically used in situations where both inbound and outbound shipments are common for a given capacity provider and account number.

pickupNotestring

Note that applies to the pickup of this shipment. The shipment note configuration determines the final pickup note that is sent through the capacity provider's API and whether or not part of it may be cut off.

rateQuoteIdstring

The quote ID from project44. This is an optional field.

totalHandlingUnitsinteger

Total numbers of packaged units that are expected to be shipped. This should match the number of units a driver should be loading onto the truck.

totalLinearFeetinteger

The total linear feet that the shipment being quoted will take up in a trailer. Only for volume LTL shipments.

weightUnit'LB' | 'KG'

Weight measurement unit for all weight values in this shipment request. (default: 'LB')

Response

Created

capacityProviderBolUrlstring

URL pointing to a PDF document of the capacity provider's Bill of Lading, if available.

idinteger

The id of the dispatched shipment.

packingVisualizationUrlstring

Customers who have enabled our Volume Visualizer product will find a URL to a PDF document illustrating the optimized item arrangement, for the shipment's total linear footage value. (Example: https://na12.api.project44.com/unauthenticated/linear-feet/pdf/{linearFeetVisualizationId})

pickupDateTimestring date-time

The pickup date and time as provided by the capacity provider in the timezone of origin location of the shipment. (format: yyyy-MM-dd'T'HH:mm:ss)

pickupNotestring

The final note that was sent through the capacity provider's pickup note API field, as constructed by project44 according to the requested shipment note configuration.

Changes

No recorded changes to this operation across all 1 revision of this API.