Class FindProductsResponseType

Extends AbstractResponseType
class FindProductsResponseType
Returns stock product information in eBay catalogs, such as information about a particular DVD or camera. Optionally, also returns items that match the product.

Defined in com/ebay/shoppingservice/FindProductsResponseType.js

Property Summary
Number approximatePages
The total number of pages that can be returned, given the same query and filters in the request.
DomainHistogramType domainHistogram
A histogram that lists the number of matching products found and the domains in which they were found.
Boolean duplicateItems
Indicates whether there are duplicated items not returned by this response when HideDuplicateItems is true in the request.
SimpleItemArrayType itemArray
A list of active items that were listed with the requested product.
Boolean moreResults
If true, more pages of results are available.
Number pageNumber
The number of the page of data returned.
Array product
An eBay catalog product.
Number totalProducts
The total number of matching products found.

Properties inherited from AbstractResponseType
ack , build , correlationID , errors , timestamp , version

Constructor Summary
FindProductsResponseType(Object props)

Property Details

property Number approximatePages

The total number of pages that can be returned, given the same query and filters in the request. As FindProducts only returns up to 2000 products, the maximum possible value is theoretically 2000 (if you were to set MaxEntries to 1 in the request).

property DomainHistogramType domainHistogram

A histogram that lists the number of matching products found and the domains in which they were found. A domain describes a set of categories that share certain common characteristics (as determined by eBay). Each domain has its own name and ID. Only returned when you specify DomainHistogram in IncludeSelector.

property Boolean duplicateItems

Indicates whether there are duplicated items not returned by this response when HideDuplicateItems is true in the request.

property SimpleItemArrayType itemArray

A list of active items that were listed with the requested product. Only returned when you specify Items in IncludeSelector, and the product has matching items that are currently active on eBay.

property Boolean moreResults

If true, more pages of results are available. That is, PageNumber is less than ApproximatePages.

property Number pageNumber

The number of the page of data returned. If many products are found and multiple pages of results are available, use this in combination with ApproximatePages and MoreResults to decide which page to retrieve next. As FindProducts only returns up to 2000 products, the maximum possible value is theoretically 2000 (if you were to set MaxEntries to 1 in the request).

property Array product

An eBay catalog product. This contains stock information about a particular DVD, camera, set of golf clubs, or other product. When you use QueryKeywords in the request, FindProducts returns a maximum of 20 products per page. When you use ProductID in the request, FindProducts usually only returns 1 product. (If more than one product matches the same ProductID, FindProducts will return all of those products. As of the time of this writing, we expect this to be a rare case.)

property Number totalProducts

The total number of matching products found. (If more than 2000 products are found, the call fails with an error.)

Constructor Details

constructor FindProductsResponseType

FindProductsResponseType(Object props)

Parameters:
props