Lister

The lister object exists on most models related to bids, listings, and rate requests.

Field Type Description
userId
Integer Identifier of the Shipper or Service Provider (user) who created the listing.
displayName
String

The name that displays on uShip for the active user.

  • For a Shipper, either their first name and the first initial of their last name or their username appears.

  • For a Broker, either their company name or their username appears.
feedback
Container Wrapper for uShip ranking fields. Can be null.
count
Integer The total number of feedback entries available for this user. 
percentPositive
Decimal The percentage of positive ratings for this user out of 100%. 
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.
acceptanceRate
Double Will only return for a ServiceProvider who is eligible to bid. This feedback field is the ratio of accepted bids versus total bids.
links
Array

Hypermedia links suggest what the user can do next in the relevant context. For this method, after retrieving listings, for each listing, you can retrieve the user's profile.

 

{
    "rel": "Item",
    "verb": "GET",
    "href": "/v2/users/123456780/profile",
    "title": "profile"
}

 

 

Sample JSON 


Depending on the resource accessed, the "route" wrapper may not be used.  Terminal information only available when provided.

  "lister": {
    "userId": 123456789,
    "displayName": "FirstName A.",
    "feedback": {
      "count": 5,
      "percentPositive": 95.5,
      "starRating": 5
    },
    "links": [
      {
        "rel": "Item",
        "verb": "GET",
        "href": "/v2/users/123456789/profile",
        "title": "profile"
      }
    ]
  },

 

 

{
  "route": {
    "items": [
      {
        "address": {
          "streetAddress": "100 Avenue A",
          "alternateStreetAddress": "Bldg 2, Suite 100",
          "majorMunicipality": "Tampa",
          "postalCode": "33623",
          "stateProvince": "FL",
          "country": "US",
          "latitude": 28.056858,
          "longitude": -82.605871,
          "type": "Residence",
          "timeZone": "America/New_York"
        },
        "timeFrame": {
          "earliestArrival": "2014-11-01T00:00:00Z",
          "latestArrival": "2014-11-01T00:00:00Z",
          "timeFrameType": "on"
        },
        "terminal": {
          "phoneNumber": "9876543210",
          "city": "Tampa",
          "state": "FL",
          "postalCode": "33623"
        }
      },
      {
        "address": {
          "postalCode": "78741",
          "country": "US",
          "type": "Residence"
        },
        "timeFrame": {
          "earliestArrival": "2014-11-11T00:00:00Z",
          "latestArrival": "2014-11-21T00:00:00Z",
          "timeFrameType": "between"
        },
        "terminal": {
          "phoneNumber": "1234567890",
          "city": "Austin",
          "state": "TX",
          "postalCode": "78704"
        }
      }
    ]
  }
}