GetProductsRequestType
Searches for stock information and reviews for certain kinds of products, such as a particular digital camera model.

GetProducts is designed to be useful to applications that support shopping comparison, product reviews, or basic supply and demand data.

GetProducts also supports tracking so that members of the eBay Affiliates Program can get commissions for driving traffic to eBay.

Note: For selling use cases, use GetProductSearchResults and GetProductSellingPages instead.

To use this call, you typically pass in keywords, and GetProducts finds products with matching words in the product title, description, and/or Item Specifics.

For each product of interest, you call GetProducts again to retrieve additional details that would be useful to buyers:

Note: As catalog queries can take longer than item queries, GetProducts can be slower than GetSearchResults. Also, due to the way product data is cached, you may get a faster response when you run the same query a second time.

Fields
AffiliateTrackingDetails ( AffiliateTrackingDetailsType )
HideDuplicateItems ( boolean )
IncludeBuyingGuideDetails ( boolean )
IncludeHistogram ( boolean )
IncludeItemArray ( boolean )
IncludeReviewDetails ( boolean )
ProductSearch ( ProductSearchType )
ProductSort ( ProductSortCodeType )

AffiliateTrackingDetails ( AffiliateTrackingDetailsType ) [0..1]
See the eBay Partner Network. eBay uses the values in AffiliateTrackingDetails to build a View Item URL string, in order to include that string in the response. When a user clicks through the URL to eBay, you may get a commission (see the URL above). Only applicable when IncludeItemArray is specified (because the View Item URL is only returned in item information, not in product information).
See the Field Index to learn which calls use AffiliateTrackingDetails.

HideDuplicateItems ( boolean ) [0..1]
Specifies whether or not to remove duplicate items from search results. When set to true, and there are duplicate items for an item in the search results, the subsequent duplicates will not appear in the results. Item listings are considered duplicates in the following conditions:
  • Items are listed by the same seller
  • Items have exactly the same item title
  • Items have similar listing formats
    • Auctions: Auction Items, Auction BIN items, Multi-Quantity Auctions, and Multi-Quantity Auctions BIN items
    • Fixed Price: Fixed Price, Multi-quantity Fixed Price, Fixed Price with Best Offer, and Store Inventory Format items
    • Classified Ads

For Auctions, items must also have the same price and number of bids to be considered duplicates.
Filtering of duplicate item listings is not supported on all sites. For GetProducts, this filter only works when IncludeItemArray is set to true.
See the Field Index to learn which calls use HideDuplicateItems.

IncludeBuyingGuideDetails ( boolean ) [0..1]
If true, the response includes up to 5 buying guides (if any) for the product specified in ExternalProductID or ProductReferenceID. Not applicable with QueryKeywords.
See the Field Index to learn which calls use IncludeBuyingGuideDetails.

IncludeHistogram ( boolean ) [0..1]
If true, the response includes a histogram that lists the number of matching products found and the domains in which they were found. (A domain is like a high-level category.) Including the histogram can affect the call's performance. You may see significantly slower response times when many matching products are found.
See the Field Index to learn which calls use IncludeHistogram.

IncludeItemArray ( boolean ) [0..1]
If true, the response includes items (if any) that match the product specified in ExternalProductID or ProductReferenceID. Not applicable with QueryKeywords.
See the Field Index to learn which calls use IncludeItemArray.

IncludeReviewDetails ( boolean ) [0..1]
If true, the response includes up to 20 reviews (if any) for the product specified in ExternalProductID or ProductReferenceID. The reviews are sorted by most helpful (most votes) first. When you include review details, please note that response times may be longer than 60 seconds. Not applicable with QueryKeywords.
See the Field Index to learn which calls use IncludeReviewDetails.

ProductSearch ( ProductSearchType ) [0..1]
Contains the fields that form the search query. You can query against keywords, an eBay product reference ID (not to be confused with an eBay product ID), or external product ID (like an ISBN).
See the Field Index to learn which calls use ProductSearch.

ProductSort ( see ProductSortCodeType for possible values ) [0..1]
Sorts the list of products returned. This is mostly only useful with QueryKeywords. (When you use ExternalProductID or ProductReferenceID, eBay usually only returns one product.)
See the Field Index to learn which calls use ProductSort.

This document was generated with a customized version of the apireferencedocs tool.

© 2005–2009 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.