Boats

Create a listing to ship a Power Boat in the Boats category of the uShip marketplace.

 

POST

https://api.uship.com/v2/listings 

Sample Request Body


Required: Update the dates in this example so that they are at least one day ahead of the present date.

{
    "title": "Required (Power Boat Listing) Title",
    "description": "Provide optional details about the boat listing.",
    "route": {
        "items": [
            {
                "address": {
                    "streetAddress": "10155 Montague St",
                    "alternateStreetAddress": "Bldg 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/09/09",
                    "timeFrameType": "between"
                             }
            },
            {
                "address": {
                    "streetAddress": "1614 E Riverside Dr",
                    "majorMunicipality": "Austin",
                    "postalCode": "78741",
                    "stateProvince": "TX",
                    "country": "US",
                    "latitude": 30.234123,
                    "longitude": -97.718296,
                    "type": "BusinessWithLoadingDockOrForklift",
                    "timeZone": "America/Chicago" 
                },
                "timeFrame": {
                    "earliestArrival": "2014/09/09",
                    "latestArrival": "2014/09/09",
                    "timeFrameType": "on"
                 }
            }
        ]
    },
    "pricing": {
        "namedPrice": {
            "amount": 250,
            "currencyType": "USD"
        }
    },
    "items": [
        {
            "Title": "Power Boat Item Listing Title",
            "Commodity": "PowerBoats",
            "MakeModel": "1989 Sea Ray Sundancer",
    	    "LengthInMeters": 7.9248,
            "WidthIinMeters": 7.9248,
    	    "HeightInMeters": 7.9248,
            "WeightInGrams": 200200,    
            "onTrailer": true
        }
    ],
    "serviceTypes": [
            "OpenTransport", 
            "EnclosedTransport", 
            "FlatbedTransport", 
            "InWaterDelivery", 
            "OceanFreightContainer", 
            "TowAway"
                    ]
}

Response

Success Status: 201 Created

Response Header

Location header: https://api.uship.com/v2/listings/123456789 where the 123456789 is an example of {listingId} used in https://api.uship.com/v2/listings/{listingId}.


 

API Reference


Listing Object

Field Type Description Valid Sample Values
title
String Required. Brief descriptive name of the listing. "Bring Boats Home this Month"
description
String Longer explanation of the listing. "Bought several boats from out of state auction to bring home."
serviceTypes
Array The service types requested for this listing. See #ServiceTypes table below. Retrieve a list of available service types for boats via GET https://api.uship.com/v2/lookups/serviceTypes/. 
"OpenTransport", "EnclosedTransport" 

Commodity Object

Field Type Description
items
Array List of boat objects.
title
String Required. Descriptive title for the listing item.
commodity
String Use "PowerBoats", "SailBoats" or "OtherBoats" to create the specific kind of boat listing.
makeModel
String

The boat's manufacturer and model and the year the boat was made. The make and model should match.

LengthInMeters
Decimal The length of the boat in meters.
WidthInMeters
Decimal The width of the boat in meters.
HeightInMeters
Decimal The height of the boat in meters.
WeightInGrams
Decimal The total weight of the boat in grams.
onTrailer
Boolean
  • true - Yes, the boat is on a trailer.
  • false - No, the boat is not on a trailer.

Pricing Object

Specify pricing with a named price. If the listing goes through auction, do not include this object.

Field Type Description Valid Sample Values
namedPrice
Container Wrapper for the pricing fields -
amount
String How much will this/these boats be listed to ship? $2000
currencyType
Array The type indicated by the code that corresponds to the country and currency name. Currency Lookups has the most current list. "USD"

Route Origin or Destination Address Object

See Route Object reference.

 

Reference Enumerations


Address Types

You can also use the Address Types Lookup by providing the commodityCode parameter. See Address Type Lookups on https://developer.uship.com/io-docs.

Address Type Value Localized Label (EN-US)
Residence Residence
BusinessWithLoadingDockOrForklift Business (with loading dock or forklift)
BusinessWithoutLoadingDockOrForklift Business (without loading dock or forklift)
Port Port
ConstructionSite Construction Site
TradeShowOrConvention Trade Show / Convention Center
StorageFacility Storage Facility
MilitaryBase Military Base
Airport Airport
OtherSecuredLocation Other Secured or Limited Access Location

Service Types

You can also use the Service Types Lookup by providing the commodityCode parameter. See Service Types Lookup on https://developer.uship.com/io-docs and https://developer.uship.com/docs/read/apis/oauth/lookups/Service_Types for more information.

Service Type Value Description
Open Transport "OpenTransport"

Open Transport service offers the standard level of care boat transport. The Service Provider will carefully load your boat onto an open trailer that they provide and will tow the trailer to the delivery location and unload your boat.

Enclosed Transport "EnclosedTransport" Enclosed Transport service offers a premium level of care for overland boat transport. The Service Provider will carefully load the boat into an enclosed trailer that is protected from the elements and road debris. The Service Provider will tow the trailer to the delivery location and unload the boat. This service is commonly used for rare or high-value boats or for transport through extreme climates. Since the boat has to fit completely within a truck trailer, this service is only available for smaller boats, with a beam of approximately 8' or less.

Flatbed Transport Service

"FlatbedTransport"

Flatbed Trailer service is commonly used for boats that are too large for standard boat trailers and also for smaller boats on trailers in cases where the boat owner does not want to put any mileage on their trailer. The customer generally arranges lifting/loading of the boat separately through a boatyard or marina. The Service Provider assists with the rigging and tows the trailer to the delivery location.

In-water Delivery Service "InWaterDelivery"

In-Water Delivery is a basic level of service where the Service Provider captains the boat to be transported on the water to the destination. This service is useful for moving large boats, transporting a boat internationally and for shipments with a practical water route where the customer does not mind the extra wear on the boat. The price varies depending on the size of the boat, the crew required and the number of days for the trip.

Ocean Freight Container Service "OceanFreightContainer"

Container service is used to transport boats overseas in standard shipping containers. The Service Provider arranges for the boat to be loaded into a container, secured and crane-loaded onto the ship. Since the boat must fit within a container, it must have a beam of less than 8'.

Tow-Away Service "TowAway"

Tow-Away Service is the base level of service for boat transport. The Service Provider will use their truck to tow your boat and trailer to the destination. This service is only for legal trailers and boats that are roadworthy for the trip.

 

Example


To get an idea of shipment creation, here is an example of how to create a Power Boat listing in the Boats category on uship.com.

Create a Power Boats Listing in the uShip Marketplace