Class FindHalfProductsResponseType

class FindHalfProductsResponseType

Returns stock product information in Half.com catalogs, such as information about a particular DVD or book. Optionally, also returns items that match the product.

Defined in com/ebay/shoppingservice/FindHalfProductsResponseType.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 moreResults

If true, more pages of results are available.

Number pageNumber

The number of the page of data returned.

String productSearchURL

A URL for product search results that corresponds to your search request.

HalfProductsType products

An set of Half.com catalog products.

Number totalProducts

The total number of matching products found.

Properties inherited from AbstractResponseType

ack , build , correlationID , errors , timestamp , version

Constructor Summary

FindHalfProductsResponseType(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 FindHalfProducts 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 is essentially a set of categories that share certain common features (as determined by Half.com). Each domain has its own name and ID.

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 HasMore to decide which page to retrieve next. As FindHalfProducts only returns up to 2000 products, the maximum possible value is theoretically 2000 (if you were to set EntriesPerPage to 1 in the request).

property String productSearchURL

A URL for product search results that corresponds to your search request. This is similar to ItemSearchURL in FindItems and FindItemsAdvanced.

property HalfProductsType products

An set of Half.com catalog products. This contains stock information about a particular DVD, book, or other product. When you use QueryKeywords in the request, FindHalfProducts returns a maximum of 20 products per page. When you use ProductID in the request, FindHalfProducts usually only returns 1 product. ItemCount is only returned if you use ProductID with IncludeSelector set to Items or Details. (If more than one product matches the same ProductID, FindHalfProducts 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 FindHalfProductsResponseType

FindHalfProductsResponseType(Object props)

Parameters:

props