Chapter 1: Using the REST API 16
Retrieve Product Information with GetProducts
Version 3.7
GetProducts includes input parameters for retrieving the following types of product information:
Stock catalog information about a particular DVD, digital camera, or a variety of other products
Product titles, stock photos, and Item Specifics
URLs to help you create links to additional catalog content on eBay
Up to 200 active items that were listed with a product
Up to 20 of the top reviews written by eBay members
For example, to use the
QueryKeywords parameter to search for products that match "harry potter,"
you can specify an URL similar to the following:
http://rest.api.ebay.com/
restapi?CallName=GetProducts&RequestToken=UserToken&RequestUserId=UserName&ProductSearch.Qu
eryKeywords=Harry%Potter&ProductSearch.Pagination.EntriesPerPage=2&ProductSearch.Pagination.Pag
eNumber=1&Version=505
The response includes two products. Each product returns a ProductReferenceID that can be used as
input to GetProducts to retrieve reviews, items associated with the product, or both. Some types of
products, like books, also return an ExternalProductID that can be used as an alternative to
ProductReferenceID. Each product also return an ItemSpecifics node, which provides some standard
information about the product. For example, book products usually return book-specific information
such as the author. DVDs usually return movie-specific information such as the leading role.
You can use the ProductReferenceID from a product retrieved in the above example, as follows, to
retrieve product reviews and to retrieve items listed with the product:
http://rest.api.ebay.com/
restapi?CallName=GetProducts&RequestToken=UserToken&RequestUserId=UserName&ProductSearch.Pr
oductReferenceID=44462740&IncludeItemArray=true&IncludeReviewDetails=true&Version=505
For samples of GetProducts that are used in the unified schema, please see the following location:
http://developer.ebay.com/DevZone/XML/docs/WebHelp/
index.htm?context=eBay_XML_API&topic=GetProductsSamples
Parameters for GetProducts are the same in the REST API as in the unified schema, except for the
REST-specific input parameters. For the REST-specific input parameters, see “Basic REST Input
Parameters” on page 3. For more information about using GetProducts, including descriptions of the
call-specific input and output parameters, see the following document:
GetProducts
General information about the unified schema format is available at the following location:
http://developer.ebay.com/support/docs/
