eBay Shopping APIVersion 1119

FindProductsResponseType ( AbstractResponseType )

The base response of the FindProducts call. Based on the search criteria, an array of one or more eBay catalog products are returned in the response, along with pagination data.

Call that uses FindProductsResponseType:

Fields



ApproximatePages ( int ) [0..1]
The total number of pages in the results set based on the current search criteria. The number of pages in the results set will be determined by how many catalog products are found based on the search criteria (QueryKeywords string, DomainName filter(s), and CategoryID restriction), and the number of catalog products to return on each page of results (set in the MaxEntries field). If 200 catalog products were found (as shown in the TotalProducts field), and the MaxEntries value is 25 (25 catalog products per page), the ApproximatePages value will be 8 (200 (records)/25 (records per page) = 8 (pages).
See the Field Index to learn which calls use ApproximatePages.

DomainHistogram ( DomainHistogramType ) [0..1]
Important: The use of domain histograms and DomainName filters is no longer recommended, as the domain histogram data that is returned in the response, and filtering by domain logic is no longer reliable.
This container consist of an array of eBay category domains, and the number of catalog products that belong to each eBay category domain. This array is only returned if the IncludeSelector field is included in the call request and set to a value of DomainHistogram.

To retrieve valid domain names, first use this call with your query string specified in QueryKeywords, and the IncludeSelector field's value set to DomainHistogram. After retrieving all eBay defined domain names for the query string under the DomainHistogram container, the user can select the eBay domains relevant to the product they're searching for, and then they can do another FindProducts call with one or more DomainName filters.

Generally, DomainName filter(s) are only useful for query string searches using QueryKeywords field. If you are searching for a specific catalog product based on an eBay Product ID (ePID) or a Global Trade Item Number (GTIN), such as a UPC, ISBN, or EAN, a lt;b>DomainName filter is not needed.
See the Field Index to learn which calls use DomainHistogram.

DuplicateItems ( boolean ) [0..1]
Not used by any call.

This boolean field is no longer applicable since the FindProducts call no longer retrieves any active listings associated with the retrieved catalog products.
See the Field Index to learn which calls use DuplicateItems.

ItemArray ( SimpleItemArrayType ) [0..1]
Not used by any call.

This container has been deprecated from the FindProducts call. To retrieve active items associated with a product, you can use the findItemsByProduct call of the Finding API instead.
See the Field Index to learn which calls use ItemArray.

MoreResults ( boolean ) [0..1]
This boolean value is returned as true if more pages of catalog product records exist for the current search criteria, and false if the current page or results is the only or last page in the results set based on the current search criteria.

If more pages of results are available (value is true), it is advised that the user look at the PageNumber value and at the ApproximatePages value, as this will give the user an idea of how many more pages of results exist based on the current search criteria. After having this knowledge, it is up to the user whether to refine the search a little more to retrieve less results, or perhaps increase the MaxEntries integer value in the call request to retrieve more catalog products per page, or just go ahead and make multiple FindProducts calls to view all pages of results, iterating the PageNumber integer value in the call request by '1' with each subsequent call.
See the Field Index to learn which calls use MoreResults.

PageNumber ( int ) [0..1]
This integer value shows the current page number of the results set that is being displayed. The number of pages in the results set depends on how many catalog products exist based on the search criteria, and how many catalog products are being returned per page (set in the MaxEntries field in the call request). The total number of pages in the results set is shown in the ApproximatePages field.

The PageNumber value in the response always reflects the PageNumber value that is set in the call request, or, if the PageNumber field is not used in the call request, the first (and perhaps only) page is returned by default.

If there are multiple pages in the results set, and the user wants to review multiple pages, multiple FindProducts calls are required, iterating the PageNumber integer value in the call request by '1' with each subsequent call.
See the Field Index to learn which calls use PageNumber.

A Product container is returned for each eBay catalog product that matches the search criteria. The Product container consists of specific data about the catalog product, including the product title, product identifiers (ePID and any GTIN value(s)), product aspects, a link to eBay product page, and links to stock photos (if any).

The number of catalog products returned is dependent on the search criteria in the request. Searches based on a QueryKeywords string will generally return multiple catalog products, but a search based on an eBay Product ID (set in the ProductID field) should only return one catalog product. The number of catalog products returned per page will also depend on the MaxEntries value set in the call request.
See the Field Index to learn which calls use Product.

TotalProducts ( int ) [0..1]
This integer value is the total number of catalog products that match the current search criteria. This value can be quite larger than the total number of catalog products returned per page, which is controlled by the MaxEntries value set in the call request. The user can also look at the ApproximatePages field to see how many pages of results exist for the current search criteria.
See the Field Index to learn which calls use TotalProducts.