Trading_ProductSearchType Class Reference
Inherits from | NSObject |
Conforms to | PicoBindable |
Declared in | Trading_ProductSearchType.h Trading_ProductSearchType.m |
Tasks
-
productSearchID
Unique alphanumeric key help you distinguish between query results in the response.
property
You define the key. Each search request ID must be unique within the same call.
Primarily useful when conducting multiple searches in the same call.
If not specified, the ProductSearchResult.ID values in the response are
indexed starting from 0 (zero). -
attributeSetID
For GetProductFinder and GetProductSearchResults
property
only: Identifier for a characteristic set
(an attribute set) that is mapped to
a catalog-enabled category (unique across all eBay sites).
Required when you use SearchAttributes
(for searches based on product search page and product finder data).
Returns an error with QueryKeywords (use CharacteristicSetIDs instead).
Use GetProductSearchPage or GetProductFinder to determine valid IDs for the
type of search you are performing. -
productFinderID
Required when you are performing a sell-side product finder search.
property
(Not applicable to product search page searches.)
Numeric identifier for a sell-side product finder that was used to retrieve
the search attributes being used in the request. The product finder must be
mapped to a catalog-enabled category (i.e., it cannot be a buy-side product finder ID)
associated with the characteristics set.
Use a product finder when you want to specify multiple attributes in a
product search query. Call GetCategory2CS to determine which categories
support sell-side product finder searches. -
productID
Identifier for a representative stock product in a product family.
property
Used as input in GetProductFamilyMembers requests to identify a product family.
Use GetProductSearchResults to determine the available IDs. -
sortAttributeID
Unique identifier for a sortable attribute. Use GetProductSearchPage
property
or GetProductFinder to determine the valid sort attribute IDs for the
specified characteristic set (including the default sort attribute that will be
used if you do not specify this field). -
maxChildrenPerFamily
Pagination instruction that specifies the maximum quantity of products to return for
property
each product family within the search response whose ID matches the current request's
ID. In the response, if the last family returned contains MaxChildrenPerFamily or fewer
additional products, those additional products are also returned (i.e., the actual
quantity returned for the last family can exceed the specified maximum value). See
“Limit the Quantity of Products Returned Per Family” in the eBay Web Services Guide.
The value should not include punctuation (i.e., a thousands separator is not valid). -
searchAttributes
A predefined attribute against which to search (e.g., Author). Use this to create a
property
query based on a set of Item Specifics from the catalog. Both the product title and
product Item Specifics are searched. If the query includes multiple SearchAttributes
fields (one for each attribute), the search engine will apply “AND” logic to the query.
Call GetProductSearchPage or GetProductFinder to determine the list of valid attributes
and how many are permitted for the specified characteristic set. See the eBay Web
Services guide for details. For each ProductSearch, either SearchAttributes or
QueryKeywords is required (but do not pass both). -
pagination
Pagination instruction that specifies the virtual page of data to return
property
per search request.
When you use ExternalProductID or ProductReferenceID, only one page of
data is typically returned. -
availableItemsOnly
If true, only retrieve products that have been used to pre-fill
property
active listings on the specified eBay site.
If false, retrieve all products that match the query.
For GetProductSearchResults: Ths can be useful when
you want to find products that other sellers have recently used to
pre-fill similar listings. -
queryKeywords
One or more keywords to search for. The words “and” and “or” are treated like any other
property
word. Only use “and”, “or”, or “the” if you are searching for products containing these
words. To use AND or OR logic, use eBay’s standard search string modifiers. Wildcards
(+, -, or *) are also supported. Be careful when using spaces before or after modifiers
and wildcards.
For GetProductSearchResults:
eBay searches only in the characteristic set specified in CharacteristicSetIDs. Both
the product title and Item Specifics are searched. For each ProductSearch, either
SearchAttributes or QueryKeywords is required (but do not pass both). Blank searches
are not applicable (and result in a warning). If your search is using a Keyword
attribute returned by GetProductSearchPage, use SearchAttributes instead. -
characteristicSetIDs
List of one or more IDs that indicate which domain
property
(characteristic set) to search in.
For GetProductSearchResults: Required and
only applicable when QueryKeywords is specified. Ignored when SearchAttributes is specified. -
productReferenceID
The global reference ID for an eBay catalog product. Use this query to retrieve basic
property
details about one catalog product. The results can optionally include items, reviews,
and/or buying guides that match that product. (Specifically, the items returned are
items that sellers listed with the specified product’s stock information.)
Note:
This value is not the same as the ProductID used in AddItem and related calls. A
ProductID represents a particular version of a catalog product. (A given version
could have an older or newer description, set of Item Specifics, or other details.) A
ProductReferenceID is a more generic or global reference to a product (regardless of
version), which is useful for buy-side searching. One product reference ID can be
associated with multiple product IDs.
Some sites (such as eBay US, Germany, Austria, and Switzerland) are updating,
replacing, deleting, or merging some products (as a result of migrating from one
catalog data provider to another). If you specify one of these products, the call may
return a warning, or it may return an error if the product has been deleted.
The request requires either QueryKeywords, ProductReferenceID,
or ExternalProductID, but these fields cannot be used together. -
externalProductID
A query that only retrieves items that were listed with stock products
property
that have ISBN or UPC values (such as books, DVDs, CDs, and video game
products).
Use this query to retrieve basic details about one catalog product
(or a very limited number of products). The results can optionally
include items, reviews, and/or buying guides that match that product.
(Specifically, the items returned are items that sellers listed with the
specified product’s stock information.)
If you have gotten the ISBN or UPC from another Web site or resource,
you can use that ID. Any matching products that
include ISBN or UPC values will return those values in
Product.ExternalProductID.
The request requires either QueryKeywords, ProductReferenceID,
or ExternalProductID, but these fields cannot be used together. -
any
(public property)
property
Properties
any
(public property)
@property (nonatomic, retain) NSMutableArray *any
Discussion
(public property)
entry type : PicoAnyElement, wrapper for primitive anyelement
Declared In
Trading_ProductSearchType.h
attributeSetID
For GetProductFinder and GetProductSearchResults
only: Identifier for a characteristic set
(an attribute set) that is mapped to
a catalog-enabled category (unique across all eBay sites).
Required when you use SearchAttributes
(for searches based on product search page and product finder data).
Returns an error with QueryKeywords (use CharacteristicSetIDs instead).
Use GetProductSearchPage or GetProductFinder to determine valid IDs for the
type of search you are performing.
@property (nonatomic, retain) NSNumber *attributeSetID
Discussion
For GetProductFinder and GetProductSearchResults
only: Identifier for a characteristic set
(an attribute set) that is mapped to
a catalog-enabled category (unique across all eBay sites).
Required when you use SearchAttributes
(for searches based on product search page and product finder data).
Returns an error with QueryKeywords (use CharacteristicSetIDs instead).
Use GetProductSearchPage or GetProductFinder to determine valid IDs for the
type of search you are performing.
type : NSNumber, wrapper for primitive int
Declared In
Trading_ProductSearchType.h
availableItemsOnly
If true, only retrieve products that have been used to pre-fill
active listings on the specified eBay site.
If false, retrieve all products that match the query.
For GetProductSearchResults: Ths can be useful when
you want to find products that other sellers have recently used to
pre-fill similar listings.
@property (nonatomic, retain) NSNumber *availableItemsOnly
Discussion
If true, only retrieve products that have been used to pre-fill
active listings on the specified eBay site.
If false, retrieve all products that match the query.
For GetProductSearchResults: Ths can be useful when
you want to find products that other sellers have recently used to
pre-fill similar listings.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ProductSearchType.h
characteristicSetIDs
List of one or more IDs that indicate which domain
(characteristic set) to search in.
For GetProductSearchResults: Required and
only applicable when QueryKeywords is specified. Ignored when SearchAttributes is specified.
@property (nonatomic, retain) Trading_CharacteristicSetIDsType *characteristicSetIDs
Discussion
List of one or more IDs that indicate which domain
(characteristic set) to search in.
For GetProductSearchResults: Required and
only applicable when QueryKeywords is specified. Ignored when SearchAttributes is specified.
type : class Trading_CharacteristicSetIDsType
Declared In
Trading_ProductSearchType.h
externalProductID
A query that only retrieves items that were listed with stock products
that have ISBN or UPC values (such as books, DVDs, CDs, and video game
products).
Use this query to retrieve basic details about one catalog product
(or a very limited number of products). The results can optionally
include items, reviews, and/or buying guides that match that product.
(Specifically, the items returned are items that sellers listed with the
specified product’s stock information.)
If you have gotten the ISBN or UPC from another Web site or resource,
you can use that ID. Any matching products that
include ISBN or UPC values will return those values in
Product.ExternalProductID.
The request requires either QueryKeywords, ProductReferenceID,
or ExternalProductID, but these fields cannot be used together.
@property (nonatomic, retain) Trading_ExternalProductIDType *externalProductID
Discussion
A query that only retrieves items that were listed with stock products
that have ISBN or UPC values (such as books, DVDs, CDs, and video game
products).
Use this query to retrieve basic details about one catalog product
(or a very limited number of products). The results can optionally
include items, reviews, and/or buying guides that match that product.
(Specifically, the items returned are items that sellers listed with the
specified product’s stock information.)
If you have gotten the ISBN or UPC from another Web site or resource,
you can use that ID. Any matching products that
include ISBN or UPC values will return those values in
Product.ExternalProductID.
The request requires either QueryKeywords, ProductReferenceID,
or ExternalProductID, but these fields cannot be used together.
type : class Trading_ExternalProductIDType
Declared In
Trading_ProductSearchType.h
maxChildrenPerFamily
Pagination instruction that specifies the maximum quantity of products to return for
each product family within the search response whose ID matches the current request's
ID. In the response, if the last family returned contains MaxChildrenPerFamily or fewer
additional products, those additional products are also returned (i.e., the actual
quantity returned for the last family can exceed the specified maximum value). See
“Limit the Quantity of Products Returned Per Family” in the eBay Web Services Guide.
The value should not include punctuation (i.e., a thousands separator is not valid).
@property (nonatomic, retain) NSNumber *maxChildrenPerFamily
Discussion
Pagination instruction that specifies the maximum quantity of products to return for
each product family within the search response whose ID matches the current request's
ID. In the response, if the last family returned contains MaxChildrenPerFamily or fewer
additional products, those additional products are also returned (i.e., the actual
quantity returned for the last family can exceed the specified maximum value). See
“Limit the Quantity of Products Returned Per Family” in the eBay Web Services Guide.
The value should not include punctuation (i.e., a thousands separator is not valid).
type : NSNumber, wrapper for primitive int
Declared In
Trading_ProductSearchType.h
pagination
Pagination instruction that specifies the virtual page of data to return
per search request.
When you use ExternalProductID or ProductReferenceID, only one page of
data is typically returned.
@property (nonatomic, retain) Trading_PaginationType *pagination
Discussion
Pagination instruction that specifies the virtual page of data to return
per search request.
When you use ExternalProductID or ProductReferenceID, only one page of
data is typically returned.
type : class Trading_PaginationType
Declared In
Trading_ProductSearchType.h
productFinderID
Required when you are performing a sell-side product finder search.
(Not applicable to product search page searches.)
Numeric identifier for a sell-side product finder that was used to retrieve
the search attributes being used in the request. The product finder must be
mapped to a catalog-enabled category (i.e., it cannot be a buy-side product finder ID)
associated with the characteristics set.
Use a product finder when you want to specify multiple attributes in a
product search query. Call GetCategory2CS to determine which categories
support sell-side product finder searches.
@property (nonatomic, retain) NSNumber *productFinderID
Discussion
Required when you are performing a sell-side product finder search.
(Not applicable to product search page searches.)
Numeric identifier for a sell-side product finder that was used to retrieve
the search attributes being used in the request. The product finder must be
mapped to a catalog-enabled category (i.e., it cannot be a buy-side product finder ID)
associated with the characteristics set.
Use a product finder when you want to specify multiple attributes in a
product search query. Call GetCategory2CS to determine which categories
support sell-side product finder searches.
type : NSNumber, wrapper for primitive int
Declared In
Trading_ProductSearchType.h
productID
Identifier for a representative stock product in a product family.
Used as input in GetProductFamilyMembers requests to identify a product family.
Use GetProductSearchResults to determine the available IDs.
@property (nonatomic, retain) NSString *productID
Discussion
Identifier for a representative stock product in a product family.
Used as input in GetProductFamilyMembers requests to identify a product family.
Use GetProductSearchResults to determine the available IDs.
type : NSString, wrapper for primitive string
Declared In
Trading_ProductSearchType.h
productReferenceID
The global reference ID for an eBay catalog product. Use this query to retrieve basic
details about one catalog product. The results can optionally include items, reviews,
and/or buying guides that match that product. (Specifically, the items returned are
items that sellers listed with the specified product’s stock information.)
Note:
This value is not the same as the ProductID used in AddItem and related calls. A
ProductID represents a particular version of a catalog product. (A given version
could have an older or newer description, set of Item Specifics, or other details.) A
ProductReferenceID is a more generic or global reference to a product (regardless of
version), which is useful for buy-side searching. One product reference ID can be
associated with multiple product IDs.
Some sites (such as eBay US, Germany, Austria, and Switzerland) are updating,
replacing, deleting, or merging some products (as a result of migrating from one
catalog data provider to another). If you specify one of these products, the call may
return a warning, or it may return an error if the product has been deleted.
The request requires either QueryKeywords, ProductReferenceID,
or ExternalProductID, but these fields cannot be used together.
@property (nonatomic, retain) NSString *productReferenceID
Discussion
The global reference ID for an eBay catalog product. Use this query to retrieve basic
details about one catalog product. The results can optionally include items, reviews,
and/or buying guides that match that product. (Specifically, the items returned are
items that sellers listed with the specified product’s stock information.)
Note:
This value is not the same as the ProductID used in AddItem and related calls. A
ProductID represents a particular version of a catalog product. (A given version
could have an older or newer description, set of Item Specifics, or other details.) A
ProductReferenceID is a more generic or global reference to a product (regardless of
version), which is useful for buy-side searching. One product reference ID can be
associated with multiple product IDs.
Some sites (such as eBay US, Germany, Austria, and Switzerland) are updating,
replacing, deleting, or merging some products (as a result of migrating from one
catalog data provider to another). If you specify one of these products, the call may
return a warning, or it may return an error if the product has been deleted.
The request requires either QueryKeywords, ProductReferenceID,
or ExternalProductID, but these fields cannot be used together.
type : NSString, wrapper for primitive string
Declared In
Trading_ProductSearchType.h
productSearchID
Unique alphanumeric key help you distinguish between query results in the response.
You define the key. Each search request ID must be unique within the same call.
Primarily useful when conducting multiple searches in the same call.
If not specified, the ProductSearchResult.ID values in the response are
indexed starting from 0 (zero).
@property (nonatomic, retain) NSString *productSearchID
Discussion
Unique alphanumeric key help you distinguish between query results in the response.
You define the key. Each search request ID must be unique within the same call.
Primarily useful when conducting multiple searches in the same call.
If not specified, the ProductSearchResult.ID values in the response are
indexed starting from 0 (zero).
type : NSString, wrapper for primitive string
Declared In
Trading_ProductSearchType.h
queryKeywords
One or more keywords to search for. 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 eBay’s standard search string modifiers. Wildcards
(+, -, or *) are also supported. Be careful when using spaces before or after modifiers
and wildcards.
For GetProductSearchResults:
eBay searches only in the characteristic set specified in CharacteristicSetIDs. Both
the product title and Item Specifics are searched. For each ProductSearch, either
SearchAttributes or QueryKeywords is required (but do not pass both). Blank searches
are not applicable (and result in a warning). If your search is using a Keyword
attribute returned by GetProductSearchPage, use SearchAttributes instead.
@property (nonatomic, retain) NSString *queryKeywords
Discussion
One or more keywords to search for. 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 eBay’s standard search string modifiers. Wildcards
(+, -, or *) are also supported. Be careful when using spaces before or after modifiers
and wildcards.
For GetProductSearchResults:
eBay searches only in the characteristic set specified in CharacteristicSetIDs. Both
the product title and Item Specifics are searched. For each ProductSearch, either
SearchAttributes or QueryKeywords is required (but do not pass both). Blank searches
are not applicable (and result in a warning). If your search is using a Keyword
attribute returned by GetProductSearchPage, use SearchAttributes instead.
type : NSString, wrapper for primitive string
Declared In
Trading_ProductSearchType.h
searchAttributes
A predefined attribute against which to search (e.g., Author). Use this to create a
query based on a set of Item Specifics from the catalog. Both the product title and
product Item Specifics are searched. If the query includes multiple SearchAttributes
fields (one for each attribute), the search engine will apply “AND” logic to the query.
Call GetProductSearchPage or GetProductFinder to determine the list of valid attributes
and how many are permitted for the specified characteristic set. See the eBay Web
Services guide for details. For each ProductSearch, either SearchAttributes or
QueryKeywords is required (but do not pass both).
@property (nonatomic, retain) NSMutableArray *searchAttributes
Discussion
A predefined attribute against which to search (e.g., Author). Use this to create a
query based on a set of Item Specifics from the catalog. Both the product title and
product Item Specifics are searched. If the query includes multiple SearchAttributes
fields (one for each attribute), the search engine will apply “AND” logic to the query.
Call GetProductSearchPage or GetProductFinder to determine the list of valid attributes
and how many are permitted for the specified characteristic set. See the eBay Web
Services guide for details. For each ProductSearch, either SearchAttributes or
QueryKeywords is required (but do not pass both).
entry type : class Trading_SearchAttributesType
Declared In
Trading_ProductSearchType.h
sortAttributeID
Unique identifier for a sortable attribute. Use GetProductSearchPage
or GetProductFinder to determine the valid sort attribute IDs for the
specified characteristic set (including the default sort attribute that will be
used if you do not specify this field).
@property (nonatomic, retain) NSNumber *sortAttributeID
Discussion
Unique identifier for a sortable attribute. Use GetProductSearchPage
or GetProductFinder to determine the valid sort attribute IDs for the
specified characteristic set (including the default sort attribute that will be
used if you do not specify this field).
type : NSNumber, wrapper for primitive int
Declared In
Trading_ProductSearchType.h