FindReviewsAndGuidesRequestType

Splitting include reviews and guides from GetProducts.

Fields

CategoryID ( string )
MaxResultsPerPage ( int )
PageNumber ( int )
ProductID ( ProductIDType (string) )
ReviewSort ( ReviewSortCodeType )
SortOrder ( SortOrderCodeType )
UserID ( string )

CategoryID ( string ) [0..1]
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 findItemsAdvanced from the Finding API with CategoryHistogram value in the OutputSelector 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.
See the Field Index to learn which calls use CategoryID.

MaxResultsPerPage ( int ) [0..1]
Specifies the maximum number of reviews per page (not guides) in the returned list. If not specified, the default returns 5 results per page.
See the Field Index to learn which calls use MaxResultsPerPage.

PageNumber ( int ) [0..1]
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).
See the Field Index to learn which calls use PageNumber.

ProductID ( ProductIDType (string) ) [0..1]
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.
See the Field Index to learn which calls use ProductID.

ReviewSort ( see ReviewSortCodeType for possible values ) [0..1]
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.)
See the Field Index to learn which calls use ReviewSort.

SortOrder ( see SortOrderCodeType for possible values ) [0..1]
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.
See the Field Index to learn which calls use SortOrder.

UserID ( string ) [0..1]
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).
See the Field Index to learn which calls use UserID.

Copyright © 2006–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.