API docs by Redocly

uShip Furniture API Reference (v2)

Download OpenAPI specification:

E-mail: apisupport@uship.com

The uShip Furniture API provides seamless integration for white glove furniture and household goods shipments.

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
Furniture and Home API Guide Overview and Shopify integration comparison
Direct Furniture Integrations Request body details and order of operations
Sandbox Testing Guide Comprehensive sandbox testing documentation

Support

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

Fixed Price

Get instant shipping quotes for furniture delivery. Use these endpoints to retrieve pricing before creating a listing.

Retrieve shipping cost

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

Authorizations:
Bearer
header Parameters
Content-Type
string

application/x-www-form-urlencoded

Request Body schema: application/json
required

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

source
required
string

Required. The shipper's alpha numeric company name all lower case and together, no special characters

object

Amount of protection declared for shipment

originPostalCode
required
string

Required. Origin zip code

destinationPostalCode
required
string

Required. Destination zip code

required
Array of objects

Required. items

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

Responses

Request samples

Content type
application/json
{
  • "source": "acmefurniture",
  • "insurance": {
    },
  • "originPostalCode": "78701",
  • "destinationPostalCode": "90210",
  • "items": [
    ],
  • "userId": 30450164,
  • "priceCorrelationId": "675712978",
  • "commodity": "FurnitureHouseholdGoods",
  • "originCountryCode": "US",
  • "destinationCountryCode": "US"
}

Response samples

Content type
application/json
{
  • "price": 2796.48,
  • "nypAmount": 2796.48,
  • "priceCorrelationId": "550e8400-e29b-41d4-a716-446655440000",
  • "insuranceQuote": {
    },
  • "coverageAmount": {
    }
}

Listings

Create and manage furniture shipment listings. Listings represent shipment requests that carriers can bid on or accept at a fixed price.

Retrieve listing contacts

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

Authorizations:
Bearer
path Parameters
listingId
required
integer
Example: 12345

Required. listingId

Responses

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:
Bearer
path Parameters
listingId
required
integer
Example: 675712978

Required. The listing ID to retrieve tracking information for

Responses

Creating an IHD Listing

Authorizations:
Bearer
header Parameters
Content-Type
string

application/x-www-form-urlencoded

Request Body schema: application/json
required

Request body for v2 Listings POST request

title
required
string

Required. A title for the listing

description
string

A description for the listing

confidentialDescription
string

A confidential description only seen by the driver

object

Pricing information for a listing. Only one of these properties should be used

object

Amount of protection declared for shipment

required
object

Required. route

required
Array of objects

Required. items

requestedRateTypes
string
Array of objects

Reference numbers associated with the listing. When using Type='Other', you can provide a custom label via referenceNumberLabel which will be combined with the number value as '{referenceNumberLabel} - {number}' (max 60 chars total).

serviceTypes
Array of strings
Items Enum: "BlanketWrap" "LtlTransportOnly" "LtlFreightPackaging"

A list of requested service types for the shipment

gallery
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "Furniture Shipment",
  • "description": "White glove delivery of sectional sofa with blanket wrap protection",
  • "confidentialDescription": "675712978",
  • "pricing": {
    },
  • "insurance": {
    },
  • "route": {
    },
  • "items": [
    ],
  • "requestedRateTypes": "standard,expedited",
  • "referenceNumbers": [
    ],
  • "serviceTypes": [
    ],
  • "gallery": [
    ]
}

Response samples

Content type
application/json
{ }

Retrieves IHD listing by ID

Authorizations:
Bearer
path Parameters
listingId
required
number
Example: 12345

Required. ID provided when IHD listing is created

Responses

Response samples

Content type
application/json
{
  • "status": {
    },
  • "paymentStatus": {
    },
  • "transitStatus": {
    },
  • "isAuction": true,
  • "auctionTargetPrice": {
    },
  • "acceptedBidPrice": {
    },
  • "totalCost": {
    },
  • "bookingDeposit": {
    },
  • "priceDetails": {
    },
  • "commodity": "New Commercial Goods",
  • "parentCommodity": "Household Goods",
  • "topLevelCommodity": "Household Goods",
  • "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": [ ],
  • "referenceNumbers": [
    ],
  • "listingId": 675712978,
  • "title": "Boat motor parts",
  • "description": "",
  • "route": {
    },
  • "lister": {
    },
  • "items": [
    ],
  • "accessorials": [ ],
  • "totalWeightInGrams": {
    },
  • "links": [
    ]
}

Edits IHD listing by ID

Authorizations:
Bearer
path Parameters
id
required
integer
Example: 1

Required. ID of the listing to update

Request Body schema: application/json
required

Listing update model containing the fields to update

checksum
string

Checksum for concurrency control

title
string

Listing title

description
string

Listing description

object (RouteModel)

Container for route destinations and other route information

isAuction
boolean

Whether this listing is an auction

isDutchAuction
boolean

Whether this listing is a Dutch auction

object (PriceModel)

The details of a price and recommended formatting

object (PriceModel)

The details of a price and recommended formatting

items
Array of objects

Collection of listing items

Array of objects (EnumModel)

Service types for the listing

Array of objects (ReferenceNumber)

Reference numbers associated with the listing

object

Additional attributes for the listing

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

Responses

Request samples

Content type
application/json
{
  • "checksum": "a1b2c3d4e5f6",
  • "title": "Sectional Sofa - White Glove Delivery - Austin to Dallas",
  • "description": "White glove delivery of sectional sofa with blanket wrap protection",
  • "route": {
    },
  • "isAuction": false,
  • "isDutchAuction": false,
  • "namedPrice": {
    },
  • "offerPrice": {
    },
  • "items": [
    ],
  • "serviceTypes": [
    ],
  • "referenceNumbers": [
    ],
  • "attributes": {
    },
  • "isItineraryMandatory": false,
  • "importSource": "https://tms.example.com/orders/12345"
}

Delete IHD listing by ID

Authorizations:
None
path Parameters
listingId
required
integer
Example: 12345

Required. ID of the listing to delete

Responses

Bill of Lading

Retrieve Bill of Lading documents for booked shipments. The BOL serves as the official shipping contract between shipper and carrier.

Get the preSigned url for bill of lading

Authorizations:
Bearer
path Parameters
id
required
string
Example: 675712978

Required. The listing ID for which to retrieve the bill of lading

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

Required. Required Authorization header containing access token

Responses

Response samples

Content type
application/json
{}