Listings Contacts

GET

https://api.uship.com/v2/listings/{listingId}/contacts/

Returns a read-only JSON body with the active listing's contact information.

The user must be one of the following to have permission to view contact information for the specified listing:

  • Lister, or
  • Winning Bidder, or
  • Driver assigned by the Winning Bidder (when applicable).

The listing must be active and booked for contacts to return successfully. The information will only return if the user provided it initially.

 

Response

Shipper

Field Type Description Example
name
String The full name of the Shipping Customer. "Jane Smith"
companyName
String If the user is associated with a company and provides the name, the company name is returned. "ACME Company"
phone
String The Shipping Customer's primary telephone number. "(123) 456-7890"
secondaryPhone
String The Shipping Customer's secondary telephone number, if provided. "(234) 567-8901"
email
String The Shipping Customer's primary email address. "jane@acme.com"
secondaryEmail
String The Shipping Customer's secondary email address, if provided. "jane@smith.com" 
fax
String The Shipping Customer's facsimile number, if provided. "(345) 678-9012"
user
Container Wrapper for the active Shipping Customer's profile information. -
userId
Integer The active user's system-generated identifier. 123456789
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 first name and first initial of the last name appears. "Jane S."
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. 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. 5.0

Service Provider

Field Type Description Example
name
String The full name of the Service Provider. "John Smith TSP"
companyName
String The Service Provider's company name. "ABC Transport Company"
phone
String The Service Provider's primary telephone number. "(555) 123-4567"
secondaryPhone
String The Service Provider's secondary telephone number. "(555) 234-5678"
email
String The Service Provider's primary email address. "jsmithtsp@acme.com"
secondaryEmail
String The Service Provider's secondary email address, if provided. "john@abctransport.com"
fax
String The Service Provider's facsimile number, if provided. "(555) 345-6789"
user
Container Wrapper for the active Service Provider's profile information. -
userId
Integer The active user's system-generated identifier. 123456789
displayName
String The name that displays in the marketplace for the active user. Generally, this is the user's company name. "ABC Transport Company"
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. 15, 80, or 455
percentPositive
Decimal The percentage of positive ratings for this user out of 100%.  96.5
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

Locations

Field Type Description Example
name
String The name of the origin or destination.  "Origin", "Destination"
phone
String The phone number for the Shipping Customer at the pick up or delivery location. (555) 123-4567
address
Container Wrapper for the origin or destination fields for the shipment's physical pick up or delivery location. -
streetAddress
String The origin or destination address where the shipment will be picked up or delivered. "9641 Sunset Blvd" or "205 Brazos Street"
alternateStreetAddress
String The secondary origin or destination where the shipment will be picked up or delivered. Can be null. "301 Brazos Street"
majorMunicipality
String The main city, metropolis, or large town where the shipment will be picked up or delivered. "Beverly Hills" or "Austin"
postalCode
String The postal mailing code associated with the shipment address. "90210" or "78701"
stateProvince
String The unabbreviated state or province where the shipment is picked up or delivered. "CA" or "TX"
stateProvinceLabel
String The localized description of the state or province. "California" or "Texas"
country
String Abbreviated two-letter country code. Also known as the nation. "GB", "US"
countryLabel
String The full localized name of the country name. "United States" | "États-Unis"
latitude
Decimal The geographical latitude of the listing in decimal degrees.  his field will not always return, such as for international locations that we do not currently support. 30.244144, 25.784853
longitude
Decimal The geographical longitude of the listing in decimal degrees.  This field will not always return, such as for international locations that we do not currently support. -97.76286, -80.144731
label
String The full localized name for the region which is the most specific when geocoded.  "Austin, TX" | "Miami, FL"
shortLabel
String The full localized name for the region as shown on a mobile or touch device. "Austin, TX" | "Miami, FL"
type
Container Wrapper for the location type. -
value
String The pick up or delivery location type. "Residence" | "BusinessWithLoadingDockOrForklift"
label
String The localized name of the pick up or delivery location type. "Domicile" | "Entreprise (avec quai ou chariot élévateur)"
shortLabel
String The localized string for the location type name as shown on a mobile or touch device. "Domicile" | "Entreprise (avec quai ou chariot élévateur)"