User Profile

Retrieve a User's uShip Profile

Users rely on the uShip marketplace profiles to make informed decisions about whether to interact with a Shipping Customer or Service Provider.

For example, Shipping customers want to be able to feel that they trust the person they are about to send their valuable goods with - to help foster a sense of trust, it is important to provide information about yourself or your business in your Profile section of your My uShip page.

Your My uShip page is literally your one-stop shop for managing your entire uShip business and can be accessed from any computer that has the internet by simply typing: my.uship.com.

On your profile page you can enter a picture of yourself, view feedback left, and add valuable information for shipping customers such as your licensing, insurance, and other qualifications you have. Don't skimp here - it is very, very important.

Example from uShip Web

Sample uShip User Profile - Web

Sample JSON Output

GET URI https://api.uship.com/v2/users/{userId}/profile

The GET returns a read-only JSON body with the specified user ID's profile. Obtain the user ID parameter from the GET Index API (GET https://api.uship.com/v2/).

Response

Here is the current API Reference documentation

User Summary Object
Field Type Description Sample Valid Value
userId
Integer Identifier for the user whose profile is returned. 123456789
displayName
String This text string is the name marketplace users will see on your uShip profile. For example, this user's display name is "TexasCowgirl" which is displayed on their public profile page http://www.uship.com/profile/texascowgirl/   "TexasCowgirl"
imageUrl
String

This is the primary profile image that the marketplace will see when they view the profile. Service providers with pictures are 38% more likely to win a bid, so include photos of yourself and your equipment in your profile. Uploading 3 pictures adds up to 8% towards completing your profile. Your pictures cannot contain direct contact information.

"http://link.jpg"
Feedback Object
Field Type Description Sample Valid Value
count
Integer The total number of feedback entries available for this user. 500
percentPositive
Decimal The percentage of positive ratings for this user out of 100%. 200.0
starRating
Decimal The average number of stars out of the total stars received for this user. One star being the lowest and five stars being the highest rating. 5.0
Hypermedia Link Object

For more information about how hypermedia links work in the uShip API, visit Hypermedia Links.

Field Type Description Sample Valid Value
rel
String This field describes which object the link is related to such as the ability to complete a function in a certain context. This reference is one of the possible actions that can be done. "Item"
verb
String

This field is the HTTP verb associated with the possible action that can be done. 

  • GET - Retrieve an object or array of objects.
  • PUT - Update an existing object or array of objects.
  • POST - Create a new instance of an object or array of objects.
  • DELETE - Remove an object or array of objects.
"GET"
href
String This hypermedia reference attribute specifies the URL of the page link destination. This reference link suggests what actions are possible.  "/v2/users/123456789/profile"
title
String The descriptive name of the possible action. "profile"
Additional
Field Type Description Sample Valid Value
about
String A user would create a biography relevant to the type of activity they are engaged with on the marketplace. For example, a Service Provider would might describe when they started providing service and give general background to provide a potential Shipping Customer confidence in choosing their services.

In honor of Roy Garber on Shipping Wars on A&E...

In Roy's profile for Arbies Team Transportation, the about section introduces themselves "We are Arbie’s Team Transport. We are a family-owned company that provides superior service to customers. We specialize in transporting personal belongings, household goods, vehicles, motorcycles, equipment and much more. We guarantee personal service, and the safety of your property is our main concern. We also specialize in custom and classic vehicles, expensive motorcycles, valuable art and antiques. We’re fully DOT and MC compliant. I am a world-class handyman, and I have successfully handled dozens of shipments on uShip. My determination and work ethic have made me one of the top, independent transporters in the country."

http://www.uship.com/profile/arbiesteam/

mcNumber
String This field only appears when relevant to a user type. The operating authority (MC/FF/MX number) is assigned to interstate for-hire motor carriers and brokers that apply for operating authority. These numbers are also referred to as docket numbers. The FF number is assigned to freight forwarders; the MX number is assigned to carriers domiciled in Mexico; and the MC number is for all other carriers and brokers.The motor carrier   The MC number is issued by the Federal Motor Carrier Safety Administration (FMCSA). Verify the Carrier's MC number at http://www.safersys.org/. "123456"
dotNumber
String This field only appears when relevant to a user type. The USDOT number is the number that the FMCSA assigns to each motor carrier that starts interstate operations in the United States. The USDOT number must be marked on all of an organization's vehicles.The U.S. Department of Transportation number is issued by the Federal Motor Carrier Safety Administration (FMCSA).  Verify the Carrier's USDOT number at http://www.safersys.org/. "1234567"
trackingEnabled
Boolean
  • true - This field appears if GPS tracking is enabled for a Service Provider. If the user is a Service Provider, the responsible party must have reported a location within 24 hours.
  • false - This field does not appear if GPS tracking is disabled.
true
createdOn
String The date and time in UTC when the user first created the profile.

"2013-01-15T18:39:43Z"

userType
Container Wrapper for profile user's user type(s). -
value
String

A user type defines the roles that can interact in the marketplace.

Valid values:

  • Affiliate
  • Broker
  • ServiceProvider (such as a Broker or a Carrier who completes actual shipments)
  • Shipper (that is, the customer who has a shipping need)
  • ShipperAndServiceProvider - A hybrid role, the user chooses which role to complete relevant actions.
"ShipperAndServiceProvider"
label
String The localized name for the user type. "Shipper & Service Provider" | "Versandkunde & Spediteur"
shortLabel
String

Grouped with the user Type data pair. This field appears with all current value/label pairs and is intended for mobile application and mobile responsive consumers. The shortened labels display on smaller screens and defaults to "label" with shortened content if the "shortLabel" is unavailable.

 

This field is intended for mobile application and mobile responsive consumers.

"Shipper & Service Provider" | "Versandkunde & Spediteur"
status
Container Wrapper for the specified user's current status. -
value
String

The specified user's current status. Held and suspended users can still log in but are limited in capability. In general, they cannot change data.

Valid Values:

  • "Active"
  • "Held"
  • "Suspended"
"Active" 
label
String The localized name of the profile user's current status. "Active" |  "Actif"  (French example) | "Aktiv" (German example)
shortLabel
String Grouped with the user status data pair. This field appears with all current value/label pairs and is intended for mobile application and mobile responsive consumers. The shortened labels display on smaller screens and defaults to "label" with shortened content if the "shortLabel" is unavailable. "Active"  |  "Actif" | "Aktiv"
images
Array This array of image files are the additional images on the profile page. Any of the four maximum images could be designated as the main profile image. ["http://image.jpg", "http://image.jpg", "http://image.jpg"]

 

Badges Array


Available options explained including how a badge would return in the response. This object will not return if the contents are empty. Use "None" to indicate not showing any badges on a profile.

Badge Data Trio Object

Field Type Description
value

String

The badges user profile has earned. See valid values in the table below.

label
String The localized name of the profile user's badge name.
shortLabel
String This field in intended for mobile application and mobile responsive consumers.

Badge Values

Tablet and mobile developers: We've included a few German (accept-language header: DE) to show longer localized values in case you need to decide how to accommodate for them on your UI. The order of this badge list is how the badges will appear when they are available with the first badge appearing above the next and so on.

Power Carrier Badges

The Power Carrier program rewards uShip’s elite carriers based on the quality and volume of service they provide on the site. To learn more, visit http://www.uship.com/learnmore/powercarrierlearnmore.aspx.

Badge Name
Valid String Corresponding Label Examples
Description (Subject to change.)
Power Carrier at the Bronze Tier
"BronzePowerCarrier" "Bronze Power Carrier" A Power Carrier whose average three month match volume is $,1000.
Power Carrier at the Silver Tier  "SilverPowerCarrier" "Silver Power Carrier" A Power Carrier whose average three month match volume is $4,000.
Power Carrier at the Gold Tier  "GoldPowerCarrier" "Gold Power Carrier" A Power Carrier whose average three month match volume is $6,000.
Power Carrier at the Platinum Tier  "PlatinumPowerCarrier"  "Platinum Power Carrier" A Power Carrier whose average three month match volume is $10,000.
Power Broker Badges

The Power Broker program rewards uShip’s elite brokers based on the quality and volume of business they conduct on the site. To learn more, visit http://www.uship.com/learnmore/powerbrokerlearnmore.aspx.

Badge Name
Value Label Example Description
 Power Broker at the Bronze Tier
"BronzePowerBroker" "Bronze Power Broker" A Power Broker who posts and books 10 loads a month is in this tier. The Bronze Power Broker badge appears.
 Power Broker at the Silver Tier  "SilverPowerBroker"  "Silver Power Broker" A Power Broker who posts and books 25 loads a month is in this tier. The Silver Power Broker badge appears.
 Power Broker at the Gold Power Tier  "GoldPowerBroker"  "Gold Power Broker" A Power Broker who posts and books 50 loads a month is in this tier. The Gold Power Broker badge appears.
 Power Broker at the Platinum Tier  "PlatinumPowerBroker"  "Platinum Power Broker" A Power Broker who posts and books 100 loads a month is in this tier. The Platinum Power Broker badge appears.
Additional Badges

description

Badge Name
Value Label Example Description
uShip Tracking
"GpsTracking" "uShip Tracking: From GPS" The user allows tracking using GPS. See http://www.uship.com/tracking for details.
uShip Status Updates with Location "UserTracking" "uShip Tracking: From User"
The user provides manual updates to uShip. See http://www.uship.com/tracking for details.
SaferWatch Monitored  SaferWatch Monitored "SaferWatchMonitored" "SaferWatch Monitored" | "SaferWatch verifiziert sein" SaferWatch is a third-party service that monitors the authority, insurance and business information from your uShip account matched with FMCSA records. SaferWatch constantly monitors this information for changes and syncs any FMCSA updates with your uShip account. To learn more, visit http://www.uship.com/learnmore/saferwatchlearn.aspx.
 Member of the Month  "MemberOfTheMonth" "Member of the Month: December 2008" | Mitglied des Monats: Dezember 2008" This honor can be obtained more than once. The most recent badge is returned from the API. To learn more, visit http://www.uship.com/community/driverofthemonth.aspx.
Charitable Shipper "CharitableShipper" "Charitable Shipper" This badge denotes that the Service Provider has transported charitable shipments either for free or at a discount and earned valuable feedback points from the community. To learn more, visit http://about.uship.com/highway-to-help/.
Ritchie Bros. Preferred "RitchieBrosPreferred" "Ritchie Bros. Preferred Service Provider" | "Von Ritchie Bros. bevorzugter Spediteur" This user profile is a Service Provider preferred by Ritchie Bros. To learn more, visit https://www.rbauction.com/buying/online-shipping-service.
Mliitary Verified "TroopIdVerified" "Military Verified" This user is eligible for the military benefits in the Troop ID program. To learn more, visit http://www.uship.com/learnmore/troopidlearn.aspx.
Facebook Connected "FacebookConnected" "Connected" | "Verbunden" The user has linked his or her account to sign in via Facebook.
TerraPass Certified Green Provider Program "Terrapass" "Green Provider—certified by TerraPass" | "Green Provider—zertifiziert durch TerraPass" By signing up for TerraPass, you’ll help sponsor clean energy projects that balance out the global warming impact of your services. The program is easy, affordable, and verified. Best of all, uShip will pay your first month. To learn more, visit http://www.uship.com/terrapass.aspx.