Direct Furniture Integrations Guide
Furniture shippers can take advantage of the uShip API to instantly get competitive listing prices based on the dimensions of a single item or a multi-item shipment with the same origin and destination.
For the endpoint-specific documentation on our listing endpoints, please see our Furniture Integrations API reference.
How it works
- Create a UI test account in our sandbox site.
- Generate your sandbox API key here - Use key in headers as Bearer {value}
- Get your fixed price based on your item's dimensions and weight with
POST https://apisandbox.uship.com/v2/fixedprice - Create your listing with
POST https://apisandbox.uship.com/v2/listings(ListingID found in Response Headers under "Location") - Add images to your listing with
POST https://apisandbox.uship.com/v2/listings/{listingid}/images - Retrieve your listing with
GET https://apisandbox.uship.com/v2/listings/{listingid} Track your listing with GET https://apisandbox.uship.com/v2/listings/{listingid}/track
Rates and Price Correlation ID
In order to obtain a rate, you will need to POST /v2/fixedprice using the Bearer token you retrieved here. For details on these fields, their values and examples, please see our reference guide here.
Once you have successfully posted your rate request, you will receive a response with your price and the price correlation ID. Please ensure that your price correlation ID is included in your listing creation API. For an example of how to do so, please see the "referenceNumbers" value at the end of the Sample Listing Request Body below.
For more information on reference numbers in general, please see Reference Numbers.
When using Fixed Price Endpoint for customer facing rates and listing, the following is suggested.
When exposing rates to your customer we suggest using the "Price" field as this field will incorporate the uShip Fee. If uShip Protection Plan has been selected you'd add the premium amount as well (Price + insurance.premium.amount)
When creating the listing on uShip we suggest using the "nypAmount" returned in the fixed rate response. This price does NOT contain the uShip fee. When finalizing the booking on uShip the uShip fee will be added and you'll be able to add the uShip Protection Plan.
For any questions about this, please reach out to api-support@uship.com
Sample Rating Request/Response Body
{ "destinationPostalCode":"30060", "items":[ { "heightInMeters":1.27, "lengthInMeters":1.778, "unitCount":1, "weightInGrams":100967, "widthInMeters":1.27 } ], "originPostalCode":"94965", "source":"apitest"}Sample Rating Request/Response Body with uShip Protection
{ "destinationPostalCode": "78336", "items": [ { "heightInMeters": 1.27, "lengthInMeters": 1.778, "unitCount": 1, "weightInGrams": 100967, "widthInMeters": 1.27 } ], "originPostalCode": "78758", "source": "Test Integrator", "originCountryCode": "US", "destinationCountryCode": "US", "commodity": "Furniture", "insurance": { "coverageAmount": { "amount": 4000.00, "currencyType": "USD", "commodity": "Furniture" } }}Sample Listing Request Body
POST[https://api.ushipsandbox.com/v2/listings/](https://api.ushipsandbox.com/v2/listings/)
{ "title": "Required (Furniture Listing) Title", "description": "Provide optional details about the furniture listing.", "route": { "items": [{ "address": { "streetAddress": "10155 Montague St", "alternateStreetAddress": "Building 2, Suite 100", "majorMunicipality": "Tampa", "postalCode": "33626", "stateProvince": "FL", "country": "US", "latitude": 28.056858, "longitude": -82.605871, "type": "Residence", "timeZone": "America/New_York" }, "timeFrame": { "earliestArrival": "2014/08/08", "latestArrival": "2014/08/10", "timeFrameType": "between" }, "contact": { "name": "Jeremy Clinton", "companyName": "Furniture LLC", "phoneNumber": "25678345678", "email": "google@gmail.com", "firstName": "Cody", "lastName": "Holdin" } }, { "address": { "streetAddress": "1614 E Riverside Dr", "majorMunicipality": "Austin", "postalCode": "78741", "stateProvince": "TX", "country": "US", "latitude": 30.234123, "longitude": -97.718296, "type": "BusinessWithLoadingDockOrForklift", "timeFrame": "America/Chicago" }, "timeFrame": { "earliestArrival": "2014/08/11", "latestArrival": "2014/08/12", "timeFrameType": "before" }, "contact": { "name": "Mark Campbell", "companyName": "Furniture LLC", "phoneNumber": "25678905678", "email": "mark@gmail.com", "firstName": "Mark", "lastName": "Campbell" } }] }, "pricing": { "namedPrice": { "amount": 300, "currencyType": "USD" } }, "items": [ { "Title" : "Title of the specific item especially if there are multiple items.", "Commodity" : "Furniture", "widthInMeters" : 1.524, "lengthInMeters" : 1.397, "heightInMeters" : 1.041, "weightInGrams" : 38100, "unitCount" : 2, "Description" : "Details about the furniture item." }], "attributes": { "crated": true, "stackable": true, "palletized": true }, "serviceTypes": [ "BlanketWrap", ], "referenceNumbers": [ { "number": "6a8a7b9d-68e3-4ebc-9f26-4b3bfa7688b5", "type": 10 //don't change type text, 10 designates price correlation id }] }Retrieving Your Listing
GET https://api.ushipsandbox.com/v2/listings/{listing_id}
Sample Response
{ "status": {}, "namedPrice": {}, "offerPrice": {}, "commodity": "Furniture", "parentCommodity": "Household Goods", "topLevelCommodity": "Household Goods", "expiresOn": "2019-09-24T04:59:59Z", "imageUrl": "https://staging.uship.com/public/images/icons/categories/114x138/1_114x138.png", "isDefaultImage": true, "checksum": "f28c5bd1a0181247", "createdOn": "2019-09-23T20:38:31Z", "activatedOn": "2019-09-23T20:38:31Z", "lastUpdatedOn": "2019-09-23T20:38:31Z", "minimumBidAmount": {}, "quoteRequestId": "5d892d47528015110051961a", "commodityType": {}, "parentCommodityType": {}, "topLevelCommodityType": {}, "serviceTypes": [], "listingId": 185798798, "title": "Marble Top Side Table B-5940546", "description": "**PLEASE CONFIRM YOU HAVE READ THESE DETAILS IN BID**:\r\n- Pickup is between 10:00 AM-5:00 PM Mon-Fri \r\n- Pickup is from a warehouse, ground level, no loading dock. \r\n- You MUST be able to load and unload the item(s) without the assistance of our employees or our customers. \r\n- You MUST use the BOL which can be found in My Shipments under the Assigned Tab. Print the BOL and fill out the necessary information. \r\n- You MUST make contact with the delivery customer at least 24 hours in advance. If you deliver an item less than 24 hours from pickup without the customer’s approval, you will not be paid in full. \r\n- Items can not be left outside unless consent is given from the customer. \r\n- Customers should be contacted between 7:30am-8:30pm based on the delivery timezone. \r\n- An enclosed trailer, box truck, or sprinter van is required for ALL deliveries.\r\n- Threshold delivery.\r\n- IF ANY OF THESE REQUIREMENTS ARE NOT MET, WE WILL NO LONGER BE ABLE TO WORK TOGETHER.\r\n*(please note that all weights are estimated)", "route": {}, "lister": {}, "items": [], "totalWeightInGrams": {}, "attributes": {}, "links": []}Tracking Shipment
GET https://api.ushipsandbox.com/v2/{listingId}/track
{ "listingGeneratedId": 256521587, "listingTitle": "Large Dresser", "commodityCode": "Antiques", "shipmentTrackingSummaryModel": {}, "carrierContactModel": {}, "shipmentTrackingStatuses": []}