Cars and Light Trucks

Create a listing to ship a Cars and Light Trucks item in the Vehicles 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 (Cars & Light Trucks Listing) Title",
    "description": "Provide optional details about the vehicle listing.",
    "status": "Saved",
    "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": "after"
                             }
            },
            {
                "address": {
                    "streetAddress": "1614 E Riverside Dr",
                    "majorMunicipality": "Austin",
                    "postalCode": "78741",
                    "stateProvince": "TX",
                    "country": "US",
                    "latitude": 30.234123,
                    "longitude": -97.718296,
                    "type": "BusinessWithLoadingDockOrForklift"
                },
                "timeFrame": {
                    "earliestArrival": "2014/09/09",
                    "latestArrival": "2014/09/09",
                    "timeFrameType": "on"
                 }
            }
        ]
    },
    "pricing": {
        "namedPrice": {
            "amount": 250,
            "currencyType": "USD"
        }
    },
    "items": [
        {
            "Title": "CLT Item Listing Title",
            "Description": "2008 Honda Pilot", 
            "Commodity": "CarsLightTrucks",
            "Year": 2008,
            "MakeName": "Honda",
            "ModelName": "Pilot",
            "IsRunning": true,
            "IsConvertible": false,
            "IsModified": false
        }
    ],
    "serviceTypes": ["OpenTransport", "EnclosedTransport"]
}

 

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 Cars Home this Month"
description
String Longer explanation of the listing. "Bought several cars from out of state auction to bring home."
status
String Allows the listing to be created as "Saved".  Will later need to be activated in order to receive bids. "Saved", null
serviceTypes
Array The service types requested for this listing. See ServiceTypes table below. or use GET https://api.uship.com/v2/lookups/serviceTypes/. 
"Driveaway",
"OpenTransport", "EnclosedTransport" 

Commodity Object

Field Type Description
items
Array List of car and light truck objects.
title
String Required. Descriptive title for the listing item.
description
String Additional description of the listing item.
commodity
String Required. Use "CarsLightTrucks" to create vehicle listings.
VIN
String Required if year, makeName, and modelName are absent.  Overrides provided year, make, and model.
year
Integer Required if VIN is absent.  The year the car or truck was made.
makeName
String Required if VIN is absent.  The vehicle's manufacturer.
modelName
String Required if VIN is absent.  The vehicle's model name. The make and model should match.
isRunning
Boolean
  • true - Yes, the vehicle is running or can be driven and in working order.
  • false - No, the vehicle is not running and cannot be driven or moved on its own.
isConvertible
Boolean
  • true - Yes, the vehicle has a top that can be put down.
  • false - No, the vehicle does not have a top that can be put down.
isModified
Boolean
  • true - Yes, the vehicle has been changed or upgraded from its original manufactured state.
  • false - No, the vehicle is in its original manufactured state.

Pricing Object

Optional. 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 vehicles 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

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

Also available via a Lookup API call.

Service Type Value Description
Open Transport Service "OpenTransport" This service offering is the standard level of care for vehicle transport. The Service Provider will carefully load the vehicle onto an open trailer, generally along with other vehicles, and secure it for transport. The Service Provider will tow the trailer to the delivery location and unload the vehicle. "Top Load" placement protects the vehicle from road debris and leaks from other cars in transit. This placement and other upgrades may be available for an additional fee.
Enclosed Transport Service "EnclosedTransport" This service offering is a premium level of care for vehicle transport. The Service Provider will carefully load the vehicle onto an enclosed trailer that is protected from the elments and road debris. The Service Provider will tow the trailer to the delivery location and unload the vehicle. The premium service is commonly used for rare or high-value vehicles or for transport through extreme climates.
Driveaway Service "Driveaway" This service offering is the most basic level of vehicle transport service. The Service Provider drives the vehicle to the destination. No other equipment is used for the transport job, which keeps costs to a minimum. This service is a good option for customers that require affordable vehicle transport and do not mind the additional mileage on their vehicle.
Other "Other"