Developer Network Home - Help

Documentation for Yahoo! Shopping Web Services: User Product Review

Version 1Shopping Web Services : User Product Review

Submitting User Product Review Queries

The User Product Review service allows you to display user reviews about a particular product. These reviews can be sorted in three ways: latest reviews, most recommended reviews or the highest rated reviews; either in ascending or descending order. See also the Product Search, Merchant Search, Catalog Specs and the Catalog Listing services.

Support & Community

The User Product Review service is discussed on the yws-shopping mailing list.

Request URL

http://api.shopping.yahoo.com/ShoppingService/V1/userproductreview

Request parameters

See information on constructing REST queries

Parameter Value Description
appid string (required) The application ID. See Application IDs for more information.
catalogid integer (required) The ID of the Yahoo! Shopping Buyers Guide catalog, as derived from a Catalog in a Product Search.
results integer: default 10, max 100 The number of reviews to return.
sort mostRecommended_descending (default) ,
mostRecommended_ascending,
latest_descending,
latest_ascending,
highestRated_descending,
highestRated_ascending
sorts reviews based on any of three criteria (ascending or descending order):

  • most recommended
  • latest
  • highest rated

start integer : default 1 The starting result position to return.

Sample Request Url: http://api.shopping.yahoo.com/ShoppingService/v1/userproductreview?catalogid=1991368668&appid=YahooDemo&results=5

Response fields

The schema document for this service response is located at http://api.shopping.yahoo.com/ShoppingService/v1/userproductreview.xsd

Field Description
ResultSet Contains all of the query responses. Has attributes:

  • totalReviewsAvailable: The number of reviews available in the database.
  • firstReviewPosition: The position of the first review.

Review Contains each individual review.
Title The title of the review as entered by the reviewer.
Reviewer The name or Yahoo! ID that the reviewer chose to call them self.
CreateTime The date the review was submitted, in unix timestamp format.To understand this format, see wikipedia-Unix Time.
HelpfulRecommendations The number of people who found this review helpful.
TotalRecommendations The total number of people who read this review.
OverallRating The rating given by the reviewer for the product, out of 5.
Pro The pros (positive attributes) of the product as per the reviewer.
Con The cons (negative attributes) of the product as per the reviewer.
Posting The body of the review.

Sample response

The following is a sample response for the query 1991368668, the product ID for the iPod Mini-Silver MP3 Player:

Additional Terms of Service

When calling the shopping APIs, you must set the HTTP user agent to a valid web browser string. Bot and spider strings are not valid. The user agent can be set to some default value - it does not have to be changed based on the user's browser. Some examples are as follows:

More information on user agents can be found at http://en.wikipedia.org/wiki/user_agent.

For all Web sites and applications that present data from the Yahoo! Shopping API, the attribution text "Powered by Yahoo! Shopping" must also be presented.

Rate Limit

The User Product Review service is a part of the Yahoo! Shopping Web Services, which are limited to 5,000 queries per appid per day. See information on rate limiting.

Errors

The User Product Review service returns the standard errors. A 999 error is returned if the query limit has been exceeded.

Copyright © 2008 Yahoo! Inc. All rights reserved.

Privacy Policy - Terms of Service - Copyright Policy - Job Openings