Listing Items

 The listing items contain a title and description for the listing in addition to important data attributes that vary by commodity.

Field Type Description
title
String Each listing item has an optional title that returns when supplied.
commodity
Container

Wrapper for the listing item commodity fields.

  • "value": "CarsLightTrucks",
  • "label": "Cars & Light Trucks",
  • "shortLabel": "Cars & Light Trucks"

 

 

Commodities

 

Motorcycle

Field Description Sample Valid Values
groundClearanceInMeters
Wrapper for the data trio of the vehicle's ground clearance in meters.
  • title: "Ground clearance",
  • value: 0.127,
  • label: "5 in."
wheelbaseInMeters
Wrapper for the data trio of the wheel base in meters.
  • title: "Wheel Base",
  • value: 1.422,
  • label: "4 ft 8 in."
lengthInMeters

Wrapper for the data trio that describes the length of the car or light truck in meters.

  • "title": "Length"
  • "value": 2.057,
  • "label": "6 ft 9 in."
dryWeightInGrams
The weight of the motorcycle without anyconsumables, passengers, or cargo.
  • title: "Dry Weight",
  • value: 171910,
  • label: "379 lbs"
hasSidecar
  • true - Yes, the motorcycle has an attached sidecar.
  • false - No, the motorcycle does not have a sidecar.
  • title: "Sidecar",
  • value: true,
  • label: "yes"
isPalletized
  • true - Yes, the item is on a wooden or plastic pallet and can be moved by forklift.
  • false - No, the item is not on a pallet.
  • title: "Palletized",
  • value: false,
  • label: "No"
isRunning
  • true - Yes, the motorcycle is running or can be driven and in working order.
  • false - No, the motorcycle is not running and cannot be driven or moved on its own.
  • title: "Operational",
  • value: true,
  • label: "yes"
isTrike
  • true - Yes, the motorcycle has three wheels.
  • false - No, the motorcycle is not a three-wheel bike.
  • title: "Trike",
  • value: false,
  • label: "No"*
makeName**
Wrapper for the data trio of the motorcycle make.
  • title: "Make",
  • value: "Suzuki",
  • label: "Suzuki"
modelName**
Wrapper for the data trio of the motorcycle model.
  • title: "Model",
  • value: "GSX-1000",
  • label: "GSX-1000"
year**
Wrapper for the data trio of the motorcycle manufacture year.
  • title: "Year",
  • value: 2008,
  • label: "2008"
bodyType**
Wrapper for the data trio of the motorcycle body type.`
  • title: "Body Type",
  • value: touring,
  • label: "Touring"

** More information about year, make, model, and/or body types can be found here.

 

 

Cars and Light Trucks

Field

Description

Sample Valid Values
isConvertible
Wrapper for the fields that describe whether or not the vehicle has a top that can be put down.
  • "title": "Convertible",
  • "value": false,
  • "label": "No",
  • "shortLabel": "No"
isRunning
Wrapper for the fields that describe whether or not the vehicle can be driven.
  • "title": "Vehicle Runs",
  • "value": true,
  • "label": "Yes",
  • "shortLabel": "Yes"
isModified
Wrapper for the fields that describe whether or not the car or light truck has been changed or upgraded from its original manufactured state.
  • "title": "Modified",
  • "value": false,
  • "label": "No",
  • "shortLabel": "No"
lengthInMeters
Wrapper for the fields that describe the length of the car or light truck in meters.
  • "title": "Length",
  • "value": 4.089,
  • "label": "13 ft 5 in.",
  • "shortLabel":"13 ft 5 in."
widthInMeters
Wrapper for the fields that describe the width of the vehicle in meters.
  • "title": "Width",
  • "value": 1.524,
  • "label": "5 ft",
  • "shortLabel": "5 ft"
heightInMeters
Wrapper for the fields that describe the height of the vehicle in meters.
  • "title": "Height",
  • "value": 1.524,
  • "label": "5 ft",
  • "shortLabel": "5 ft"
description
Wrapper for the vehicle's description fields.
  • "title": "description",
  • "value": "description",
  • "label": "description",
  • "shortLabel": "description"
year**
Wrapper for the fields of the vehicle's manufacture year.
  • "title": "Year",
  • "value": 2015,
  • "label": "2015",
  • "shortLabel": "2015"
modelName**
Wrapper for the fields of the vehicle's model.
  • "title": "Model",
  • "value": "Fit",
  • "label": "Fit",
  • "shortLabel": "Fit"
makeName**
Wrapper for the fields of the vehicle's manufacturer.
  • "title": "Make",
  • "value": "Honda",
  • "label": "Honda",
  • "shortLabel": "Honda"
bodytype**
Wrapper for the fields of the vehicle's body type.
  • "title": "Body Type",
  • "value": "SUV",
  • "label": "SUV",
  • "shortLabel": "SUV"

** More information about year, make, model, and/or body types can be found here.

 

 

 

Small Studio Household Move

Field Type Description
typeOfResidence
Container

Wrapper for the kind of listing residence.

  • "title": "Type of Residence",            
  • "value": 2,            
  • "label": "Apartment"
numberOfBedrooms
Container

Wrapper for the number of bedrooms the listing covers.

  • "title": "Number of Bedrooms",            
  • "value": 2,            
  • "label": "2"
numberOfPickupStories
Container

Wrapper for the number of stories for the building where the shipment is picked up.

  • "title": "Pickup Number of Stories",            
  • "value": 2,            
  • "label": "2"
numberOfDeliveryStories
Container

Wrapper for the number of stories for the building where the shipment is delivered.

  • "title": "Delivery Number of Stories",            
  • "value": 2,            
  • "label": "2"

 

 

Additional Listing Objects

These objects match the commodity being shipped.

Field Type Description
serviceTypes
Array

Contains an array of the fields to list the types of service for the listing. For more information, see https://developer.uship.com/docs/read/apis/oauth/lookups/Service_Types.

value
String The name of the service type. Example: "MoverLoadingService" | "WhiteGlove"
label
String The localized name of the service type as displayed on the website or application. Example: "Mover, Loading Service" | "Premium Lieferservice"
shortLabel
String The localized name of the service type as displayed on a tablet or mobile device. Example: "Mover, Loading Service" | "Premium Lieferservice"

 

Field Type Description
totalWeightInGrams
Container Wrapper for the fields that describe the total weight of the shipment in grams.
value
Integer The total weight of the shipment in grams. Example: "12340"
label
String The localized value of the total shipment weight with corresponding units. Example: "27 lbs"
shortLabel
String The localized value of the total shipment weight with corresponding units. Example: "27 lbs"

 

 


Sample JSON

  "items": [
    {
      "title": "2008 Suzuki GSX-R1000",
      "commodity": {
        "value": "MotorcyclesMopeds",
        "label": "Motorcycles & Mopeds",
        "shortLabel": "Motorcycles & Mopeds"
      },
      "attributes": {
        "groundClearanceInMeters": {
          "title": "Ground Clearance",
          "value": 0.127,
          "label": "5 in."
        },
        "wheelbaseInMeters": {
          "title": "Wheel Base",
          "value": 1.422,
          "label": "4 ft 8 in."
        },
        "lengthInMeters": {
          "title": "Length",
          "value": 2.057,
          "label": "6 ft 9 in."
        },
        "dryWeightInGrams": {
          "title": "Dry Weight",
          "value": 171910,
          "label": "379 lbs"
        },
        "hasSidecar": {
          "title": "Sidecar",
          "value": true,
          "label": "Yes"
        },
        "isPalletized": {
          "title": "Palletized",
          "value": false,
          "label": "No"
        },
        "isRunning": {
          "title": "Operational",
          "value": true,
          "label": "Yes"
        },
        "isTrike": {
          "title": "Trike",
          "value": false,
          "label": "No"
        },
        "makeName": {
          "title": "Make",
          "value": "Suzuki",
          "label": "Suzuki"
        },
        "modelName": {
          "title": "Model",
          "value": "GSX-R1000",
          "label": "GSX-R1000"
        },
        "year": {
          "title": "Year",
          "value": 2008,
          "label": "2008"
        }
      }
    }
  ],