uShip Furniture API Reference v2

The uShip Furniture API provides seamless integration for authentication, rate retrieval, listing management, and tracking for furniture and household goods shipments.

🏖️ Testing Environment

Always test your integration in sandbox before deploying to production.

🏖️ Sandbox (Recommended for Testing): https://api.ushipsandbox.com
🚀 Production: https://api.uship.com

Note: Sandbox and production environments require separate API keys.

Authentication

This API uses Self Service API Keys with Bearer token authentication (replacing legacy OAuth).

To obtain your API Key:

Navigate to API Key Generation Page
Generate your API key (specify sandbox or production)
Include in the Authorization header: Authorization: Bearer <Your API Key>

Integration Guides

For detailed implementation guidance:

Furniture and Home API Guide - Overview and comparison with Shopify integration
Direct Furniture Integrations Guide - Request body details and order of operations
Sandbox Testing Guide - Comprehensive sandbox testing documentation

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

Server

https://api.uship.com

https://api.ushipsandbox.com

Authentication

apiKey Bearer

Use "Bearer " to authenticate.

Fields

Key	In
Authorization	Header

Fixed Price

POST

/v2/fixedprice

Retrieve shipping cost

Provides fixed price information for the cost of a carrier shipping household goods in the US and Canada only.

Auth

Headers

Content-Type

string

application/x-www-form-urlencoded

Request Body

Container for items to be rated and shipped. Used to wrap multiple or single items for rating.

object	object	Request body for the FixedPrice API
source	string	Required. The shipper's alpha numeric company name all lower case and together, no special characters
insurance	object	Amount of protection declared for shipment
coverageAmount	object	Required. coverage amount
amount	number	Required. Amount of coverage desired
currencyType	string	Currency referenced, example USD
originPostalCode	string	Required. Origin zip code
destinationPostalCode	string	Required. Destination zip code
items	array[object]	Required. items
heightInMeters	number	Required. The height of the object in meters
widthInMeters	number	Required. The width of the object in meters
lengthInMeters	number	Required. The length of the object in meters
weightInGrams	int32	The weight of the object in grams
unitCount	int32	Required. unit count
userId	string	userId for pricing estimates
priceCorrelationId	string	priceCorrelationId to correlate the estimated price with the listing
commodity	string	commodity of the shipment
originCountryCode	string	country code where the shipment is originating
destinationCountryCode	string	country code where the shipment is destined

POST /v2/fixedprice

xxxxxxxxxx
 
curl --request POST \ --url 'https://api.uship.com/v2/fixedprice' \ --header 'Content-Type: {Content-Type}' \ --header 'Authorization: {Authorization}' \ --data '{  "source": "Example value",  "insurance": {    "coverageAmount": {      "amount": 500,      "currencyType": "{string}"    }  },  "originPostalCode": "78701",  "destinationPostalCode": "90210",  "items": [    {      "heightInMeters": 1.8,      "widthInMeters": 1.5,      "lengthInMeters": 2.5,      "weightInGrams": "{int32}",      "unitCount": 1    }  ],  "userId": "{string}",  "priceCorrelationId": "{string}",  "commodity": "{string}",  "originCountryCode": "{string}",  "destinationCountryCode": "{string}"}'
Copy

Responses

200

object	object	Fixed Price Response Model
price	number	Total price including uShip service charges
nypAmount	number	Name your price which is total price excluding uShip service charges
priceCorrelationId	uuid	User generated UUID/GUID
insuranceQuote	object
premium	object	The cost for protection coverage (This should be added to shipment pricing in listing)
amount	number
currencyType	string
coverageAmount	object
amount	number
currencyType	string

400

Invalid or missing parameter.

401

Unauthorized

Response

xxxxxxxxxx
 
{ "price": "{number}", "nypAmount": "{number}", "priceCorrelationId": "{uuid}", "insuranceQuote": {  "premium": {   "amount": "{number}",   "currencyType": "{string}"  } }, "coverageAmount": {  "amount": "{number}",  "currencyType": "{string}" }}
Copy

Listings

GET

/v2/listings/{listingId}/contacts

GET

/v2/listings/{listingId}/track

POST

/v2/listings

GET

/v2/listings/{listingId}

PUT

/v2/listings/{listingId}

DELETE

/v2/listings/{listingId}

Retrieve listing contacts

This endpoint allows you to retrieve contact information associated with the shipper and service provider after listing has been booked

Auth

Path Params

listingId

integer

Required. listingId

GET /v2/listings/{listingId}/contacts

xxxxxxxxxx
 
curl --get \ --url 'https://api.uship.com/v2/listings/12345/contacts' \ --header 'Authorization: {Authorization}'
Copy

Responses

200

200 OK

object	object
Shipper	object	Shipper information
name	string	Shipper's name
companyName	string	Company Name of Shipper
username	string	uShip username associated with Shipper
phone	string	Shipper's phone number
secondaryPhone	string	Shipper's secondary phone number
email	string	Shipper email
secondaryEmail	string	Shipper secondary email
fax	string	Shipper fax number
CompanyAddress	object
streetAddress	string	Shipper company street name and number
alternateStreetAddress	string	Shipper company alternate street name and number
majorMunicipality	string	City of shipper company
postalCode	string	Shipper company postal postal code
stateProvice	string	Shipper company state
stateProvinceLabel	string	Shipper company state ISO code
country	string	Shipper company country
countryLabel	string	Shipper company country ISO code
latitude	number	Latitudinal coordinate of company location
longitude	number	Longitudinal coordinate of company location
label	string
shortLabel	string
type	object
value	string
label	string
shortLabel	string
user	object
userId	number	uShip user userId
displayName	string	uShip display name
imageURL	string	URL for user image
profileUrl	string	URL to uShip profile
responseTime	string
feedback	object
count	number
percentPositive	number
starRating	number
acceptanceRate	number
trackingEnabled	boolean	If tracking is enabled
aboutMe	string	Shipper self description
dateCreated	string	Date when shipper user was created
thirdPartyIdentifier	string
thirdPartyProfileLink	string
onTimePercentage	number
rebillPercentage	number	Percentage of shipments rebilled to shipper
damageToClaimRate	number	Percentage of shipments claimed to have damage
pickupInstructionsMaxCharacters	number
tariffUrl	string
isFreightConsolidator	boolean
isNetworkAware	boolean
customFields	string
companyLocation	object
majorMunicipality	string	Shipper company City
stateProvince	string	Shipper company state
directoryCategories	object
value	string
label	string
shortlabel	string
subCommodities	string
links	object
rel	string
verb	string
href	string
title	string
serviceProvider	object
name	string	Service Providers name
companyName	string	Company Name of Service Provider
username	string	uShip username associated with service provider
phone	string	Service provider's phone number
secondaryPhone	string	Service providers secondary phone number
email	string	Service provider's email
secondaryEmail	string	Service provider's secondary email
fax	string	Service provider's fax number
CompanyAddress	object
streetAddress	string	Service provider's company street name and number
alternateStreetAddress	string	Service provider's company alternate street name and number
majorMunicipality	string	City of service provider company
postalCode	string	Service provider company postal postal code
stateProvice	string	Service provider company state
stateProvinceLabel	string	Service provider company state ISO code
country	string	Service provider company country
countryLabel	string	Service provider company country ISO code
latitude	number	Latitudinal coordinate of company location
longitude	number	Longitudinal coordinate of company location
label	string
shortLabel	string
type	object
value	string
label	string
shortLabel	string
user	object
userId	number	uShip user userId
displayName	string	uShip display name
imageURL	string	URL for user image
profileUrl	string	URL to uShip profile
responseTime	string
feedback	object
count	number
percentPositive	number
starRating	number
acceptanceRate	number
trackingEnabled	boolean	Is tracking enabled
aboutMe	string	Service provider self description
dateCreated	string	Date when shipper user was created
thirdPartyIdentifier	string
thirdPartyProfileLink	string
onTimePercentage	number
rebillPercentage	number	Percentage of shipments rebilled to service provider
damageToClaimRate	number	Percentage of shipments claimed to have damage
pickupInstructionsMaxCharacters	number
tariffUrl	string
isFreightConsolidator	boolean
isNetworkAware	boolean
customFields	string
companyLocation	object
majorMunicipality	string	Service provider company City
stateProvince	string	Service provider company state
directoryCategories	object
value	string
label	string
shortlabel	string
subCommodities	string
links	object
rel	string
verb	string
href	string
title	string
locations	object
name	string	Location name
phone	string	Location telephone number
altPhoneNumber	string	Alternate location telephone number
emailAddress	string	Location email address
address	object
streetAddress	string	Locations company street name and number
alternateStreetAddress	string	Locations company alternate street name and number
majorMunicipality	string	City of location company
postalCode	string	Location company postal postal code
stateProvice	string	Location company state
stateProvinceLabel	string	Location company state ISO code
country	string	Location company country
countryLabel	string	Location company country ISO code
latitude	number	Latitudinal coordinate of company location
longitude	number	Longitudinal coordinate of company location
label	string
shortLabel	string
type	object
value	string
label	string
shortLabel	string

Expand

Response

xxxxxxxxxx
 
{ "Shipper": {  "name": "{string}",  "companyName": "{string}",  "username": "{string}",  "phone": "{string}",  "secondaryPhone": "{string}",  "email": "{string}",  "secondaryEmail": "{string}",  "fax": "{string}",  "CompanyAddress": {   "streetAddress": "{string}",   "alternateStreetAddress": "{string}",   "majorMunicipality": "{string}",   "postalCode": "{string}",   "stateProvice": "{string}",   "stateProvinceLabel": "{string}",   "country": "{string}",   "countryLabel": "{string}",   "latitude": "{number}",   "longitude": "{number}",   "label": "{string}",   "shortLabel": "{string}",   "type": {    "value": "{string}",    "label": "{string}",    "shortLabel": "{string}"   }  },  "user": {   "userId": "{number}",   "displayName": "{string}",   "imageURL": "{string}",   "profileUrl": "{string}",   "responseTime": "{string}",   "feedback": {    "count": "{number}",    "percentPositive": "{number}",    "starRating": "{number}",    "acceptanceRate": "{number}"   },   "trackingEnabled": "{boolean}",   "aboutMe": "{string}",   "dateCreated": "{string}",   "thirdPartyIdentifier": "{string}",   "thirdPartyProfileLink": "{string}",   "onTimePercentage": "{number}",   "rebillPercentage": "{number}",   "damageToClaimRate": "{number}",   "pickupInstructionsMaxCharacters": "{number}",   "tariffUrl": "{string}",   "isFreightConsolidator": "{boolean}",   "isNetworkAware": "{boolean}",   "customFields": "{string}",   "companyLocation": {    "majorMunicipality": "{string}",    "stateProvince": "{string}"   },   "directoryCategories": {    "value": "{string}",    "label": "{string}",    "shortlabel": "{string}",    "subCommodities": "{string}"   },   "links": {    "rel": "{string}",    "verb": "{string}",    "href": "{string}",    "title": "{string}"   }  } }, "serviceProvider": {  "name": "{string}",  "companyName": "{string}",  "username": "{string}",  "phone": "{string}",  "secondaryPhone": "{string}",  "email": "{string}",  "secondaryEmail": "{string}",  "fax": "{string}",  "CompanyAddress": {   "streetAddress": "{string}",   "alternateStreetAddress": "{string}",   "majorMunicipality": "{string}",   "postalCode": "{string}",   "stateProvice": "{string}",   "stateProvinceLabel": "{string}",   "country": "{string}",   "countryLabel": "{string}",   "latitude": "{number}",   "longitude": "{number}",   "label": "{string}",   "shortLabel": "{string}",   "type": {    "value": "{string}",    "label": "{string}",    "shortLabel": "{string}"   }  },  "user": {   "userId": "{number}",   "displayName": "{string}",   "imageURL": "{string}",   "profileUrl": "{string}",   "responseTime": "{string}",   "feedback": {    "count": "{number}",    "percentPositive": "{number}",    "starRating": "{number}",    "acceptanceRate": "{number}"   },   "trackingEnabled": "{boolean}",   "aboutMe": "{string}",   "dateCreated": "{string}",   "thirdPartyIdentifier": "{string}",   "thirdPartyProfileLink": "{string}",   "onTimePercentage": "{number}",   "rebillPercentage": "{number}",   "damageToClaimRate": "{number}",   "pickupInstructionsMaxCharacters": "{number}",   "tariffUrl": "{string}",   "isFreightConsolidator": "{boolean}",   "isNetworkAware": "{boolean}",   "customFields": "{string}",   "companyLocation": {    "majorMunicipality": "{string}",    "stateProvince": "{string}"   },   "directoryCategories": {    "value": "{string}",    "label": "{string}",    "shortlabel": "{string}",    "subCommodities": "{string}"   },   "links": {    "rel": "{string}",    "verb": "{string}",    "href": "{string}",    "title": "{string}"   }  } }, "locations": {  "name": "{string}",  "phone": "{string}",  "altPhoneNumber": "{string}",  "emailAddress": "{string}",  "address": {   "streetAddress": "{string}",   "alternateStreetAddress": "{string}",   "majorMunicipality": "{string}",   "postalCode": "{string}",   "stateProvice": "{string}",   "stateProvinceLabel": "{string}",   "country": "{string}",   "countryLabel": "{string}",   "latitude": "{number}",   "longitude": "{number}",   "label": "{string}",   "shortLabel": "{string}",   "type": {    "value": "{string}",    "label": "{string}",    "shortLabel": "{string}"   }  } }}
Copy

Expand

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

client_id	string	Required. The unique ID provided to you by uShip for integrating
client_secret	string	Required. The unique ID secret provided alongside your client ID by uShip

Path Params

listingId

integer

Required. listingId

GET /v2/listings/{listingId}/track

xxxxxxxxxx
 
curl --get \ --url 'https://api.uship.com/v2/listings/12345/track' \ --header 'client_id: Example value' \ --header 'client_secret: Example value' \ --header 'Authorization: {Authorization}'
Copy

Responses

200

200 OK

object	object
listingGeneratedId	integer	The ID for your listing
listingTitle	string	The title of your listing
commodityCode	string	Displays CarsLightTrucks
shipmentTrackingSummaryModel	object
originAddress	object	The origin location reverse geo-coded to an address.
latitude	number	The latitude recorded to two decimal places.
longitude	number	The longitude recorded to two decimal places.
label	string	A location label created from the coordinates
shortLabel	string	A shortened location label created from the coordinates
destinationAddress	object	The destination location reverse geo-coded to an address.
latitude	number	The latitude recorded to two decimal places.
longitude	number	The longitude recorded to two decimal places.
label	string	A location label created from the coordinates
shortLabel	string	A shortened location label created from the coordinates
pickupTimeframe	object	The timeframe for picking up the shipment.
date1	date-time	The first date in the pickup timeframe.
date2	date-time	The last date in the pickup timeframe.
date1Offset	date-time	The date offset for the first date.
date2Offset	date-time	The date offset for the second date.
timeFrameType	object	The type of timeframe
value	string	The value of timeframe type.
label	string	The label for the type of timeframe.
shortLabel	string	The label for the type of timeframe.
timeZone	string	The string representation of the timezone.
label	string	The full timeframe label with day, month, and year.
shortLabel	string	The timeframe with only the month and day.
shortLabelWithYear	string	The timeframe with the month, day, and year.
deliveryTimeframe	object	The timeframe for deliverying the shipment.
date1	date-time	The first date in the delivery timeframe.
date2	date-time	The last date in the delivery timeframe.
date1Offset	date-time	The date offset for the first date.
date2Offset	date-time	The date offset for the second date.
timeFrameType	object	The type of timeframe
value	string	The value of timeframe type.
label	string	The label for the type of timeframe.
shortLabel	string	The label for the type of timeframe.
timeZone	string	The string representation of the timezone.
label	string	The full timeframe label with day, month, and year.
shortLabel	string	The timeframe with only the month and day.
shortLabelWithYear	string	The timeframe with the month, day, and year.
currentTransitStatus	object	The current transit status of the listing.
value	string	The value for the current transit status
label	string	The label for the transit status
shortLabel	string	The label for the transit status
carrierContactModel	object	The contact information for the carrier
name	string	The name of the carrier
companyName	string	The carrier's company name.
username	string	The carrier's username.
user	object	Information about the carrier.
userId	integer	The carrier's user ID.
displayName	string	The name to display for the carrier
imageUrl	string	The url to the carrier's profile image.
profileUrl	string	The url to the carrier's profile.
feedback	object	The feedback scores for the carrier
count	integer	The number of reviews
percentPositive	number	The positive score to one decmial place.
starRating	number	The overall score from all reviews based on a five star score. The value is to one decimal place.
aboutMe	string	The about statement from the carrier's profile.
dateCreated	string	The creation date of the carrier account.
companyLocation	object	The location of the carrier's company.
majorMunicipality	string	The city near the carrier's company.
stateProvince	string	The state or province the carrier's company is located.
directoryCategories	array[object]	The list of categories the carrier handles.
value	string	The value of the category.
label	string	The label for the category.
shortLabel	string	The label for the category.
links	array[object]	The list of available links associated with the carrier.
verb	string	HTTP method associated with the link.
href	string	The url for the link
title	string	label for the link
shipmentTrackingStatuses	array[object]	The list of tracking statuses and when they were set
status	string	The tracking status.
punctuality	object	Whether the status was set by the agreed date.
value	string	The value for the punctuality.
label	string	The label for the punctuality.
shortLabel	string	The shortened label for the punctuality.
recorded	string	The date/time when the status was recorded.
mostRecentLocation	array[object]	The last recorded location of your shipment.
recorded	string	The time the location was noted
latitude	number	The latitude recorded to two decimal points
longitude	number	The longitude recorded to two decimal points
mostRecentAddress	array[object]	The last recorded location reverse geo-coded to an address. Will not be returned if not available.
latitude	number	The latitude recorded to two decimal points
longitude	number	The longitude recorded to two decimal points
label	string	A location label created from the coordinates
shortLabel	string	A shortened location label created from the coordinates

Expand

Response

xxxxxxxxxx
 
{ "listingGeneratedId": "{integer}", "listingTitle": "{string}", "commodityCode": "{string}", "shipmentTrackingSummaryModel": {  "originAddress": {   "latitude": "{number}",   "longitude": "{number}",   "label": "{string}",   "shortLabel": "{string}"  },  "destinationAddress": {   "latitude": "{number}",   "longitude": "{number}",   "label": "{string}",   "shortLabel": "{string}"  },  "pickupTimeframe": {   "date1": "{date-time}",   "date2": "{date-time}",   "date1Offset": "2020-01-31T00:00:00-06:00",   "date2Offset": "2020-01-31T00:00:00-06:00",   "timeFrameType": {    "value": "Between",    "label": "between",    "shortLabel": "between"   },   "timeZone": "America/Chicago",   "label": "Between 1/31/2020 - 2/2/2020",   "shortLabel": "1/31 - 2/2",   "shortLabelWithYear": "1/31/2020 - 2/2/2020"  },  "deliveryTimeframe": {   "date1": "{date-time}",   "date2": "{date-time}",   "date1Offset": "2020-01-31T00:00:00-06:00",   "date2Offset": "2020-01-31T00:00:00-06:00",   "timeFrameType": {    "value": "Between",    "label": "between",    "shortLabel": "between"   },   "timeZone": "America/Chicago",   "label": "Between 1/31/2020 - 2/2/2020",   "shortLabel": "1/31 - 2/2",   "shortLabelWithYear": "1/31/2020 - 2/2/2020"  },  "currentTransitStatus": {   "value": "Delivered",   "label": "Delivered",   "shortLabel": "Delivered"  } }, "carrierContactModel": {  "name": "{string}",  "companyName": "{string}",  "username": "{string}",  "user": {   "userId": "{integer}",   "displayName": "{string}",   "imageUrl": "{string}",   "profileUrl": "{string}",   "feedback": {    "count": "{integer}",    "percentPositive": "{number}",    "starRating": "{number}"   },   "aboutMe": "{string}",   "dateCreated": "2004-02-23T17:51:17Z",   "companyLocation": {    "majorMunicipality": "{string}",    "stateProvince": "{string}"   },   "directoryCategories": [    {     "value": "HouseholdGoods",     "label": "Vehicles",     "shortLabel": "Vehicles"    }   ],   "links": [    {     "verb": "GET",     "href": "{string}",     "title": "{string}"    }   ]  } }, "shipmentTrackingStatuses": [  {   "status": "ReadyForDispatch",   "punctuality": {    "value": "NotApplicable",    "label": "Not Applicable",    "shortLabel": "n/a"   },   "recorded": "2020-01-31T00:30:14Z"  } ], "mostRecentLocation": [  {   "recorded": "{string}",   "latitude": "{number}",   "longitude": "{number}"  } ], "mostRecentAddress": [  {   "latitude": "{number}",   "longitude": "{number}",   "label": "{string}",   "shortLabel": "{string}"  } ]}
Copy

Expand

Creating an IHD Listing

Auth

Headers

Content-Type

string

application/x-www-form-urlencoded

Request Body

Request body for v2 Listings POST request

object	object	Request body for v2 Listings API Post request
title	string	Required. A title for the listing
description	string	A description for the listing
confidentialDescription	string	A confidential description only seen by the driver
pricing	object	Pricing information for a listing. Only one of these properties should be used
namedPrice	object	Named price
amount	number
currencyType	string
targetPrice	object	Target price
amount	number
currencyType	string
insurance	object	Amount of protection declared for shipment
coverageAmount	object	Required. coverage amount
amount	number	Required. Amount of coverage desired
currencyType	string	Required. Currency referenced, example USD
route	object	Required. route
items	array[object]	Required. Must enter two objects, the first is the pickup addres, the second is the delivery address
address	object	Required. address
streetAddress	string	Required. Primary street address
alternateStreetAddress	string	Secondary street address
majorMunicipality	string	The city or minor governing body
postalCode	string	Required. Postal code
stateProvince	string	State or governing province code
country	string	Required. Country code
type	string	Required. Location description Enum: `Residence`,`BusinessWithLoadingDockOrForklift`,`BusinessWithoutLoadingDockOrForklift`,`ConstructionSite`,`TradeShowOrConvention`,`Port`,`StorageFacility`,`RitchieBrosAuctionSalesSite`,`MilitaryBase`,`Airport`,`OtherSecuredLocation`,`NA`,`FarmRanchEstate`,`School`,`GovernmentLocation`,`ReligiousInstitution`,`GolfCourseResortPark`,`DistributionCenter`,`FreightTerminal`,`Auction`
contactPhoneNumber	string	Phone number
contactFullName	string	Full name
formattedAddress	string	Displayable version of the address
timeZone	string
timeFrame	object	Required. Timeframe
earliestArrival	string	Required. Earliest range for arrival for pickup or dropoff
latestArrival	string	Required. Latest range for arrival for pickup or dropoff
timeFrameType	string	Required. Timeframe type Enum: `before`,`between`,`on`,`after`,`none`
timeZone	string	Latest range for arrival for pickup or dropoff with Timezone offset
contact	object	Contact information
name	string	Name
companyName	string	Company name
phoneNumber	string	Phone number
email	string	Email address
items	array[object]	Required. items
commodity	string
title	string
unitCount	number
widthInMeters	number
lengthInMeters	number
heightInMeters	number
weightInGrams	number
hazardous	boolean
stackable	boolean
handlingUnit	string
requestedRateTypes	string
referenceNumbers	array[object]
type	string	Enum: `Pickup`,`Delivery`,`Invoice`,`PurchaseOrder`,`SalesOrder`,`Other`
number	string
serviceTypes	array[string]	A list of requested service types for the shipment Enum: `BlanketWrap`,`LtlTransportOnly`,`LtlFreightPackaging`
gallery	array[string]

Expand

POST /v2/listings

xxxxxxxxxx
 
curl --request POST \ --url 'https://api.uship.com/v2/listings' \ --header 'Content-Type: {Content-Type}' \ --header 'Authorization: {Authorization}' \ --data '{  "title": "Furniture Shipment",  "description": "{string}",  "confidentialDescription": "{string}",  "pricing": {    "namedPrice": {      "amount": "{number}",      "currencyType": "{string}"    },    "targetPrice": {      "amount": "{number}",      "currencyType": "{string}"    }  },  "insurance": {    "coverageAmount": {      "amount": 500,      "currencyType": "USD"    }  },  "route": {    "items": [      {        "address": {          "streetAddress": "123 Main Street",          "alternateStreetAddress": "{string}",          "majorMunicipality": "{string}",          "postalCode": "78701",          "stateProvince": "{string}",          "country": "US",          "type": "Residential",          "contactPhoneNumber": "{string}",          "contactFullName": "{string}",          "formattedAddress": "{string}",          "timeZone": "{string}"        },        "timeFrame": {          "earliestArrival": "2025-01-01T09:00:00Z",          "latestArrival": "2025-01-01T17:00:00Z",          "timeFrameType": "Flexible",          "timeZone": "{string}"        },        "contact": {          "name": "{string}",          "companyName": "{string}",          "phoneNumber": "{string}",          "email": "{string}"        }      }    ]  },  "items": [    {      "commodity": "{string}",      "title": "{string}",      "unitCount": "{number}",      "widthInMeters": "{number}",      "lengthInMeters": "{number}",      "heightInMeters": "{number}",      "weightInGrams": "{number}",      "hazardous": "{boolean}",      "stackable": "{boolean}",      "handlingUnit": "{string}"    }  ],  "requestedRateTypes": "{string}",  "referenceNumbers": [    {      "type": "{string}",      "number": "{string}"    }  ],  "serviceTypes": [    "{array[string]...}"  ],  "gallery": [    "{array[string]...}"  ]}'
Copy

Expand

Responses

201

Created

object

Created

401

Unauthorized

Response

xxxxxxxxxx
 
{}
Copy

Retrieves IHD listing by ID

Auth

Path Params

listingId

number

Required. ID provided when IHD listing is created

GET /v2/listings/{listingId}

xxxxxxxxxx
 
curl --get \ --url 'https://api.uship.com/v2/listings/12345' \ --header 'Authorization: {Authorization}'
Copy

Responses

200

Succesfully retrieved

object	object	A collection of multiple items retrieved from a single API resource
totalCount	int32	The total count of items that exist for the resource requested
items	array[object]	The paged collection of items as requested
acceptedBidPrice	object	The details of a price and recommended formatting
value	number	Required. Raw value of the price
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
currencyType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
lister	object	Public representation of a user
userId	int32	Required. Generated Id
displayName	string	Short name
imageUrl	string	Public profile image
profileUrl	string	Public profile URL
responseTime	string	Average response time
feedback	object
count	int32	The number of feedback items left
percentPositive	number	The percent of feedback that the user has recieved that is positive. If the user has received no feedback, the value is -1. If the user has received only negative feedback, the value is 0, and it is omitted from the serialized object.
starRating	number	Rating that determines how many "stars" the user's profile has
acceptanceRate	number	The ratio of accepted bids versus total bids
trackingEnabled	boolean	Tracking status of user
aboutMe	string	User description
dateCreated	date-time	Date joined uship.com
thirdPartyIdentifier	string	An identifer (email/integer/other) which can uniquely identify this user, set externally
thirdPartyProfileLink	string	A link to a page with information about this user on a different site
onTimePercentage	number	Calculated percentage of on time shipments shipped by this user
rebillPercentage	number	Calculated percentage of rebills on shipments shipped by this user
damageToClaimRatio	number	Calculated amount of damage amount/claim amount on shipments shipped by this user
pickupInstructionsMaxCharacters	int32	Maximum number of pickup instruction characters supported for shipments shipped by this user
tariffUrl	string	URL that points to this user's tariff (terms and conditions) information
isFreightConsolidator	boolean	A flag indicating whether or not a user is an LTL carrier providing consolidated shipments
isNetworkAware	boolean	Required. True if carrier has ever been added to a network
customFields	object	Variable customer fields
companyLocation	object	Output model for general address location
majorMunicipality	string
stateProvince	string
directoryCategories	array[object]	Top level commodity categories selected by the user
value	string	The code assigned to this class of transportable objects
label	string	The human-readable, localized name of the class of objects
shortLabel	string
subCommodities	array[object]	Sub-types of this class of objects; i.e., further specialized descriptions of the commodity
links	array[object]	Required. The resource's links
rel	string	The relationship between the current resource and the linked resource
verb	string	GET, PUT, POST, DELETE, HEAD
href	string	The URI of the resource(s)
title	string	The name of the resource; theoretically, this should be the root name of the controller
assignedDriver	object	Public representation of a user
userId	int32	Required. Generated Id
displayName	string	Short name
imageUrl	string	Public profile image
profileUrl	string	Public profile URL
responseTime	string	Average response time
feedback	object
count	int32	The number of feedback items left
percentPositive	number	The percent of feedback that the user has recieved that is positive. If the user has received no feedback, the value is -1. If the user has received only negative feedback, the value is 0, and it is omitted from the serialized object.
starRating	number	Rating that determines how many "stars" the user's profile has
acceptanceRate	number	The ratio of accepted bids versus total bids
trackingEnabled	boolean	Tracking status of user
aboutMe	string	User description
dateCreated	date-time	Date joined uship.com
thirdPartyIdentifier	string	An identifer (email/integer/other) which can uniquely identify this user, set externally
thirdPartyProfileLink	string	A link to a page with information about this user on a different site
onTimePercentage	number	Calculated percentage of on time shipments shipped by this user
rebillPercentage	number	Calculated percentage of rebills on shipments shipped by this user
damageToClaimRatio	number	Calculated amount of damage amount/claim amount on shipments shipped by this user
pickupInstructionsMaxCharacters	int32	Maximum number of pickup instruction characters supported for shipments shipped by this user
tariffUrl	string	URL that points to this user's tariff (terms and conditions) information
isFreightConsolidator	boolean	A flag indicating whether or not a user is an LTL carrier providing consolidated shipments
isNetworkAware	boolean	Required. True if carrier has ever been added to a network
customFields	object	Variable customer fields
companyLocation	object	Output model for general address location
majorMunicipality	string
stateProvince	string
directoryCategories	array[object]	Top level commodity categories selected by the user
value	string	The code assigned to this class of transportable objects
label	string	The human-readable, localized name of the class of objects
shortLabel	string
subCommodities	array[object]	Sub-types of this class of objects; i.e., further specialized descriptions of the commodity
links	array[object]	Required. The resource's links
rel	string	The relationship between the current resource and the linked resource
verb	string	GET, PUT, POST, DELETE, HEAD
href	string	The URI of the resource(s)
title	string	The name of the resource; theoretically, this should be the root name of the controller
status	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
paymentStatus	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
transitStatus	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
cancellationStatus	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
createdOn	date-time
lastUpdatedOn	date-time
bookedOn	date-time
completedOn	date-time
cancelledOn	date-time
archivedOn	date-time
transitStatusActions	array[object]
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
amountDueToServiceProvider	object	The details of a price and recommended formatting
value	number	Required. Raw value of the price
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
currencyType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
amountToMe	object	The details of a price and recommended formatting
value	number	Required. Raw value of the price
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
currencyType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
priceDetails	object	An aggregate of line items of a transaction
items	array[object]
amount	object	The details of a price and recommended formatting
value	number	Required. Raw value of the price
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
currencyType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
description	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
isAutobookingListing	boolean
listingId	int32	Gets or sets the listing id.
title	string	Gets or sets the title.
imageUrl	string	Gets or sets the image URL.
isDefaultImage	boolean	Determines whether the ImageUrl is a URL to a default commodity image.
route	object	Container for route destinations and other route information
distance	object	Measurement of a large value used for distance
kilometers	number	Raw distance in kilometers
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
items	array[object]	Ordered list of route destinations
address	object	Details of an address and recommended formatting
streetAddress	string	Primary street address
alternateStreetAddress	string	Secondary street address
majorMunicipality	string	The city or minor governing body
postalCode	string	Postal code
stateProvince	string	State or governing province code
stateProvinceLabel	string	State or governing province
country	string	Country code
countryLabel	string	Country
latitude	number	Geographical latitude
longitude	number	Geographical longitude
label	string	Recommended formatting
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
type	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
contact	object	Shipper contact information for the route point
name	string	Required. name maxLength: 50
companyName	string
phoneNumber	string	Required. phone number maxLength: 20
altPhoneNumber	string	Required. alt phone number maxLength: 20
email	string
firstName	string
lastName	string
timeFrame	object	The details of a time frame and recommended display
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
earliestArrival	date-time	Earliest range for arrival for pickup or dropoff
latestArrival	date-time	Latest range for arrival for pickup or dropoff
localEarliestArrival	date-time	Required. Earliest range for arrival for pickup or dropoff with Timezone offset
localLatestArrival	date-time	Required. Latest range for arrival for pickup or dropoff with Timezone offset
timeFrameType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
timeZone	string	Specifies the Time Zone in the Zone Info (Olson, TzIdentifier) format
terminal	object	A model for freight terminals
phoneNumber	string	The phone number for the terminal
city	string	The city the terminal is located in
state	string	The state the terminal is located in
postalCode	string	The postal code of the terminal
attributes	object	Attributes associated with a single destination
*	object
title	string
value	object
label	string
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
accessorials	array[object]	Collection of service accessorials for this route point
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
expiresOn	date-time	Gets or sets the expires on.
commodity	string	Gets or sets the commodity.
parentCommodity	string	Gets or sets the parent commodity.
topLevelCommodity	string	Gets or sets the top level commodity.
activeBidsPlaced	int32	Gets or sets the number of active bids.
totalBidsPlaced	int32	Gets or sets the total bids placed.
totalShipments	int32	Gets or sets the total shipments on the listing.
isAuction	boolean	Gets or sets a value indicating whether this instance is auction.
isDutchAuction	boolean	Gets or sets a value indicating whether this instance is a Dutch Auction
isCharitable	boolean	Gets or sets a value indicating whether this instance is charitable.
autoAcceptPrice	object	The details of a price and recommended formatting
value	number	Required. Raw value of the price
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
currencyType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
namedPrice	object	Required. named price
value	number	Required. Raw value of the price
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
currencyType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
offerPrice	object	The details of a price and recommended formatting
value	number	Required. Raw value of the price
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
currencyType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
auctionTargetPrice	object	The details of a price and recommended formatting
value	number	Required. Raw value of the price
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
currencyType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
lowestBidPrice	object	The details of a price and recommended formatting
value	number	Required. Raw value of the price
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
currencyType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
isBrokered	boolean	Gets or sets a value indicating whether this instance is brokered.
isReadyForPickup	boolean	True if the pickup date is on or before today
distance	object	Measurement of a large value used for distance
kilometers	number	Raw distance in kilometers
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
isWatched	boolean	Gets or sets a value indicating whether this instance is watched.
hasCarrierQualifications	boolean	Gets or sets a value indicating whether this instance is subject to Carrier Qualifications.
privateNetwork	string	The private network in which this listing resides
dateAccepted	date-time	Date a bid was accepted on this listing
dateCreated	date-time	Date a listing was created on this listing
currentStatus	string	Current status of listing
bookedPrice	object	The details of a price and recommended formatting
value	number	Required. Raw value of the price
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
currencyType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
description	string	Description of the listing
commodityType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
parentCommodityType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
topLevelCommodityType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
isExclusiveListing	boolean	A flag to indicate whether or not a listing is exclusive to any network
links	array[object]	Required. The resource's links
rel	string	The relationship between the current resource and the linked resource
verb	string	GET, PUT, POST, DELETE, HEAD
href	string	The URI of the resource(s)
title	string	The name of the resource; theoretically, this should be the root name of the controller

Expand

401

Invalid credentials

Response

xxxxxxxxxx
 
{
 "status": {...},
 "paymentStatus": {...},
 "transitStatus": {...},
 "isAuction": true, "auctionTargetPrice": {...},
 "acceptedBidPrice": {...},
 "totalCost": {...},
 "bookingDeposit": {...},
 "priceDetails": {...},
 "commodity": "New Commercial Goods", "parentCommodity": "LTL Freight", "topLevelCommodity": "LTL Freight", "expiresOn": "2023-07-21T10:54:35", "totalBidsPlaced": 1, "imageUrl": "https://www.ushipsandbox.com/public/images/icons/categories/114x138/8_114x138.png", "isDefaultImage": true, "checksum": "c9f0a65b38c61405", "createdOn": "2023-07-20T10:54:35-05:00", "lastUpdatedOn": "2023-07-20T10:54:35-05:00", "bookedOn": "2023-07-20T10:54:38", "serviceProvider": {...},
 "billOfLadingNumber": 2665349, "minimumBidAmount": {...},
 "quoteRequestId": "64b9546806a13f0638323de9", "commodityType": {...},
 "parentCommodityType": {...},
 "topLevelCommodityType": {...},
 "serviceTypes": [], "listingId": 675712978, "title": "Boat motor parts", "description": "", "route": {...},
 "lister": {...},
 "items": [...],
 "accessorials": [], "totalWeightInGrams": {...},
 "links": [...]
}
Copy

Edits IHD listing by ID

Auth

Path Params

integer

Required. ID of the listing to update

Request Body

Listing update model containing the fields to update

object	object	Model for updating a listing
checksum	string	Checksum for concurrency control
title	string	Listing title
description	string	Listing description
route	object	Container for route destinations and other route information
distance	object	Measurement of a large value used for distance
kilometers	number	Raw distance in kilometers
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
items	array[object]	Ordered list of route destinations
address	object	Details of an address and recommended formatting
streetAddress	string	Primary street address
alternateStreetAddress	string	Secondary street address
majorMunicipality	string	The city or minor governing body
postalCode	string	Postal code
stateProvince	string	State or governing province code
stateProvinceLabel	string	State or governing province
country	string	Country code
countryLabel	string	Country
latitude	number	Geographical latitude
longitude	number	Geographical longitude
label	string	Recommended formatting
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
type	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
contact	object	Shipper contact information for the route point
name	string	Required. name maxLength: 50
companyName	string
phoneNumber	string	Required. phone number maxLength: 20
altPhoneNumber	string	Required. alt phone number maxLength: 20
email	string
firstName	string
lastName	string
timeFrame	object	The details of a time frame and recommended display
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
earliestArrival	date-time	Earliest range for arrival for pickup or dropoff
latestArrival	date-time	Latest range for arrival for pickup or dropoff
localEarliestArrival	date-time	Required. Earliest range for arrival for pickup or dropoff with Timezone offset
localLatestArrival	date-time	Required. Latest range for arrival for pickup or dropoff with Timezone offset
timeFrameType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
timeZone	string	Specifies the Time Zone in the Zone Info (Olson, TzIdentifier) format
terminal	object	A model for freight terminals
phoneNumber	string	The phone number for the terminal
city	string	The city the terminal is located in
state	string	The state the terminal is located in
postalCode	string	The postal code of the terminal
attributes	object	Attributes associated with a single destination
*	object
title	string
value	object
label	string
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
accessorials	array[object]	Collection of service accessorials for this route point
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
isAuction	boolean	Whether this listing is an auction
isDutchAuction	boolean	Whether this listing is a Dutch auction
namedPrice	object	The details of a price and recommended formatting
value	number	Required. Raw value of the price
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
currencyType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
offerPrice	object	The details of a price and recommended formatting
value	number	Required. Raw value of the price
label	string	Suggested formatted representation
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
currencyType	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
items	array[object]	Collection of listing items
serviceTypes	array[object]	Service types for the listing
value	string	This is a stable value suitable for use in logic.
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
referenceNumbers	array[object]	Reference numbers associated with the listing
number	string	Required. number maxLength: 60
type	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic. Enum: `Pickup`,`Delivery`,`Invoice`,`PurchaseOrder`,`SalesOrder`,`Other`,`Lot`,`Release`,`ThirdPartyTracking`,`PriceCorrelationId`,`ThirdPartyOrderNumber`,`VIN`,`SKU`,`ProgressiveNumber`
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
referenceNumberLabel	string
attributes	object	Additional attributes for the listing
*	object
title	string
value	object
label	string
shortLabel	string	shortened, localized, human-readable form of the value represented by the other properties of the class
isItineraryMandatory	boolean	Whether itinerary is mandatory for this listing
importSource	string	The URI of a listing-like resource from which a listing might be created or updated

Expand

PUT /v2/listings/{listingId}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://api.uship.com/v2/listings/{listingId}' \ --header 'Authorization: {Authorization}' \ --data '{  "checksum": "{string}",  "title": "{string}",  "description": "{string}",  "route": {    "distance": {      "kilometers": "{number}",      "label": "{string}",      "shortLabel": "{string}"    },    "items": [      {        "address": {          "streetAddress": "{string}",          "alternateStreetAddress": "{string}",          "majorMunicipality": "{string}",          "postalCode": "{string}",          "stateProvince": "{string}",          "stateProvinceLabel": "{string}",          "country": "{string}",          "countryLabel": "{string}",          "latitude": "{number}",          "longitude": "{number}",          "label": "{string}",          "shortLabel": "{string}",          "type": {            "value": "{string}",            "label": "{string}",            "shortLabel": "{string}"          }        },        "contact": {          "name": "John Doe",          "companyName": "{string}",          "phoneNumber": "+1-512-555-0123",          "altPhoneNumber": "+1-512-555-9876",          "email": "{string}",          "firstName": "{string}",          "lastName": "{string}"        },        "timeFrame": {          "label": "{string}",          "shortLabel": "{string}",          "earliestArrival": "{date-time}",          "latestArrival": "{date-time}",          "localEarliestArrival": "2025-01-01T12:00:00Z",          "localLatestArrival": "2025-01-01T12:00:00Z",          "timeFrameType": {            "value": "{string}",            "label": "{string}",            "shortLabel": "{string}"          },          "timeZone": "{string}"        },        "terminal": {          "phoneNumber": "{string}",          "city": "{string}",          "state": "{string}",          "postalCode": "{string}"        },        "attributes": {},        "accessorials": [          {            "value": "{string}",            "label": "{string}",            "shortLabel": "{string}"          }        ]      }    ]  },  "isAuction": "{boolean}",  "isDutchAuction": "{boolean}",  "namedPrice": {    "value": "Example Value",    "label": "{string}",    "shortLabel": "{string}",    "currencyType": {      "value": "{string}",      "label": "{string}",      "shortLabel": "{string}"    }  },  "offerPrice": {    "value": "Example Value",    "label": "{string}",    "shortLabel": "{string}",    "currencyType": {      "value": "{string}",      "label": "{string}",      "shortLabel": "{string}"    }  },  "items": [    {}  ],  "serviceTypes": [    {      "value": "{string}",      "label": "{string}",      "shortLabel": "{string}"    }  ],  "referenceNumbers": [    {      "number": "Example value",      "type": {        "value": "{string}",        "label": "{string}",        "shortLabel": "{string}"      },      "referenceNumberLabel": "{string}"    }  ],  "attributes": {},  "isItineraryMandatory": "{boolean}",  "importSource": "{string}"}'
Copy

Expand

Responses

204

Confirms the edit was successful

No response body

401

Credentials are invalid

Response

xxxxxxxxxx
 
No example response
Copy

Delete IHD listing by ID

Auth

Path Params

listingId

integer

Required. ID of the listing to delete

DELETE /v2/listings/{listingId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://api.uship.com/v2/listings/12345'
Copy

Responses

204

No Content

No response body

401

Missing or invalid x-api-key.

403

Listing cannot be deleted because it has already been Booked.

404

Listing does not exist or isn't accessible with your key.

Response

xxxxxxxxxx
 
No example response
Copy

Bill Of Lading

GET

/v2/listings/{id}/billoflading

Get the preSigned url for bill of lading

Auth

Headers

Authorization

string

Required. Required Authorization header containing access token

Path Params

string

Required. id

GET /v2/listings/{id}/billoflading

xxxxxxxxxx
 
curl --get \ --url 'https://api.uship.com/v2/listings/Example%20value/billoflading' \ --header 'Authorization: Example value' \ --header 'Authorization: {Authorization}'
Copy

Responses

200

200 response

v2ListingBillofLadingGet200Response	object
billOfLadingNumber	number
document	object	pre-signed url to access the bill of lading
href	string	pre-signed url

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

Response

xxxxxxxxxx
 
{ "billOfLadingNumber": "{number}", "document": {  "href": "{string}" }}
Copy

Webhooks

POST

ShipmentTransitStatusChanged

transit status changed webhook

Request Body

Information about the booked transit status change

object	object
specversion	string	The version of the CloudEvents specification which the event uses. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#specversion Enum: `1.0`
source	string	Identifies the context in which an event happened. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#source-1
id	uuid	Identifies the event. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#id
time	date-time	Timestamp of when the occurrence happened in ISO-8601 format. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#time
type	string	Type of event related to the originating occurrence. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#type Enum: `Shipment.TransitStatusChanged/v1`
data	object
href	string	Relative URL of the shipment API resource
referenceNumbers	array[object]	These are identifiers and numbers by which refer to this Shipment or its cargo in some external system. If this Shipment is "owned" by an external system, prefer the ThirdParty property, as those fields are searchable and affect some uShip behavior.
number	string	Required. number maxLength: 60
type	object	Details of an enum that can be translated
value	string	This is a stable value suitable for use in logic. Enum: `Pickup`,`Delivery`,`Invoice`,`PurchaseOrder`,`SalesOrder`,`Other`,`Lot`,`Release`,`ThirdPartyTracking`,`PriceCorrelationId`,`ThirdPartyOrderNumber`,`VIN`,`SKU`,`ProgressiveNumber`
label	string	This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
shortLabel	string	This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference.
referenceNumberLabel	string
listing	object
href	string	Relative URL of the listing API resource
listingId	number	ID of the listing
transitStatus	object
value	string	Enum: `ReadyForDispatch`,`Dispatched`,`PickedUp`,`Delivered`

Expand

POST ShipmentTransitStatusChanged

xxxxxxxxxx
 
{  "specversion": "{string}",  "source": "{string}",  "id": "{uuid}",  "time": "{date-time}",  "type": "{string}",  "data": {    "href": "{string}",    "referenceNumbers": [      {        "number": "Example value",        "type": {          "value": "{string}",          "label": "{string}",          "shortLabel": "{string}"        },        "referenceNumberLabel": "{string}"      }    ],    "listing": {      "href": "{string}",      "listingId": "{number}"    },    "transitStatus": {      "value": "{string}"    }  }}
Copy

Responses

200

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

No response body

Response

xxxxxxxxxx
 
No response
Copy