Website logo

Retrieve reviews for a listing

Retrieves reviews for a listing. Currently only applicable to services listings.

URL: https://api.trademe.co.nz/v1/Listings/{listingId}/reviews.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: None
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

listingId Integer (required)

The ID of the listing to retrieve reviews for.
file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Query String parameters

page Integer (optional)

The page number of the set of results to return, starting from 1. Defaults to 1.
rows Integer (optional)

The number of results per page; also the maximum number of results to return. Defaults to 20.

Returns

<ListingReviewCollection>

Information on whether the operation was successful.

TotalCount Integer

The total number of results in the collection. Can be larger than the number of returned results.
Page Integer

The index of the current page of results (starts at 1).
PageSize Integer

The number of results in the current page.
List Collection of <ListingReview> or null

A list of the results in the current page.
ReviewId Integer

The ID of the review.
Date DateTime

The date and time the review was added or updated.
Positive Boolean

Indicates whether the review is a positive review (i.e. thumbs up).
ReviewText String or null

The review text.
Member <Member> or null

The member that posted the review.
MemberId Integer

The ID of the member. This may be 0, if we determine it is necessary to protect the member's privacy.
Nickname String or null

The nickname of the member. Some characters may be changed, if we determine it is necessary to protect the member's privacy.
DateAddressVerified DateTime

The date the member was address verified.
DateJoined DateTime

The date the member joined.
UniqueNegative Integer

The number of distinct members who have placed negative feedback against this member.
UniquePositive Integer

The number of distinct members who have placed positive feedback against this member.
FeedbackCount Integer

The member's total feedback (UniquePositive minus UniqueNegative).
IsAddressVerified Boolean

Indicates whether the member has been address verified.
IsDealer Boolean

Indicates whether the member is a car dealer.
IsAuthenticated Boolean

Indicates whether the member is authenticated.
Response String or null

A response from the listing owner (optional).
ResponseDate DateTime

If the listing owner posted a response, contains the date and time it was posted.

Example XML Response (switch to JSON) 

<ListingReviewCollection xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <ListingReview>
      <ReviewId>123</ReviewId>
      <Date>2018-01-01T00:00:00Z</Date>
      <Positive>false</Positive>
      <ReviewText>ABC</ReviewText>
      <Member>
        <MemberId>123</MemberId>
        <Nickname>ABC</Nickname>
        <DateAddressVerified>2018-01-01T00:00:00Z</DateAddressVerified>
        <DateJoined>2018-01-01T00:00:00Z</DateJoined>
        <UniqueNegative>123</UniqueNegative>
        <UniquePositive>123</UniquePositive>
        <FeedbackCount>123</FeedbackCount>
        <IsAddressVerified>false</IsAddressVerified>
        <IsDealer>false</IsDealer>
        <IsAuthenticated>false</IsAuthenticated>
      </Member>
      <Response>ABC</Response>
      <ResponseDate>2018-01-01T00:00:00Z</ResponseDate>
    </ListingReview>
    <ListingReview>
      <ReviewId>123</ReviewId>
      <Date>2018-01-01T00:00:00Z</Date>
      <Positive>false</Positive>
      <ReviewText>ABC</ReviewText>
      <Member>
        <MemberId>123</MemberId>
        <Nickname>ABC</Nickname>
        <DateAddressVerified>2018-01-01T00:00:00Z</DateAddressVerified>
        <DateJoined>2018-01-01T00:00:00Z</DateJoined>
        <UniqueNegative>123</UniqueNegative>
        <UniquePositive>123</UniquePositive>
        <FeedbackCount>123</FeedbackCount>
        <IsAddressVerified>false</IsAddressVerified>
        <IsDealer>false</IsDealer>
        <IsAuthenticated>false</IsAuthenticated>
      </Member>
      <Response>ABC</Response>
      <ResponseDate>2018-01-01T00:00:00Z</ResponseDate>
    </ListingReview>
  </List>
</ListingReviewCollection>

Example JSON Response (switch to XML) 

{
  "TotalCount": 123,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "ReviewId": 123,
      "Date": "\/Date(1514764800)\/",
      "Positive": false,
      "ReviewText": "ABC",
      "Member": {
        "MemberId": 123,
        "Nickname": "ABC",
        "DateAddressVerified": "\/Date(1514764800)\/",
        "DateJoined": "\/Date(1514764800)\/",
        "UniqueNegative": 123,
        "UniquePositive": 123,
        "FeedbackCount": 123,
        "IsAddressVerified": false,
        "IsDealer": false,
        "IsAuthenticated": false
      },
      "Response": "ABC",
      "ResponseDate": "\/Date(1514764800)\/"
    },
    {
      "ReviewId": 123,
      "Date": "\/Date(1514764800)\/",
      "Positive": false,
      "ReviewText": "ABC",
      "Member": {
        "MemberId": 123,
        "Nickname": "ABC",
        "DateAddressVerified": "\/Date(1514764800)\/",
        "DateJoined": "\/Date(1514764800)\/",
        "UniqueNegative": 123,
        "UniquePositive": 123,
        "FeedbackCount": 123,
        "IsAddressVerified": false,
        "IsDealer": false,
        "IsAuthenticated": false
      },
      "Response": "ABC",
      "ResponseDate": "\/Date(1514764800)\/"
    }
  ]
}