LTL Connect Implementation Guide: Redirect and Settings

LTL Connect provides a way for integrators to add LTL rate access for their customers and populate in-app dashboards with BOL, tracking, and cost information. The primary value for your end shippers will be transmitting load and shipment information having to re-enter data on uShip.com and keeping their LTL shipments through your TMS visible at a glance.

The following guide outlines the key requirements in order to have an ideal, expedited LTL booking. If some load details cannot be provided, the integration is still possible; however, as users may need to manually enter data into uShip forms and delay their rate retrieval, following this flow is highly recommended.

Partner Configuration and Display Details

uShip offers landing page customization and flexible field requirements. Prior to integrating, please provide the following information to uShip:

	Description	Sample Value
Marketing Information	This information is used for branding support on our landing page.
Link	The link to your site or partner-side landing page	www.ExampleTMS.com
Paragraph	Paragraph text to contextualize the integration for your shippers	"ExampleTMS has partnered with uShip.com for LTL rates. Once booked, you can track and view BOL data in your ETMS dashboard."
Logo	Path to your desired logo in .jpg, .svg, or .png format	"https://www.exampletms.com/data/imgs/etms.png"
Pickup or Delivery Field Visibility	If you want shippers to manually enter data, you can select certain fields as editable or read-only. Please see the below section for more information.

Redirect and Data Entry

Partners will integrate the /redirect endpoint to transmit shipment data into uShip.com. Depending on the fields supplied, users will see one of three flows. These are listed below in descending order of ideal implementation

Flow A: Pass-thru

All required fields are included; users will land directly on uShip.com rates page where they will join, sign-in (active sessions valid for a week) or immediately view bookable rates if an active session exists.

All necessary fields for rates supplied, no active session.

Required fields for going directly to rates are:

Title

Commodity

Handling unit

Length

Width

Height

Weight

Quantity

Earliest Pickup Date

Latest Pickup Date

Pickup Zip Code

Pickup location type

Delivery Zip Code

Delivery location type

Reference Number

Flow B: Some sections supplied

All required fields for either the Pickup or Delivery sections are supplied but not both. As mentioned in the table above, partners can hide or show completed sections or adjust the editability of a given field so it cannot be changed from what was passed over via the API.

All Pickup fields supplied and Pickup section hidden; Delivery section not supplied and left as editable.

Flow C: No fields passed through

If no fields are passed through or not enough fields to complete a section, the full shipper flow page will appear. We do not suggest this flow as it removes a key value add in accelerating the listing creation.

No fields passed through, user manually enters all data.

Only fields that have data passed over can be hidden.

Required /redirect Fields For Rates

In order to display the ideal straight-to-rates flow, integrators must supply the information listed below. For a complete list of fields and examples, please see the technical reference here.

Origin Information	Destination Information	Item Information
Origin Contact First Name	Destination Contact First Name	Handling Unit
Origin Contact Last Name	Destination Contact Last Name	Height
Origin Contact Email Address	Destination Contact Email Address	Length
Origin Company Name	Destination Contact Company Name	Width
Pickup Location Phone Number	Destination Contact Phone Number	Weight
Origin Street Address	Destination Street Address	Measurement Unit
Origin City	Destination City	Reference Number
Origin State	Destination State
Origin Postal Code	Destination Postal Code
Origin Location Type	Destination Location Type
Origin Earliest Arrival/Pickup Date (must be the same as latest date, only between 8 am to 11 am; no later than 21 days from the current date)
Origin Latest Arrival/Pickup Date (must be the same as the earliest date, only between 2 pm to 5 pm; no later than 21 days from the current date).

Sample Call

Javascript
    
 
{    "items": [        {            "handlingUnit": "Pallets48x40Inches",            "quantity": 1,            "height": 40,            "width": 40,            "length": 48,            "weight": 250,            "title": "Ammo Cans",            "description": "Ammo Cans",            "listingContents": [                {                    "quantity": 1,                    "description": "ammo cans",                    "handlingUnit": "Boxes"                }            ]        },        {            "handlingUnit": "Pallets48x40Inches",            "quantity": 1,            "height": 72,            "width": 40,            "length": 48,            "weight": 500,            "title": "Ammo Cans",            "description": "Ammo Cans",            "listingContents": [                {                    "quantity": 90,                    "description": "ammo cans",                    "handlingUnit": "Boxes"                }            ]        }    ],    "originAddress": "123 Unnamed Road",    "originAddress2": "",    "originPostalCode": "89030",    "originCity": "North Las Vegas",    "originState": "NV",    "originLocationType": "BusinessWithLoadingDockOrForklift",    "originContact": {        "companyName": "eezyimport",        "firstName": "John",        "lastName": "Smith",        "email": "jsmith@eezyimport.com",        "phoneNumber": "8885551234"    },    "destinationAddress": "1500 Marilla St.",    "destinationAddress2": "",    "destinationPostalCode": "75201",    "destinationCity": "Dallas",    "destinationState": "TX",    "destinationLocationType": "BusinessWithLoadingDockOrForklift",    "destinationContact": {        "companyName": "JoeShip",        "firstName": "Joe",        "lastName": "Ballato",        "email": "joe@uship.com",        "phoneNumber": "5123516043"    },    "earliestPickupDate": "2023-07-03T11:00:00",    "latestPickupDate": "2023-07-03T16:00:00",    "pickupInstructions": "",    "deliveryInstructions": "Follow the green arrows",    "referenceNumbers": [        {            "number": "123456",            "type": "SalesOrder"        },        {            "number": "Customer Number - 224466",            "type": "Other"        }    ],    "quoteRequestAccessorials": [        "PickupLiftgateRequired",        "PickupInside",        "DeliveryLiftgateRequired",        "DeliveryInside",        "DeliveryAppointmentRequired",        "DeliveryCallAhead",        "ProtectFromFreezing",        "SortAndSegregate",        "BlindShipmentCoordination"        ]}
Copy

Reference Numbers

For many LTL Connect integrations, partners will have multiple shippers with multiple loads and each will have their own respective uShip account. When retrieving the delivery, tracking, and other data for display, you will need to ensure that the right data is displayed to your shipper and for the correct shipment.

uShip enables this mapping via the Reference Number field. Users can include multiple different types of Reference Number but load mapping requires the Third Party Tracking ID type to be included. When retrieving data via /reports, you can use this ID to parse and delivery the tracking data to the correct account. The number included as the Third Party Tracking ID must be unique to the load. Please see the example below for more detail; Third Party Tracking ID is listed as type "9" alongside the ID used for Pay-on-Terms (11), and a generic sales order number (5).

Load ID Reference Number
    
 
"referenceNumbers": [        {            "number": "123456",            "type": "5"        },        {            "number": "I2435",            "type": "11"        },        {            "number": "724956295",            "type": "9"        }    ]
Copy

Last updated on