API docs by Redocly

LTL Direct API (v2)

Download OpenAPI specification:

Complete API reference for LTL Direct freight shipping, including rate requests, listing management, Bill of Lading, and tracking.

Getting Started

Base URLs

Environment URL Description
Sandbox https://api.ushipsandbox.com Test environment for development
Production https://api.uship.com Live production environment

Note: Sandbox and production environments require separate API keys.

Authentication

All API requests require Bearer token authentication.

Obtaining Your API Key

  1. Navigate to API Key Generation Page
  2. Generate your API key (specify sandbox or production)
  3. Include in all requests:
Authorization: Bearer <your_api_key>

Integration Guides

Guide Description
Sandbox Testing Guide Comprehensive sandbox testing documentation
uShip DeveloperHub Integration guides and tutorials

Support

For questions or assistance, contact: apisupport@uship.com

Rate Requests

Create and manage rate requests. A rate request initiates the process of getting shipping quotes from carriers.

Get list of available rates for a rate request

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 64b9546806a13f0638323de9

Required. The rate request ID

query Parameters
development
string
header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

Required. Required Authorization header containing access token

Responses

Response samples

Content type
application/json
{
  • "totalCount": 100,
  • "items": [
    ]
}

Create a rate request

Authorizations:
bearerAuth
query Parameters
development
string
header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

Required. Required Authorization header containing access token

Request Body schema: application/json
required
required
object

Required. route

Array of objects

Identifiers and numbers by which one can refer to this shipment or its cargo in some external system

required
Array of objects

Required. LTL Items

integratorId
string

The integrator id for the request. This is required to receive webhooks and custom rates

accessorials
Array of strings
Items Enum: "ProtectFromFreezing" "BlindShipmentCoordination" "SortAndSegregate" "ExcessiveLength"

Collection of service accessorials for this shipment

Responses

Request samples

Content type
application/json
{
  • "route": {
    },
  • "referenceNumbers": [
    ],
  • "items": [
    ],
  • "integratorId": "675712978",
  • "accessorials": [
    ]
}

Response samples

Content type
application/json
{
  • "reason": "Validation failed",
  • "errors": [
    ]
}

Rates

Retrieve and select shipping rates. Rates represent pricing quotes from carriers for your shipment.

Accept a rate

Allows a shipper or an integrator on a shipper's behalf to accept a rate

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: rate-abc123def456

Required. The rate ID to accept

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

Required. Required Authorization header containing access token

Request Body schema: application/json
required
required
object

Required. Insurance

paymentMethodId
required
string

Required. Payment method ID

Responses

Request samples

Content type
application/json
{
  • "insurance": {
    },
  • "paymentMethodId": "pm-cc-1234567890"
}

Response samples

Content type
application/json
{
  • "message": "Request processed successfully"
}

Retrieves the status of a rate acceptance request

Authorizations:
bearerAuth
path Parameters
executionId
required
string
Example: exec-789xyz123

Required. The execution ID returned from the rate acceptance request

id
required
string
Example: rate-abc123def456

Required. The rate ID

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

Required. Required Authorization header containing access token

Responses

Response samples

Content type
application/json
{
  • "response": "Request accepted and processing",
  • "statusCode": 100
}

Listings

Manage freight listings. Listings represent shipments in the uShip marketplace.

Retrieves a listing from the uShip Marketplace by listingId

Allows integrator to retrieve listing information by listing ID

Authorizations:
bearerAuth
path Parameters
listingId
required
integer <int32>
Example: 12345

Required. listingId of the listing that is to be returned

Responses

Response samples

Content type
application/json
{
  • "status": "Active",
  • "paymentStatus": {
    },
  • "transitStatus": {
    },
  • "cancellationStatus": {
    },
  • "hasPendingBookingRequest": false,
  • "gallery": [
    ],
  • "isCharitable": false,
  • "isAuction": false,
  • "isDutchAuction": false,
  • "autoAcceptPrice": {
    },
  • "auctionTargetPrice": {
    },
  • "auctionMaxPrice": {
    },
  • "namedPrice": {
    },
  • "offerPrice": {
    },
  • "lowestBidPrice": {
    },
  • "acceptedBidPrice": {
    },
  • "totalCost": {
    },
  • "bookingDeposit": {
    },
  • "amountDueToServiceProvider": {
    },
  • "amountToMe": {
    },
  • "priceDetails": {
    },
  • "commodity": "LTLFreight",
  • "parentCommodity": "Freight",
  • "topLevelCommodity": "LTLFreight",
  • "expiresOn": "2025-01-15T12:00:00Z",
  • "questionsAsked": 1,
  • "activeBidsPlaced": 675712978,
  • "totalBidsPlaced": 675712978,
  • "imageUrl": "https://api.uship.com/example",
  • "isDefaultImage": false,
  • "checksum": "a1b2c3d4e5f6",
  • "isWatched": false,
  • "createdOn": "2025-01-01T10:30:00Z",
  • "activatedOn": "2025-01-15T12:00:00Z",
  • "lastUpdatedOn": "2025-01-05T14:22:00Z",
  • "isBrokered": false,
  • "bookedOn": "2025-01-02T11:00:00Z",
  • "completedOn": "2025-01-10T16:45:00Z",
  • "cancelledOn": "2025-01-15T12:00:00Z",
  • "archivedOn": "2025-01-15T12:00:00Z",
  • "serviceProvider": {
    },
  • "assignedDriver": {
    },
  • "isReadyForPickup": false,
  • "billOfLadingNumber": 1,
  • "uShipPayments": {
    },
  • "minimumBidAmount": {
    },
  • "privateNetwork": "partner-network-001",
  • "cancellationLink": "https://api.uship.com/example",
  • "quoteRequestId": "675712978",
  • "commodityType": {
    },
  • "parentCommodityType": {
    },
  • "topLevelCommodityType": {
    },
  • "isItineraryMandatory": false,
  • "thirdParty": {
    },
  • "serviceTypes": [
    ],
  • "isExclusiveListing": false,
  • "listingId": 12345,
  • "title": "Furniture Shipment",
  • "description": "Palletized freight shipment containing office furniture",
  • "route": {
    },
  • "lister": {
    },
  • "items": [
    ],
  • "accessorials": [
    ],
  • "totalWeightInGrams": {
    },
  • "attributes": {
    },
  • "nextTransitStatus": {
    },
  • "previousTransitStatus": {
    },
  • "availableTransitStatuses": [
    ],
  • "referenceNumbers": [
    ],
  • "importSource": "https://tms.example.com/orders/12345",
  • "links": []
}

ListingsAttachments

Manage attachments associated with listings, such as photos or documents.

Retrieves listing attachment information

Allows integrator to retrieve listing attachments by listing ID

Authorizations:
bearerAuth
path Parameters
listingId
required
integer <int32>
Example: 12345

Required. listingId

attachmentId
required
integer <int32>
Example: 1

Required. attachmentId

Responses

Response samples

Content type
application/json
{
  • "attachmentId": "675712978",
  • "uri": "https://api.uship.com/example",
  • "fileName": "John Doe",
  • "fileType": "application/pdf",
  • "fileSize": 1,
  • "dateCreated": "2025-01-15T12:00:00Z",
  • "uploaderId": 675712978,
  • "attachmentType": {
    },
  • "notes": "Handle with care - fragile items",
  • "links": []
}

Payment Methods

Manage payment methods for booking shipments.

Get All User's Payment Methods

Authorizations:
bearerAuth
query Parameters
topLevelCommodity
required
string
Example: topLevelCommodity=LTLFreight

Required. Required top level commodity

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

Required. Required Authorization header containing access token

Responses

Response samples

Content type
application/json
{
  • "totalCount": 100,
  • "items": [
    ]
}

Tracking

Track shipment status and location updates.

Retrieve tracking info

This endpoint allows you to retrieve latitude/longitude values, transit status, and the most recent location or address. If a recent location is not provided, these will be absent from the response.

Authorizations:
bearerAuth
path Parameters
listingId
required
integer <int32>
Example: 12345

Required. listingId

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

Required. Bearer {your password grant bearer token}

Responses

Response samples

Content type
application/json
{
  • "listingGeneratedId": 675712978,
  • "listingTitle": "LTL Freight Shipment - Austin to Los Angeles",
  • "commodityCode": "LTLFreight",
  • "shipmentTrackingSummaryModel": {
    },
  • "carrierContactModel": {
    },
  • "shipmentTrackingStatuses": [
    ],
  • "mostRecentLocation": [
    ],
  • "mostRecentAddress": [
    ]
}

Bill of Lading

Retrieve Bill of Lading documents. The BOL is the official shipping contract between shipper and carrier.

Get the preSigned url for bill of lading

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 675712978

Required. The listing ID

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

Required. Required Authorization header containing access token

Responses

Response samples

Content type
application/json
{}