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://api.uship.com
https://api.ushipsandbox.com
Server Variables

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

Retrieves a listing from the uShip Marketplace by listingId

Allows integrator to retrieve listing information by listing ID

Auth
Path Params
listingIdinteger

listingId of the listing that is to be returned

GET /v2/listings/{listingId}
Copy
Responses
200

OK

Retrieves listing attachment information

Allows integrator to retrieve listing attachments by listing ID

Auth
Path Params
listingIdinteger
attachmentIdinteger
GET /v2/listings/{listingId}/attachments/{attachmentId}
Copy
Responses
200

OK

Response
Copy

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.

Auth
Headers
Authorizationstring

Bearer {your password grant bearer token}

Path Params
listingIdinteger
GET /v2/listings/{listingId}/track
Copy
Responses
200

OK

Response
Copy

Get list of available rates for a rate request

Auth
Headers
Authorizationstring

Required Authorization header containing access token

Path Params
idstring
Query String
developmentstring
GET /v2/raterequests/{id}/rates
Copy
Responses
200

200 response

401

Unauthorized

403

Forbidden

500

Internal server error

Response
Copy

Create a rate request

Auth
Headers
Authorizationstring

Required Authorization header containing access token

Query String
developmentstring
Request Body
POST /v2/raterequests
Responses
201

201 response

Headers
Locationstring

URL containing the rate request ID

400

Bad Request

401

Unauthorized

500

Internal server error

Response
Copy

Accept a rate

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

Auth
Headers
Authorizationstring

Required Authorization header containing access token

Path Params
idstring
Request Body
v2RatesAcceptancePostRequestobject
insuranceobject

Insurance

coverageobject
currencyTypestring

Currency type (ex. USD)

amountnumber

Coverage amount

paymentMethodIdstring

Payment method ID

POST /v2/rates/{id}/acceptance
Copy
Responses
202

202 response

Headers
Locationstring

GET acceptance status endpoint

Body
v2RatesAcceptancePost202Responseobject
messagestring

Accepted message

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

Response
Copy

Retrieves the status of a rate acceptance request

Auth
Headers
Authorizationstring

Required Authorization header containing access token

Path Params
executionIdstring
idstring
GET /v2/rates/{id}/acceptance/status/{executionId}
Copy
Responses
200

200 response

v2RatesAcceptanceStatusGet200Responseobject
responsestring

Stringified JSON response of the rate acceptance request

statusCodenumber

The API response status code of the rate acceptance request

201

201 response

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

Response
Copy

Payment Methods

Get All User's Payment Methods

Auth
Headers
Authorizationstring

Required Authorization header containing access token

Query String
topLevelCommoditystring

Required top level commodity

GET /v2/paymentmethods
Copy
Responses
200

Successfully retrieved payment methods

v2PaymentMethodsGet200Responseobject
totalCountnumber
items
objectobject

Credit Card

lastFourstring

Last four digits of credit card number

isPrimaryboolean

Indicates if default card or not

activeboolean

Indicates whether account is active or not

expirationobject
monthnumber

Expiration month

yearnumber

Expiration year

idstring

Unique ID

typeobject
valuestring

Type of payment method

Enum: creditcard,bankaccount,payonterms

issuerstring

Issuing institution

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

501

Top level commodity not implemented yet

Response
Copy

Bill Of Lading

Get the preSigned url for bill of lading

Auth
Headers
Authorizationstring

Required Authorization header containing access token

Path Params
idstring
GET /v2/listings/{id}/billoflading
Copy
Responses
200

200 response

v2ListingBillofLadingGet200Responseobject
billOfLadingNumbernumber
documentobject

pre-signed url to access the bill of lading

hrefstring

pre-signed url

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

Response
Copy

listing booked webhook

webhook sent when a listing is booked through an integration

Request Body

Information about the booked listing

POST ListingBooked
Copy
Responses
200

Return a 200 status to indicate that the data was received successfully

No response body
Response
Copy

transit status changed webhook

Request Body

Information about the booked transit status change

POST ShipmentTransitStatusChanged
Copy
Responses
200

Return a 200 status to indicate that the data was received successfully

No response body
Response
Copy

listing reference number added webhook

Request Body

Information about the reference number

POST ListingReferenceNumberAdded
Copy
Responses
200

Return a 200 status to indicate that the data was received successfully

No response body
Response
Copy

listing status changed webhook

Request Body

Information about the status change

POST ListingStatusChanged
Copy
Responses
200

Return a 200 status to indicate that the data was received successfully

No response body
Response
Copy

shipment delivery timeframe updated webhook

Request Body

Information about the delivery timeframe

POST ShipmentDeliveryTimeFrameUpdated
Copy
Responses
200

Return a 200 status to indicate that the data was received successfully

No response body
Response
Copy

listing attachment added webhook

Request Body

Information about the attachment

POST ListingAttachmentAdded
Copy
Responses
200

Return a 200 status to indicate that the data was received successfully

No response body
Response
Copy

listing price details updated webhook

Request Body

Information about the price details

POST ListingPriceDetailsUpdated
Copy
Responses
200

Return a 200 status to indicate that the data was received successfully

No response body
Response
Copy