Listing Conversations

Listing Steps Conversations

 

Listings Conversations Resource

The listings conversations resource allows a Shipper and a Service Provider to ask and answer questions on a listing to determine whether they can make a match. The user starting the listing conversation must not be the Lister. 

The conversation is anonymous or protected because the contact information of the parties involved is not allowed per the uShip User Agreement.

The Community Trust and Safety department monitors the flags that marketplace users can place on content such as questions and answers if the agreement is violated.

 

Conversations Hierarchy

Even though the conversation is shown differently on uShip web products than mobile or touch displays, the data is stored the same way.

 

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

The GET returns a read-only JSON body with the active listing's question and answer conversations.

GET https://api.uship.com/v2/listings/{listingId}/conversations/{conversationId}/

The GET returns a read-only JSON body with the details of a specific listing conversation.

 

Response

Conversation Container

Field Type Description Example
totalCount
Integer The sum of conversations in the listing. 10
items
Array List of conversation objects. -
conversationId
Integer Unique identifier of the conversation. 123456
listingId
Integer Unique identifier of the listing. 123456789
comments
Array Lists of comment objects or questions and answers. -
links
Array Wrapper for the hypermedia links following a listing conversation. Hypermedia links suggest what a user can do next in the relevant context. -
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. "Create"
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.
"POST"
href
String This hypermedia reference attribute specifies the URL of the page link destination. This reference link suggests what actions are possible. "/v2/listings/204260209/conversations/632596"
title
String The descriptive name of the possible action. "listingconversations"

Question Object

Field Type Description Example
text
String Content for the question. "Will this shipment require us to take a part and/or reassemble furniture?"
datePosted
String The date and time the Shipper or Service Provider asked or posted the question. "2013-09-11T15:32:10Z"
user
Container Wrapper for the field of the user asking the question. -
userId
Integer Unique identifier of the user asking the question. 012345678
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. "ABC Transport Company"
imageUrl
String The web address or server path where the Shipper or Service Provider'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. 4.8

Response Object

Field Type Description Example
text
String Response to the question and answer pair. "No, this shipment does not require unassembling or reassembling furniture. Only packed boxes are in this load."
datePosted
String The date and time the Shipper or Service Provider asked or posted the response. "2013-09-11T15:32:18Z"
user
Container Wrapper for the field of the user responding to the question. -
userId
Integer Unique identifier of the user responding to the question. 012345678
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 Shipper or Service Provider's profile image is stored.