API docs by Redocly

uShip Furniture API Reference (v2)

Download OpenAPI specification:

E-mail: mfort@uship.com

Our Furniture APIs provide a way to seamlessly integrate authentication, rate retrieval, listing your shipment, and retrieving tracking events and data. For the differences between this direct integration and our Shopify integration, please see our Furniture and Home API Guide. For the request body, order of operations, and more details on listing furniture directly via API, please see our Direct Furniture Integrations guide. Please use https://apisandbox.uship.com for your sandbox/staging environment and https://api.uship.com for production.

Authentication

Our API now uses a Self Service API Key instead of OAuth tokens. Users who want to get an API key must navigate to a certain web page to get their Self Service API Key.

To obtain your Self Service API Key:

  1. Navigate to API Key Generation Page.
  2. Follow the instructions to obtain your Self Service API Key.
  3. Include the Self Service API Key in the Authorization header as a Bearer token for all requests: Authorization: Bearer <Self Service API Key>.

transit status changed webhook Webhook

Authorizations:
Bearer
Request Body schema: application/json

Information about the booked transit status change

specversion
string
Value: "1.0"

The version of the CloudEvents specification which the event uses. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#specversion

source
string <uri>

Identifies the context in which an event happened. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#source-1

id
time
string <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
Value: "Shipment.TransitStatusChanged/v1"

Type of event related to the originating occurrence. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#type

object

Responses

Request samples

Content type
application/json
{
  • "specversion": "1.0",
  • "source": "http://example.com",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "time": "2019-08-24T14:15:22Z",
  • "type": "Shipment.TransitStatusChanged/v1",
  • "data": {
    }
}

Fixed Price

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

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

Origin zip code

destinationPostalCode
required
string

Destination zip code

required
Array of objects
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": "string",
  • "insurance": {
    },
  • "originPostalCode": "string",
  • "destinationPostalCode": "string",
  • "items": [
    ],
  • "userId": "string",
  • "priceCorrelationId": "string",
  • "commodity": "string",
  • "originCountryCode": "string",
  • "destinationCountryCode": "string"
}

Response samples

Content type
application/json
{
  • "price": 0,
  • "nypAmount": 0,
  • "priceCorrelationId": "360d80fc-b677-4f86-b086-c436ed17ed2f",
  • "insuranceQuote": {
    },
  • "coverageAmount": {
    }
}

Listings

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

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
header Parameters
client_id
required
string

The unique ID provided to you by uShip for integrating

client_secret
required
string

The unique ID secret provided alongside your client ID by uShip

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

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
Array of objects
requestedRateTypes
string
Array of objects
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": "string",
  • "description": "string",
  • "confidentialDescription": "string",
  • "pricing": {
    },
  • "insurance": {
    },
  • "route": {
    },
  • "items": [
    ],
  • "requestedRateTypes": "string",
  • "referenceNumbers": [
    ],
  • "serviceTypes": [
    ],
  • "gallery": [
    ]
}

Response samples

Content type
application/json
{ }

Retrieves IHD listing by ID

Authorizations:
Bearer
path Parameters
listingId
required
number

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": "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": [
    ]
}

Edits IHD listing by ID

Authorizations:
Bearer
path Parameters
id
required
integer

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": "string",
  • "title": "string",
  • "description": "string",
  • "route": {
    },
  • "isAuction": true,
  • "isDutchAuction": true,
  • "namedPrice": {
    },
  • "offerPrice": {
    },
  • "items": [
    ],
  • "serviceTypes": [
    ],
  • "referenceNumbers": [
    ],
  • "attributes": {
    },
  • "isItineraryMandatory": true,
  • "importSource": "string"
}

Delete IHD listing by ID

Authorizations:
None
path Parameters
listingId
required
integer

ID of the listing to delete

Responses

Bill of Lading

Get the preSigned url for bill of lading

Authorizations:
Bearer
path Parameters
id
required
string
header Parameters
Authorization
required
string

Required Authorization header containing access token

Responses

Response samples

Content type
application/json
{
  • "billOfLadingNumber": 0,
  • "document": {
    }
}