Download OpenAPI specification:
API reference for LTL Connect, enabling integrators to redirect users to uShip rates, retrieve Bill of Lading documents, and access shipment reports.
| Environment | URL | Description |
|---|---|---|
| Sandbox | https://www.ushipsandbox.com |
Test environment for development |
| Production | https://www.uship.com |
Live production environment |
Note: LTL Connect uses web-based URLs (
wwwsubdomain) unlike other uShip APIs.
All API requests require Bearer token authentication.
Authorization: Bearer <your_api_key>
| Guide | Description |
|---|---|
| Sandbox Testing Guide | Comprehensive sandbox testing documentation |
| uShip DeveloperHub | Integration guides and tutorials |
For questions or assistance, contact: apisupport@uship.com
Generate redirect links to uShip's rate comparison page with pre-filled shipment details.
Allows integrator to generate a prefilled listing creation page or send user directly to uShip rates
| cache-control required | string Example: no-cache Required. Set this value to no-cache |
| x-uship-affiliate-id required | string Example: your-affiliate-id Required. Your uShip Affiliate ID provided by uShip. Ensures all P44 customizations are preserved. |
| commodity | string Enum: "NewCommercialGoods" "UsedCommercialGoods" Valid commodities are NewCommercialGoods and 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 (PostRedirectRequestModelDestinationLocationType) Enum: "Residence" "BusinessWithLoadingDockOrForklift" "BusinessWithoutLoadingDockOrForklift" "ConstructionSite" "TradeShowOrConvention" "Port" "StorageFacility" "MilitaryBase" "Airport" "OtherSecuredLocation" "School" "GovernmentLocation" "FarmRanchEstate" "ReligiousInstitution" "GolfCourseResortPark" "DistributionCenter" "Auction" Valid locations are Residence, BusinessWithLoadingDockOrForklift, BusinessWithoutLoadingDockOrForklift, ConstructionSite, TradeShowOrConvention, Port, StorageFacility, MilitaryBase, Airport, OtherSecuredLocation, School, GovernmentLocation, FarmRanchEstate, ReligiousInstitution, GolfCourseResortPark, DistributionCenter, or Auction |
| destinationAddress | string <= 255 characters The address for the delivery location |
| destinationAddress2 | string <= 255 characters Additional address detail field for the delivery address |
| destinationState | string <= 255 characters The state of the delivery location |
| destinationCity | string <= 255 characters The city for the delivery location |
| destinationPostalCode | string <= 20 characters The zip code for the delivery location |
object (PostRedirectRequestModelDestinationContact) | |
| originLocationType | string (PostRedirectRequestModelDestinationLocationType) Enum: "Residence" "BusinessWithLoadingDockOrForklift" "BusinessWithoutLoadingDockOrForklift" "ConstructionSite" "TradeShowOrConvention" "Port" "StorageFacility" "MilitaryBase" "Airport" "OtherSecuredLocation" "School" "GovernmentLocation" "FarmRanchEstate" "ReligiousInstitution" "GolfCourseResortPark" "DistributionCenter" "Auction" Valid locations are Residence, BusinessWithLoadingDockOrForklift, BusinessWithoutLoadingDockOrForklift, ConstructionSite, TradeShowOrConvention, Port, StorageFacility, MilitaryBase, Airport, OtherSecuredLocation, School, GovernmentLocation, FarmRanchEstate, ReligiousInstitution, GolfCourseResortPark, DistributionCenter, or Auction |
| originAddress | string <= 255 characters The address for the shipping location |
| originAddress2 | string <= 255 characters Additional address detail field for the shipping address |
| originCity | string <= 255 characters The city for the shipping location |
object (PostRedirectRequestModelDestinationContact) | |
| originPostalCode | string <= 20 characters The zip code for the shipping location |
| originState | string <= 255 characters The state for the shipping location |
| pickupInstructions | string <= 1000 characters Optional information for the driver or carrier regarding pickup, e.g., hours of operation, details on parking, etc. |
| deliveryInstructions | string <= 1000 characters Optional information for the driver or carrier regarding delivery, e.g., hours of operation, details on parking, etc. |
| quoteRequestAccessorials | Array of strings Items Enum: "PickupLiftgateRequired" "PickupInside" "DeliveryLiftgateRequired" "DeliveryInside" "DeliveryAppointmentRequired" "DeliveryCallAhead" "ProtectFromFreezing" "SortAndSegregate" "BlindShipmentCoordination" Selected checkboxes for pickup, delivery and additional options. Valid options are: PickupLiftgateRequired, PickupInside, DeliveryLiftgateRequired, DeliveryInside, DeliveryAppointmentRequired, DeliveryCallAhead, ProtectFromFreezing, SortAndSegregate, BlindShipmentCoordination |
| page | string Enum: "freightInfo" "rates" Opt to redirect requests to the freight information page or directly to the rates page if all required fields are supplied |
Array of objects | |
Array of objects (PostRedirectRequestModelItemsItem) |
{- "commodity": "NewCommercialGoods",
- "title": "LTL Freight Shipment - Austin to Los Angeles",
- "earliestPickupDate": "2025-01-15",
- "latestPickupDate": "2025-01-20",
- "destinationLocationType": "Residence",
- "destinationAddress": "123 Main Street",
- "destinationAddress2": "123 Main Street",
- "destinationState": "TX",
- "destinationCity": "Austin",
- "destinationPostalCode": "90210",
- "destinationContact": {
- "firstName": "John",
- "lastName": "Doe",
- "phoneNumber": "512-555-0123",
- "companyName": "Acme Logistics",
- "email": "contact@example.com"
}, - "originLocationType": "Residence",
- "originAddress": "123 Main Street",
- "originAddress2": "123 Main Street",
- "originCity": "Austin",
- "originContact": {
- "firstName": "John",
- "lastName": "Doe",
- "phoneNumber": "512-555-0123",
- "companyName": "Acme Logistics",
- "email": "contact@example.com"
}, - "originPostalCode": "78701",
- "originState": "TX",
- "pickupInstructions": "Call ahead 30 minutes before arrival",
- "deliveryInstructions": "Deliver to loading dock at rear of building",
- "quoteRequestAccessorials": [
- "PickupLiftgateRequired"
], - "page": "freightInfo",
- "referenceNumbers": [
- {
- "number": "PO-12345",
- "type": "LTLFreight"
}
], - "items": [
- {
- "quantity": 2,
- "width": 40,
- "length": 48,
- "weight": 500,
- "handlingUnit": "None",
- "title": "LTL Freight Shipment - Austin to Los Angeles",
- "height": 48,
- "description": "Palletized freight shipment containing office furniture",
- "listingContents": [
- {
- "quantity": 2,
- "description": "Palletized freight shipment containing office furniture",
- "handlingUnit": "None"
}
]
}
]
}{ }Allows integrator to retrieve data on shipments booked, including bolID
| startDateTime required | string Example: startDateTime=2025-01-01T00:00:00Z Required. Report start date in IS0-8601 format |
| endDateTime required | string Example: endDateTime=2025-01-31T23:59:59Z Required. Report end date in IS0-8601 format |
| x-uship-affiliate-id required | string Example: your-affiliate-id Required. Your uShip Affiliate ID provided by uShip. Ensures all P44 customizations are preserved. |
{- "count": 1,
- "items": [
- {
- "bolNumber": 1,
- "carrier": {
- "displayName": "John Doe"
}, - "deliveryAddress": {
- "streetAddress": "123 Main Street"
}, - "deliveryContact": {
- "phone": "512-555-0123",
- "name": "John Doe",
- "email": "contact@example.com"
}, - "estimatedDeliveryDate": "2025-01-25",
- "finalCost": 2796.48,
- "id": "675712978",
- "items": [
- {
- "count": 1,
- "title": "LTL Freight Shipment - Austin to Los Angeles"
}
], - "links": [
- {
- "rel": "Self",
- "verb": "GET",
- "title": "LTL Freight Shipment - Austin to Los Angeles"
}
], - "listingStatus": {
- "status": "Active"
}, - "orginalCost": 2796.48,
- "pickupId": "675712978",
- "proNumber": "123456789",
- "referenceNumbers": [
- {
- "number": "PO-12345",
- "type": "LTLFreight"
}
], - "title": "LTL Freight Shipment - Austin to Los Angeles",
- "transitStatus": {
- "status": "Active"
}
}
]
}