LTL Connect API 2021-10-25T16:21:53.000Z

Technical API Reference for the LTL Connect product's rates redirect, Bill of Lading, and reports endpoints. To obtain an API key, visit uShip API Key Generation.

Server

https://www.uship.com

https://www.ushipsandbox.com

Authentication

http bearerAuth

Self-serve Bearer token provided to you at https://www.uship.com/api-key-generation

Retrieve Bill of Lading

Allows integrator to retrieve Bill of Lading for shipments by listing ID (visible in /reports response)

Auth

Path Params

string

uship id for the listing

POST /integrator/bols/{id}

xxxxxxxxxx
 
curl --request POST \ --url 'https://www.uship.com/integrator/bols/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

302

Found

Headers
location	string	Location of secure BOL GET

401

Unauthorized

403

Forbidden

404

Not Found

Response

xxxxxxxxxx
 
No example response
Copy

Create redirect link for uShip LTL Rates

Allows integrator to generate a prefilled listing creation page or send user directly to uShip rates

Auth

Headers

cache-control	string	Set this value to no-cache
x-uship-affiliate-id	string	Your uShip Affiliate ID provided by uShip. Ensures all P44 customizations are preserved.

Request Body

PostRedirectRequest	object
commodity	string	Valid commodities are NewCommercialGoods and UsedCommercialGoods Enum: `NewCommercialGoods`,`UsedCommercialGoods`
title	string	The title for your listing
referrer	string
earliestPickupDate	string	Earliest pickup date in the ISO 8601 format. NOTE - the timezone is assumed to be in the pickup location's timezone. Offsets will be disregarded. For example, 2022-07-01T11:00-0700 will be interpreted as 2022-07-01T11:00
latestPickupDate	string	Latest pickup date in the ISO 8601 format. NOTE - the timezone is assumed to be in the pickup location's timezone. Offsets will be disregarded. For example, 2022-07-01T11:00-0700 will be interpreted as 2022-07-01T11:00
destinationLocationType	string	Valid locations are Residence, BusinessWithLoadingDockOrForklift, BusinessWithoutLoadingDockOrForklift, ConstructionSite, TradeShowOrConvention, Port, StorageFacility, MilitaryBase, Airport, OtherSecuredLocation, School, GovernmentLocation, FarmRanchEstate, ReligiousInstitution, GolfCourseResortPark, DistributionCenter, or Auction Enum: `Residence`,`BusinessWithLoadingDockOrForklift`,`BusinessWithoutLoadingDockOrForklift`,`ConstructionSite`,`TradeShowOrConvention`,`Port`,`StorageFacility`,`MilitaryBase`,`Airport`,`OtherSecuredLocation`,`School`,`GovernmentLocation`,`FarmRanchEstate`,`ReligiousInstitution`,`GolfCourseResortPark`,`DistributionCenter`,`Auction`
destinationAddress	string	The address for the delivery location maxLength: 255
destinationAddress2	string	Additional address detail field for the delivery address maxLength: 255
destinationState	string	The state of the delivery location maxLength: 255
destinationCity	string	The city for the delivery location maxLength: 255
destinationPostalCode	string	The zip code for the delivery location maxLength: 20
destinationContact	object
firstName	string	First name of the destination contact maxLength: 30
lastName	string	Last name of the destination contact maxLength: 50
phoneNumber	string	Contact number for destination maxLength: 30
companyName	string	Company name for destination location maxLength: 100
email	string	Email contract address for destination maxLength: 255
originLocationType	string	Valid locations are Residence, BusinessWithLoadingDockOrForklift, BusinessWithoutLoadingDockOrForklift, ConstructionSite, TradeShowOrConvention, Port, StorageFacility, MilitaryBase, Airport, OtherSecuredLocation, School, GovernmentLocation, FarmRanchEstate, ReligiousInstitution, GolfCourseResortPark, DistributionCenter, or Auction Enum: `Residence`,`BusinessWithLoadingDockOrForklift`,`BusinessWithoutLoadingDockOrForklift`,`ConstructionSite`,`TradeShowOrConvention`,`Port`,`StorageFacility`,`MilitaryBase`,`Airport`,`OtherSecuredLocation`,`School`,`GovernmentLocation`,`FarmRanchEstate`,`ReligiousInstitution`,`GolfCourseResortPark`,`DistributionCenter`,`Auction`
originAddress	string	The address for the shipping location maxLength: 255
originAddress2	string	Additional address detail field for the shipping address maxLength: 255
originCity	string	The city for the shipping location maxLength: 255
originContact	object
firstName	string	First name of the destination contact maxLength: 30
lastName	string	Last name of the destination contact maxLength: 50
phoneNumber	string	Contact number for destination maxLength: 30
companyName	string	Company name for destination location maxLength: 100
email	string	Email contract address for destination maxLength: 255
originPostalCode	string	The zip code for the shipping location maxLength: 20
originState	string	The state for the shipping location maxLength: 255
pickupInstructions	string	Optional information for the driver or carrier regarding pickup, e.g., hours of operation, details on parking, etc. maxLength: 1000
deliveryInstructions	string	Optional information for the driver or carrier regarding delivery, e.g., hours of operation, details on parking, etc. maxLength: 1000
quoteRequestAccessorials	array[string]	Selected checkboxes for pickup, delivery and additional options. Valid options are: PickupLiftgateRequired, PickupInside, DeliveryLiftgateRequired, DeliveryInside, DeliveryAppointmentRequired, DeliveryCallAhead, ProtectFromFreezing, SortAndSegregate, BlindShipmentCoordination Enum: `PickupLiftgateRequired`,`PickupInside`,`DeliveryLiftgateRequired`,`DeliveryInside`,`DeliveryAppointmentRequired`,`DeliveryCallAhead`,`ProtectFromFreezing`,`SortAndSegregate`,`BlindShipmentCoordination`
page	string	Opt to redirect requests to the freight information page or directly to the rates page if all required fields are supplied Enum: `freightInfo`,`rates`
referenceNumbers	array[object]
number	string	maxLength: 100
type	string	Valid types are Pickup, Delivery, Invoice, PurchaseOrder, SalesOrder, Lot, Release, ThirdPartyTracking, PriceCorrelationId, ThirdPartyOrderNumber, VIN, SKU, Other Enum: `Pickup`,`Delivery`,`Invoice`,`PurchaseOrder`,`SalesOrder`,`Lot`,`Release`,`ThirdPartyTracking`,`PriceCorrelationId`,`ThirdPartyOrderNumber`,`VIN`,`SKU`,`Other`
items	array[object]
quantity	number	Number of handling units (Boxes, Crates, Pallets, etc.). minimum: 0
width	number	Item width in inches minimum: 0
length	number	Item length in inches minimum: 0
weight	number	Item weight in pounds minimum: 0
handlingUnit	string	Valid types are None, Pallets48x40Inches, Boxes, Crates, Drums, Other, Cartons, Bags, Bales, Bundles, Cans, Cases, Coils, Cylinders, Loose, Pails, Reels, Rolls, TubesPipes Enum: `None`,`Pallets48x40Inches`,`Boxes`,`Crates`,`Drums`,`Other`,`Cartons`,`Bags`,`Bales`,`Bundles`,`Cans`,`Cases`,`Coils`,`Cylinders`,`Loose`,`Pails`,`Reels`,`Rolls`,`TubesPipes`
title	string	The title for the item
height	number	Item height in inches minimum: 0
description	string	Item description
listingContents	array[object]
quantity	number	minimum: 0
description	string	maxLength: 100
handlingUnit	string	Valid types are None, Pallets48x40Inches, Boxes, Crates, Drums, Other, Cartons, Bags, Bales, Bundles, Cans, Cases, Coils, Cylinders, Loose, Pails, Reels, Rolls, TubesPipes Enum: `None`,`Pallets48x40Inches`,`Boxes`,`Crates`,`Drums`,`Other`,`Cartons`,`Bags`,`Bales`,`Bundles`,`Cans`,`Cases`,`Coils`,`Cylinders`,`Loose`,`Pails`,`Reels`,`Rolls`,`TubesPipes`

Expand

POST /integrator/incomplete/listings/redirect

xxxxxxxxxx
 
curl --request POST \ --url 'https://www.uship.com/integrator/incomplete/listings/redirect' \ --header 'cache-control: {cache-control}' \ --header 'x-uship-affiliate-id: {x-uship-affiliate-id}' \ --header 'Authorization: Bearer {token}' \ --data '{  "commodity": "{string}",  "title": "{string}",  "referrer": "{string}",  "earliestPickupDate": "{string}",  "latestPickupDate": "{string}",  "destinationLocationType": "{string}",  "destinationAddress": "{string}",  "destinationAddress2": "{string}",  "destinationState": "{string}",  "destinationCity": "{string}",  "destinationPostalCode": "{string}",  "destinationContact": {    "firstName": "{string}",    "lastName": "{string}",    "phoneNumber": "{string}",    "companyName": "{string}",    "email": "{string}"  },  "originLocationType": "{string}",  "originAddress": "{string}",  "originAddress2": "{string}",  "originCity": "{string}",  "originContact": {    "firstName": "{string}",    "lastName": "{string}",    "phoneNumber": "{string}",    "companyName": "{string}",    "email": "{string}"  },  "originPostalCode": "{string}",  "originState": "{string}",  "pickupInstructions": "{string}",  "deliveryInstructions": "{string}",  "quoteRequestAccessorials": [    "{array[string]...}"  ],  "page": "{string}",  "referenceNumbers": [    {      "number": "{string}",      "type": "{string}"    }  ],  "items": [    {      "quantity": "{number}",      "width": "{number}",      "length": "{number}",      "weight": "{number}",      "handlingUnit": "{string}",      "title": "{string}",      "height": "{number}",      "description": "{string}",      "listingContents": [        {          "quantity": "{number}",          "description": "{string}",          "handlingUnit": "{string}"        }      ]    }  ]}'
Copy

Expand

Responses

201

201 response

Headers
location	string	URL to uShip-hosted prefilled listing page

400

400 response

Response

xxxxxxxxxx
 
No example response
Copy

View data for all booked/cancelled listings for a given date range

Allows integrator to retrieve data on shipments booked, including bolID

Auth

Headers

x-uship-affiliate-id

string

Your uShip Affiliate ID provided by uShip. Ensures all P44 customizations are preserved.

Query String

startDateTime	string	Report start date in IS0-8601 format
endDateTime	string	Report end date in IS0-8601 format

GET /integrator/report

xxxxxxxxxx
 
curl --get \ --url 'https://www.uship.com/integrator/report' \ --header 'x-uship-affiliate-id: {x-uship-affiliate-id}' \ --header 'Authorization: Bearer {token}' \ --data startDateTime={startDateTime} \ --data endDateTime={endDateTime}
Copy

Responses

200

200 response

GetReportResponse	object
count	integer	minimum: 0
items	array[object]	Collection of Listing Report objects
bolNumber	integer
carrier	object
displayName	string
deliveryAddress	object
streetAddress	string
deliveryContact	object
phone	string
name	string
email	string
estimatedDeliveryDate	string
finalCost	number
id	integer
items	array[object]	A collection of items for a listing
count	integer	minimum: 0
title	string
links	array[object]	A collection of relevant links for a listing
rel	string	Enum: `Self`,`Item`,`List`,`Create`,`Update`,`Delete`,`Next`
verb	string	Enum: `GET`,`POST`,`PUT`,`DELETE`,`HEAD`,`PATCH`
href	string
title	string	Enum: `BillOfLading`,`Tracking`,`PdfBOL`,`PdfWC`,`PdfPOD`,`PdfIC`,`PdfLOA`
listingStatus	object
status	string	Enum: `Booked`,`Deleted`,`Closed`,`Active`,`Archived`,`Saved`,`Completed`,`OnHold`
orginalCost	number
pickupId	string
proNumber	string
referenceNumbers	array[object]	A collection of reference numbers for a listing
number	string
type	string	Enum: `Pickup`,`Delivery`,`Invoice`,`PurchaseOrder`,`SalesOrder`,`Lot`,`Release`,`ThirdPartyTracking`,`PriceCorrelationId`,`ThirdPartyOrderNumber`,`VIN`,`SKU`,`Other`
title	string
transitStatus	object
status	string	Enum: `ReadyForDispatch`,`Dispatched`,`PickedUp`,`Delivered`

Expand

400

Bad Request

401

Unauthorized

403

Forbidden

Response

xxxxxxxxxx
 
{ "count": "{integer}", "items": [  {   "bolNumber": "{integer}",   "carrier": {    "displayName": "{string}"   },   "deliveryAddress": {    "streetAddress": "{string}"   },   "deliveryContact": {    "phone": "{string}",    "name": "{string}",    "email": "{string}"   },   "estimatedDeliveryDate": "{string}",   "finalCost": "{number}",   "id": "{integer}",   "items": [    {     "count": "{integer}",     "title": "{string}"    }   ],   "links": [    {     "rel": "{string}",     "verb": "{string}",     "href": "{string}",     "title": "{string}"    }   ],   "listingStatus": {    "status": "{string}"   },   "orginalCost": "{number}",   "pickupId": "{string}",   "proNumber": "{string}",   "referenceNumbers": [    {     "number": "{string}",     "type": "{string}"    }   ],   "title": "{string}",   "transitStatus": {    "status": "{string}"   }  } ]}
Copy

Expand