Index

GET

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

Returns a read-only JSON body with the active (logged in) user's information.

 


Response

To see this in action, go to the API Explorer (https://developer.uship.com/io-docs) and "Try it" for a dynamic response.

{
	"userName": "JaneSmith",
	"firstName": "Jane",
	"lastName": "Smith",
	"companyName": "Acme Service Provider, LLC",
	"shippingAddress": {
		"stateProvince": "FL",
		"stateProvinceLabel": "Florida",
		"country": "US",
		"countryLabel": "United States",
		"latitude": 25.784853,
		"longitude": -80.144731,
		"label": "Miami, FL",
		"shortLabel": "Miami, FL"  
},
"homePhone": "5555555555",
"homePhoneExt": "123",
"mcNumber": "123456",
"dotNumber": "1234567",
"emailAddress": "jane@acme.com",
"status": {
	"value": "Active",
	"label": "Active",
	"shortLabel": "Active"
},
"userType": {
	"value": "ShipperAndServiceProvider",
	"label": "Shipper & Service Provider",
	"shortLabel": "Shipper & Service Provider"
},
"entityType": {
        "value": "Carrier",
        "label": "Carrier",
        "shortLabel": "Carrier"
},  
"facebookLinked": true,   
"userId": 123456789,
"displayName": "Acme Service Provider",
"imageUrl": "http://resourcesdev.acme.com/resize.php?path=/static/users/fd7ef858-91b4-4077-8.jpg",
"feedback": {
	"count": 11,
	"percentPositive": 100,
	"starRating": 5
	   },
"links": [
	{
         "rel": "Item",
         "verb": "GET",
         "href": "/v2/users/{userId}/profile",
         "title": "profile"
        }
     ]       
}                              

API Reference


Field Type Description Sample Valid Values
userName
 String  The user name of the active user currently authenticated to make an API call (or logged in on uShip.com, for example).  "JohnSmith" or "jsmithattransportco"
firstName
  String The first name of the active user. "John"
lastName
  String The last name of the active user. "Smith"
companyName
  String If the user is associated with a company and provides the name, the company name is returned. "ABC Transport Company"
shippingAddress
 Container Wrapper for the address fields. The user supplies this information when registering. -
stateProvince
  String The two-letter postal state or province abbreviations. "FL", "TX"
stateProvinceLabel
  String The localized name of the state or province if the locale has a relevant region value. "Florida", "Texas",
"Aberdeen City" 
country
String The abbreviated country name. "GB", "US"
countryLabel
String The full localized name of the country name. "Europa", "Europe", "États-Unis"
latitude
Decimal The geographical latitude of the locale in decimal degrees. This field will not always return such as for international locations that we do not currently support. 30.244144
longitude
Decimal The geographical longitude of the locale in decimal degrees. This field will not always return such as for international locations that we do not currently support. -97.76286
label
String The full localized name for the region which is the most specific when geocoded.  "Austin, TX" and for "Aberdeen City" the label is "Cambridge, GBR"
shortLabel
String Grouped with the company address data set. 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. "Austin, TX" and for "Aberdeen City" the label is "Cambridge, GBR"
homePhone
String The residential telephone number of the currently active user. "1-313-849-9906"
homePhoneExt
String If available, this field is the additional set of numbers to enter after dialing the phone number. "224"
mcNumber
String 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 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"
emailAddress
String The active user's email address. "john@acme.com"
status
Container Wrapper for the user's current status.  -
value
String

The 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 user's current status.  "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.  "Actif"  (French example), "Aktiv" (German example)
userType
Container Wrapper for the active user's user type value pair.  -
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 customer with shipping need, ShipperAndServiceProvider hybrid role
"ShipperAndServiceProvider"
label
String The localized name for the user type. "Shipper & Service Provider", "Expéditeur & Transporteur" (French example), "Versandkunde & Spediteur" (German example)
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. "Shipper & Service Provider"
entityType
Container Please contact us at api-support@uship.com if you wish to create a user other than a carrier. Wrapper for the value, label, and shortLabel. "Carrier"
facebookLinked
Boolean
  • true - This user account is linked to the user's Facebook account.
  • false - This user account is not linked to the user's Facebook account.
userId
Integer The active user's system-generated identifier.

650760272

displayName
String The name that displays in the marketplace for the active user. Generally, this is the user's company name.  If the account doesn't have a company name, the username appears. "ABC Transport Company"
imageUrl
String

The web address or server path where the active user's profile image is stored.

feedback
Container Wrapper for the feedback fields that determine a user's marketplace ratings through uShip.  -
count
Integer The total number of feedback entries available for this user. The count is important to consider with the ratio of feedback types received. For example, if a Service Provider has hundreds or thousands of feedback ratings and most of them are positive, this is a strong indication that they have a good record with Shippers who have used their services through the uShip marketplace. 15, 80, or 455
percentPositive
Decimal The percentage of positive ratings for this user out of 100%.  97.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. 4.8

links
Hypermedia Array The relevant hypermedia link objects for the user.