Shopping_FindHalfProductsResponseType Class Reference
Inherits from | Shopping_AbstractResponseType : NSObject |
Declared in | Shopping_FindHalfProductsResponseType.h Shopping_FindHalfProductsResponseType.m |
Overview
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.
@ingroup ShoppingInterface
Tasks
-
domainHistogram
A histogram that lists the number of matching products found
property
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. -
pageNumber
The number of the page of data returned. If many products
property
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). -
approximatePages
The total number of pages that can be returned, given the same
property
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). -
moreResults
If true, more pages of results are available.
property
That is, PageNumber is less than ApproximatePages. -
totalProducts
The total number of matching products found.
property
(If more than 2000 products are found, the call fails
with an error.) -
products
An set of Half.com catalog products. This contains stock information about a
property
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.) -
productSearchURL
A URL for product search results that corresponds to your search request. This is similar to ItemSearchURL in FindItems and FindItemsAdvanced.
property
Properties
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 (nonatomic, retain) NSNumber *approximatePages
Discussion
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).
type : NSNumber, wrapper for primitive int
Declared In
Shopping_FindHalfProductsResponseType.h
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 (nonatomic, retain) Shopping_DomainHistogramType *domainHistogram
Discussion
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.
type : class Shopping_DomainHistogramType
Declared In
Shopping_FindHalfProductsResponseType.h
moreResults
If true, more pages of results are available.
That is, PageNumber is less than ApproximatePages.
@property (nonatomic, retain) NSNumber *moreResults
Discussion
If true, more pages of results are available.
That is, PageNumber is less than ApproximatePages.
type : NSNumber, wrapper for primitive bool
Declared In
Shopping_FindHalfProductsResponseType.h
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 (nonatomic, retain) NSNumber *pageNumber
Discussion
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).
type : NSNumber, wrapper for primitive int
Declared In
Shopping_FindHalfProductsResponseType.h
productSearchURL
A URL for product search results that corresponds to your search request. This is similar to ItemSearchURL in FindItems and FindItemsAdvanced.
@property (nonatomic, retain) NSString *productSearchURL
Discussion
A URL for product search results that corresponds to your search request. This is similar to ItemSearchURL in FindItems and FindItemsAdvanced.
type : NSString, wrapper for primitive string
Declared In
Shopping_FindHalfProductsResponseType.h
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 (nonatomic, retain) Shopping_HalfProductsType *products
Discussion
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.)
type : class Shopping_HalfProductsType
Declared In
Shopping_FindHalfProductsResponseType.h
totalProducts
The total number of matching products found.
(If more than 2000 products are found, the call fails
with an error.)
@property (nonatomic, retain) NSNumber *totalProducts
Discussion
The total number of matching products found.
(If more than 2000 products are found, the call fails
with an error.)
type : NSNumber, wrapper for primitive int
Declared In
Shopping_FindHalfProductsResponseType.h