Shopping_FindHalfProductsRequestType Class Reference
Inherits from | Shopping_AbstractRequestType : NSObject |
Declared in | Shopping_FindHalfProductsRequestType.h Shopping_FindHalfProductsRequestType.m |
Overview
Searches Half.com for stock product information (stock description
and Item Specifics), such as information about a particular
kind of DVD or book. Also, retrieves up to 30 Half.com listings associated
with a product.
@ingroup ShoppingInterface
Tasks
-
includeSelector
Defines standard subsets of fields to return within the
property
response.
If you don’t specify this field, the call returns a default
set of fields, focusing on product details only -
availableItemsOnly
If true, only retrieve data for products that have been used to
property
pre-fill active listings on the Half.com site.
If false, retrieve all products that match the query.
This is useful when you use QueryKeywords and you only want to
find products that have associated items (that is, where ItemArray
would not be empty).
By default, AvailableItemsOnly does not retrieve an ItemArray; it only controls
which products are returned (or counted). When you use QueryKeywords in your
request, only products are returned, ItemArray is never returned.
To retrieve an ItemArray, use a ProductID in your request instead of a
QueryKeyword and specify Items in the IncludeSelector field. -
domainName
A domain to search in. This is like searching a section of
property
a catalog. If not specified, the product search is conducted
across all domains.
DomainName is an unbounded field. If you are using a URL, and you want
to specify multiple values, use an index value (not a comma).
For example, to specify DomainName=Textbooks,Education,
specify DomainName(0)=Textbooks,%20Education.
To determine valid domain names,
first use this call with QueryKeywords. Domain names are returned
for each product (and summarized in the domain histogram, if you
specify DomainHistogram in IncludeSelector).
A domain is a named grouping of categories whose items share
common product characteristics. For example, all bound books
have a binding or format (e.g., Hardcover), but audiobooks don’t.
So audiobooks would have their own domain.
To limit your search to audiobooks, you would specify Audiobooks
as the domain.
Only useful when QueryKeywords is specified. If you use this with
ProductID, AND logic is applied. In this case, if you specify an
ID that doesn’t match the domain (as Half.com has defined it),
no matching product will be found. Therefore, we recommend that
you only use DomainName with QueryKeywords. -
productID
Use this to retrieve product details for one specific product.
property
Specify the ID as a string, and use the type attribute to
indicate the nature of the ID you are specifying.
In general, you can request up to 10 IDs of the same type by
separating them with commas, as in the following: 014633155310,014633145496.
However, if you specify a ProductID type of Reference (which specifies
a global reference ID for an eBay catalog product), only one ID in
ProductID can be used.
The request requires either QueryKeywords or
ProductID, but these fields cannot be used together.
ItemCount is only returned when ProductID is used in the request
and the IncludeSelector is set to Items or Details. -
queryKeywords
One or more keywords to search for. When you use a keyword search,
property
Half.com searches the product catalogs for matching words in the
product title, description, and/or Item Specifics, and it returns
a list of matching products, with no items. To retrieve
items, use ProductID instead. (If you don’t already have a
product ID, you can get product IDs from the
response after conducting a keyword search.)
If specified, you must pass in at least 3 alphanumeric characters.
The words “and” and “or” are treated like any other word.
Only use “and”, “or”, or “the” if you are searching for products
containing these words.
To use AND or OR logic, use Half.com’s standard search string
modifiers. Wildcards (+, -, or *) are also supported.
Be careful when using spaces before or after modifiers and
wildcards.
Some keyword queries can result in response times of 30 seconds or
longer. If more than 2000 matches are found, the call fails with
an error. If this kind of error occurs, refine the search by
passing in more keywords and/or by using DomainName to restrict
the search to certain domains (such as DVDs).
If you are searching for a particular book, DVD, CD, or video game
and you already know its ISBN or EAN (for a book) or UPC,
consider using ProductID instead to retrieve more
precise results.
The request requires either QueryKeywords or
ProductID, but these fields cannot be used together.
When QueryKeywords is used in the request, ItemCount is not returned. -
sellerID
The ID of a specific seller.
property
Specify this value in combination with ProductID
if you want search results to be filtered so that the items returned
are only items in a specific product, sold by a specific seller.
To specify SellerID, use SellerID and ProductID together. -
productSort
Sorts the list of products returned. This is mostly only useful
property
with QueryKeywords. (When you use ProductID, Half.com usually only returns one product.) -
sortOrder
Sorts the list of products returned.
property -
maxEntries
Specifies the maximum number of products to return per page
property
in a single call. This is mostly only useful
with QueryKeywords. (When you use ProductID, Half.com usually only
returns one product, and up to 30 items for that product.) -
pageNumber
Specifies which page of data to return in the current call.
property
Specify a positive value equal to or lower than the number of
pages available (which you determine by examining the results of
your initial request).
Use this only when specifying QueryKeywords.
Properties
availableItemsOnly
If true, only retrieve data for products that have been used to
pre-fill active listings on the Half.com site.
If false, retrieve all products that match the query.
This is useful when you use QueryKeywords and you only want to
find products that have associated items (that is, where ItemArray
would not be empty).
By default, AvailableItemsOnly does not retrieve an ItemArray; it only controls
which products are returned (or counted). When you use QueryKeywords in your
request, only products are returned, ItemArray is never returned.
To retrieve an ItemArray, use a ProductID in your request instead of a
QueryKeyword and specify Items in the IncludeSelector field.
@property (nonatomic, retain) NSNumber *availableItemsOnly
Discussion
If true, only retrieve data for products that have been used to
pre-fill active listings on the Half.com site.
If false, retrieve all products that match the query.
This is useful when you use QueryKeywords and you only want to
find products that have associated items (that is, where ItemArray
would not be empty).
By default, AvailableItemsOnly does not retrieve an ItemArray; it only controls
which products are returned (or counted). When you use QueryKeywords in your
request, only products are returned, ItemArray is never returned.
To retrieve an ItemArray, use a ProductID in your request instead of a
QueryKeyword and specify Items in the IncludeSelector field.
type : NSNumber, wrapper for primitive bool
Declared In
Shopping_FindHalfProductsRequestType.h
domainName
A domain to search in. This is like searching a section of
a catalog. If not specified, the product search is conducted
across all domains.
DomainName is an unbounded field. If you are using a URL, and you want
to specify multiple values, use an index value (not a comma).
For example, to specify DomainName=Textbooks,Education,
specify DomainName(0)=Textbooks,%20Education.
To determine valid domain names,
first use this call with QueryKeywords. Domain names are returned
for each product (and summarized in the domain histogram, if you
specify DomainHistogram in IncludeSelector).
A domain is a named grouping of categories whose items share
common product characteristics. For example, all bound books
have a binding or format (e.g., Hardcover), but audiobooks don’t.
So audiobooks would have their own domain.
To limit your search to audiobooks, you would specify Audiobooks
as the domain.
Only useful when QueryKeywords is specified. If you use this with
ProductID, AND logic is applied. In this case, if you specify an
ID that doesn’t match the domain (as Half.com has defined it),
no matching product will be found. Therefore, we recommend that
you only use DomainName with QueryKeywords.
@property (nonatomic, retain) NSMutableArray *domainName
Discussion
A domain to search in. This is like searching a section of
a catalog. If not specified, the product search is conducted
across all domains.
DomainName is an unbounded field. If you are using a URL, and you want
to specify multiple values, use an index value (not a comma).
For example, to specify DomainName=Textbooks,Education,
specify DomainName(0)=Textbooks,%20Education.
To determine valid domain names,
first use this call with QueryKeywords. Domain names are returned
for each product (and summarized in the domain histogram, if you
specify DomainHistogram in IncludeSelector).
A domain is a named grouping of categories whose items share
common product characteristics. For example, all bound books
have a binding or format (e.g., Hardcover), but audiobooks don’t.
So audiobooks would have their own domain.
To limit your search to audiobooks, you would specify Audiobooks
as the domain.
Only useful when QueryKeywords is specified. If you use this with
ProductID, AND logic is applied. In this case, if you specify an
ID that doesn’t match the domain (as Half.com has defined it),
no matching product will be found. Therefore, we recommend that
you only use DomainName with QueryKeywords.
entry type : NSString, wrapper for primitive string
Declared In
Shopping_FindHalfProductsRequestType.h
includeSelector
Defines standard subsets of fields to return within the
response.
If you don’t specify this field, the call returns a default
set of fields, focusing on product details only
@property (nonatomic, retain) NSString *includeSelector
Discussion
Defines standard subsets of fields to return within the
response.
If you don’t specify this field, the call returns a default
set of fields, focusing on product details only
Declared In
Shopping_FindHalfProductsRequestType.h
maxEntries
Specifies the maximum number of products to return per page
in a single call. This is mostly only useful
with QueryKeywords. (When you use ProductID, Half.com usually only
returns one product, and up to 30 items for that product.)
@property (nonatomic, retain) NSNumber *maxEntries
Discussion
Specifies the maximum number of products to return per page
in a single call. This is mostly only useful
with QueryKeywords. (When you use ProductID, Half.com usually only
returns one product, and up to 30 items for that product.)
type : NSNumber, wrapper for primitive int
Declared In
Shopping_FindHalfProductsRequestType.h
pageNumber
Specifies which page of data to return in the current call.
Specify a positive value equal to or lower than the number of
pages available (which you determine by examining the results of
your initial request).
Use this only when specifying QueryKeywords.
@property (nonatomic, retain) NSNumber *pageNumber
Discussion
Specifies which page of data to return in the current call.
Specify a positive value equal to or lower than the number of
pages available (which you determine by examining the results of
your initial request).
Use this only when specifying QueryKeywords.
type : NSNumber, wrapper for primitive int
Declared In
Shopping_FindHalfProductsRequestType.h
productID
Use this to retrieve product details for one specific product.
Specify the ID as a string, and use the type attribute to
indicate the nature of the ID you are specifying.
In general, you can request up to 10 IDs of the same type by
separating them with commas, as in the following: 014633155310,014633145496.
However, if you specify a ProductID type of Reference (which specifies
a global reference ID for an eBay catalog product), only one ID in
ProductID can be used.
The request requires either QueryKeywords or
ProductID, but these fields cannot be used together.
ItemCount is only returned when ProductID is used in the request
and the IncludeSelector is set to Items or Details.
@property (nonatomic, retain) Shopping_ProductIDType *productID
Discussion
Use this to retrieve product details for one specific product.
Specify the ID as a string, and use the type attribute to
indicate the nature of the ID you are specifying.
In general, you can request up to 10 IDs of the same type by
separating them with commas, as in the following: 014633155310,014633145496.
However, if you specify a ProductID type of Reference (which specifies
a global reference ID for an eBay catalog product), only one ID in
ProductID can be used.
The request requires either QueryKeywords or
ProductID, but these fields cannot be used together.
ItemCount is only returned when ProductID is used in the request
and the IncludeSelector is set to Items or Details.
type : class Shopping_ProductIDType
Declared In
Shopping_FindHalfProductsRequestType.h
productSort
Sorts the list of products returned. This is mostly only useful
with QueryKeywords. (When you use ProductID, Half.com usually only returns one product.)
@property (nonatomic, retain) NSString *productSort
Discussion
Sorts the list of products returned. This is mostly only useful
with QueryKeywords. (When you use ProductID, Half.com usually only returns one product.)
type: string constant in Shopping_ProductSortCodeType.h
Declared In
Shopping_FindHalfProductsRequestType.h
queryKeywords
One or more keywords to search for. When you use a keyword search,
Half.com searches the product catalogs for matching words in the
product title, description, and/or Item Specifics, and it returns
a list of matching products, with no items. To retrieve
items, use ProductID instead. (If you don’t already have a
product ID, you can get product IDs from the
response after conducting a keyword search.)
If specified, you must pass in at least 3 alphanumeric characters.
The words “and” and “or” are treated like any other word.
Only use “and”, “or”, or “the” if you are searching for products
containing these words.
To use AND or OR logic, use Half.com’s standard search string
modifiers. Wildcards (+, -, or *) are also supported.
Be careful when using spaces before or after modifiers and
wildcards.
Some keyword queries can result in response times of 30 seconds or
longer. If more than 2000 matches are found, the call fails with
an error. If this kind of error occurs, refine the search by
passing in more keywords and/or by using DomainName to restrict
the search to certain domains (such as DVDs).
If you are searching for a particular book, DVD, CD, or video game
and you already know its ISBN or EAN (for a book) or UPC,
consider using ProductID instead to retrieve more
precise results.
The request requires either QueryKeywords or
ProductID, but these fields cannot be used together.
When QueryKeywords is used in the request, ItemCount is not returned.
@property (nonatomic, retain) NSString *queryKeywords
Discussion
One or more keywords to search for. When you use a keyword search,
Half.com searches the product catalogs for matching words in the
product title, description, and/or Item Specifics, and it returns
a list of matching products, with no items. To retrieve
items, use ProductID instead. (If you don’t already have a
product ID, you can get product IDs from the
response after conducting a keyword search.)
If specified, you must pass in at least 3 alphanumeric characters.
The words “and” and “or” are treated like any other word.
Only use “and”, “or”, or “the” if you are searching for products
containing these words.
To use AND or OR logic, use Half.com’s standard search string
modifiers. Wildcards (+, -, or *) are also supported.
Be careful when using spaces before or after modifiers and
wildcards.
Some keyword queries can result in response times of 30 seconds or
longer. If more than 2000 matches are found, the call fails with
an error. If this kind of error occurs, refine the search by
passing in more keywords and/or by using DomainName to restrict
the search to certain domains (such as DVDs).
If you are searching for a particular book, DVD, CD, or video game
and you already know its ISBN or EAN (for a book) or UPC,
consider using ProductID instead to retrieve more
precise results.
The request requires either QueryKeywords or
ProductID, but these fields cannot be used together.
When QueryKeywords is used in the request, ItemCount is not returned.
type : NSString, wrapper for primitive string
Declared In
Shopping_FindHalfProductsRequestType.h
sellerID
The ID of a specific seller.
Specify this value in combination with ProductID
if you want search results to be filtered so that the items returned
are only items in a specific product, sold by a specific seller.
To specify SellerID, use SellerID and ProductID together.
@property (nonatomic, retain) NSString *sellerID
Discussion
The ID of a specific seller.
Specify this value in combination with ProductID
if you want search results to be filtered so that the items returned
are only items in a specific product, sold by a specific seller.
To specify SellerID, use SellerID and ProductID together.
type : NSString, wrapper for primitive string
Declared In
Shopping_FindHalfProductsRequestType.h