Class FindReviewsAndGuidesRequestType

class FindReviewsAndGuidesRequestType

Splitting include reviews and guides from GetProducts. Summary: Searches reviews and guides based on product, category, or user. The response provides information about each user or product's reviews and guides. RelatedCalls: FindItemsAdvanced, FindProducts, GetCategoryInfo

Defined in com/ebay/shoppingservice/FindReviewsAndGuidesRequestType.js

Property Summary

String categoryID

Specify a single CategoryID to restrict your query to a specific Guide category.

Number maxResultsPerPage

Specifies the maximum number of reviews per page (not guides) in the returned list.

Number pageNumber

Specifies the number of the page of data to return in the current call.

ProductIDType productID

Use this to retrieve reviews (not guides) for one specific product.

ReviewSortCodeType reviewSort

Include ReviewSort in your request if you want to sort by a parameter, such as CreationTime.

SortOrderCodeType sortOrder

Sorts search results in ascending or descending order, in conjunction with the value you specify in ReviewsSort.

String userID

Retrieves reviews and guides written by the specified user.

Properties inherited from AbstractRequestType

messageID

Constructor Summary

FindReviewsAndGuidesRequestType(Object props)

Property Details

property String categoryID

Specify a single CategoryID to restrict your query to a specific Guide category.

If the specified category ID doesn't match an existing category for the site, an invalid-category error message is returned. To determine valid categories:
Use the FindItemsAdvanced CategoryHistogram value in the IncludeSelector field to retrieve matching categories. Then make another FindReviewsAndGuides call with the ID of a matching category.

CategoryID can be used in combination with UserID to return Reviews and Guides. ProductID and CategoryID cannot be used together.

property Number maxResultsPerPage

Specifies the maximum number of reviews per page (not guides) in the returned list. If not specified, the default returns 5 results per page.

property Number pageNumber

Specifies the number of the page of data to return in the current call. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request).

property ProductIDType productID

Use this to retrieve reviews (not guides) for one specific product. Specify the ID as a string, and use the type attribute to indicate the nature of the ID you are specifying. Same as FindProducts, supports Reference, ISBN, UPC, EAN.

ProductID can be used in combination with UserID to return Reviews and Guides. ProductID and CategoryID cannot be used together.

property ReviewSortCodeType reviewSort

Include ReviewSort in your request if you want to sort by a parameter, such as CreationTime. See the SortOrder field for values for specifying that results are returned in ascending or descending order. (By default, results are returned in descending order.)

property SortOrderCodeType sortOrder

Sorts search results in ascending or descending order, in conjunction with the value you specify in ReviewsSort. The default is descending order.

For example, for the ReviewsSort value of CreationTime, and a SortOrder value of Descending, the most recently created reviews are returned first.

property String userID

Retrieves reviews and guides written by the specified user.

UserID can be combined with either ProductID or CategoryID but not both (as ProductID and CategoryID cannot be used together).

Constructor Details

constructor FindReviewsAndGuidesRequestType

FindReviewsAndGuidesRequestType(Object props)

Parameters:

props