Finding_FindCompletedItemsRequest Class Reference
Inherits from | Finding_BaseFindingServiceRequest : Finding_BestMatchFindingServiceRequest : Finding_BaseServiceRequest : NSObject |
Declared in | Finding_FindCompletedItemsRequest.h Finding_FindCompletedItemsRequest.m |
Overview
Request container for the findCompletedItems call.
You can expect response times for this call to be longer than other types of Finding Service
requests. The call must search through historical databases rather than performing a quick
lookup on currently listed items. There is a 5,000 limit on the number of findCompletedItems
calls an application can make in a single day (even if the application has completed an
app check).
Be aware that it is possible to use this call in such a way as to violate the terms and
conditions of your API License Agreement. Ensure that you do not store the results retrieved
from this call or use the results for market research purposes.
@ingroup FindingServicePortType
Tasks
-
keywords
Specify one or more words to use in a search query for finding items
property
on eBay. By default, queries search item titles only. When running
queries, it is best to include complete keywords values–eBay checks
words in context with each other. If you are using a URL request and
your keyword query consists of multiple words, use “%20” to separate
the words. For example, use “Harry%20Potter” to search for items
containing those words in any order. Queries aren’t case-sensitive,
so it doesn’t matter whether you use uppercase or lowercase letters.
You can incorporate wildcards in a multi-word search. For example,
“ap%20ip” returns results for “apple ipod” among other matches. The
words “and” and “or” are treated like any other word (and not their
logical connotation). Only use “and”, “or”, or “the” if you are
searching for listings containing those specific words.
findCompletedItems requires that you specify either keywords or a
categoryId in the search criteria. -
categoryId
Specifies the category from which you want to retrieve item listings.
property
This field can be repeated to include multiple categories.
If a specified category ID doesn’t match an existing category for the
site, eBay returns an invalid-category error message. To determine
valid categories, use the Shopping API <b
class=“con”>GetCategoryInfo call.
Category searches are not supported on the eBay Italy site (global ID
EBAY-IT) at this time. -
itemFilter
Reduce the number of items returned by a find request using item
property
filters. Use itemFilter to specify
name/value pairs. You can include multiple item filters in a single
request. -
aspectFilter
Aspect filters refine (limit) the number of items returned by a find
property
request. Obtain input values for aspectFilter fields from an
aspectHistogramContainer returned in the response of a previous
query.
By issuing a series of find queries, you can continually refine the
items returned in your responses. Do this by repeating a query using
the aspect values returned in one response as the input values to
your next query.
For example, the aspectHistogramContainer in a response on Men's
Shoes could contain an aspect of Size, along with “aspect values” for
the different sizes currently available in Men’s Shoes. By populating
aspectFilter fields with the values returned in an
aspectHistogramContainer, you can hone the item results returned by
your new query.
Note: If a call that specifies an
outputSelector value of
AspectHistogram returns
aspectHistogramContainer.domainName, this is a sign
that aspect histogram data might not be returned if you also specify an
aspectFilter in the next call. To ensure that
aspect histogram data is returned for the next call, add a
domainFilter to the call as well.
-
outputSelector
Defines what data to return, in addition to the default set of data,
property
in a response.
If you don’t specify this field, eBay returns a default set of item
fields. Use outputSelector to include more information in the
response. The additional data is grouped into discrete nodes. You can
specify multiple nodes by including this field multiple times, as
needed, in the request.
If you specify this field, the additional fields returned can affect
the call’s response time (performance), including in the case with
feedback data. -
domainFilter
Restricts results to items listed within the specified domain.
property
Domains are a buy-side grouping of items. such as shoes or digital
cameras. A domain can span multiple eBay categories. -
productId
Input ISBN, UPC, EAN, or ReferenceID (ePID) to specify the type of
product for which you want to search.
For example, to search using an ISBN, specify productID.type=ISBN and
set productID.value to an ISBN value. To search using an eBay Product
Reference ID, specify productID.type= ReferenceID and set
productID.value to an ePID value (also known as an Bay Product
Reference ID). If you do not know the ePID value for a product, use
FindProducts in the eBay Shopping API to retrieve the desired ePID:
<a
href=“ http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindProducts.html”
propertyFindProducts
Properties
aspectFilter
Aspect filters refine (limit) the number of items returned by a find
request. Obtain input values for aspectFilter fields from an
aspectHistogramContainer returned in the response of a previous
query.
By issuing a series of find queries, you can continually refine the
items returned in your responses. Do this by repeating a query using
the aspect values returned in one response as the input values to
your next query.
For example, the aspectHistogramContainer in a response on Men's
Shoes could contain an aspect of Size, along with “aspect values” for
the different sizes currently available in Men’s Shoes. By populating
aspectFilter fields with the values returned in an
aspectHistogramContainer, you can hone the item results returned by
your new query.
Note: If a call that specifies an
outputSelector value of
AspectHistogram returns
aspectHistogramContainer.domainName, this is a sign
that aspect histogram data might not be returned if you also specify an
aspectFilter in the next call. To ensure that
aspect histogram data is returned for the next call, add a
domainFilter to the call as well.
@property (nonatomic, retain) NSMutableArray *aspectFilter
Discussion
Aspect filters refine (limit) the number of items returned by a find
request. Obtain input values for aspectFilter fields from an
aspectHistogramContainer returned in the response of a previous
query.
By issuing a series of find queries, you can continually refine the
items returned in your responses. Do this by repeating a query using
the aspect values returned in one response as the input values to
your next query.
For example, the aspectHistogramContainer in a response on Men's
Shoes could contain an aspect of Size, along with “aspect values” for
the different sizes currently available in Men’s Shoes. By populating
aspectFilter fields with the values returned in an
aspectHistogramContainer, you can hone the item results returned by
your new query.
Note: If a call that specifies an
outputSelector value of
AspectHistogram returns
aspectHistogramContainer.domainName, this is a sign
that aspect histogram data might not be returned if you also specify an
aspectFilter in the next call. To ensure that
aspect histogram data is returned for the next call, add a
domainFilter to the call as well.
entry type : class Finding_AspectFilter
Declared In
Finding_FindCompletedItemsRequest.h
categoryId
Specifies the category from which you want to retrieve item listings.
This field can be repeated to include multiple categories.
If a specified category ID doesn’t match an existing category for the
site, eBay returns an invalid-category error message. To determine
valid categories, use the Shopping API <b
class=“con”>GetCategoryInfo call.
Category searches are not supported on the eBay Italy site (global ID
EBAY-IT) at this time.
@property (nonatomic, retain) NSMutableArray *categoryId
Discussion
Specifies the category from which you want to retrieve item listings.
This field can be repeated to include multiple categories.
If a specified category ID doesn’t match an existing category for the
site, eBay returns an invalid-category error message. To determine
valid categories, use the Shopping API <b
class=“con”>GetCategoryInfo call.
Category searches are not supported on the eBay Italy site (global ID
EBAY-IT) at this time.
entry type : NSString, wrapper for primitive string
Declared In
Finding_FindCompletedItemsRequest.h
domainFilter
Restricts results to items listed within the specified domain.
Domains are a buy-side grouping of items. such as shoes or digital
cameras. A domain can span multiple eBay categories.
@property (nonatomic, retain) NSMutableArray *domainFilter
Discussion
Restricts results to items listed within the specified domain.
Domains are a buy-side grouping of items. such as shoes or digital
cameras. A domain can span multiple eBay categories.
entry type : class Finding_DomainFilter
Declared In
Finding_FindCompletedItemsRequest.h
itemFilter
Reduce the number of items returned by a find request using item
filters. Use itemFilter to specify
name/value pairs. You can include multiple item filters in a single
request.
@property (nonatomic, retain) NSMutableArray *itemFilter
Discussion
Reduce the number of items returned by a find request using item
filters. Use itemFilter to specify
name/value pairs. You can include multiple item filters in a single
request.
entry type : class Finding_ItemFilter
Declared In
Finding_FindCompletedItemsRequest.h
keywords
Specify one or more words to use in a search query for finding items
on eBay. By default, queries search item titles only. When running
queries, it is best to include complete keywords values–eBay checks
words in context with each other. If you are using a URL request and
your keyword query consists of multiple words, use “%20” to separate
the words. For example, use “Harry%20Potter” to search for items
containing those words in any order. Queries aren’t case-sensitive,
so it doesn’t matter whether you use uppercase or lowercase letters.
You can incorporate wildcards in a multi-word search. For example,
“ap%20ip” returns results for “apple ipod” among other matches. The
words “and” and “or” are treated like any other word (and not their
logical connotation). Only use “and”, “or”, or “the” if you are
searching for listings containing those specific words.
findCompletedItems requires that you specify either keywords or a
categoryId in the search criteria.
@property (nonatomic, retain) NSString *keywords
Discussion
Specify one or more words to use in a search query for finding items
on eBay. By default, queries search item titles only. When running
queries, it is best to include complete keywords values–eBay checks
words in context with each other. If you are using a URL request and
your keyword query consists of multiple words, use “%20” to separate
the words. For example, use “Harry%20Potter” to search for items
containing those words in any order. Queries aren’t case-sensitive,
so it doesn’t matter whether you use uppercase or lowercase letters.
You can incorporate wildcards in a multi-word search. For example,
“ap%20ip” returns results for “apple ipod” among other matches. The
words “and” and “or” are treated like any other word (and not their
logical connotation). Only use “and”, “or”, or “the” if you are
searching for listings containing those specific words.
findCompletedItems requires that you specify either keywords or a
categoryId in the search criteria.
type : NSString, wrapper for primitive string
Declared In
Finding_FindCompletedItemsRequest.h
outputSelector
Defines what data to return, in addition to the default set of data,
in a response.
If you don’t specify this field, eBay returns a default set of item
fields. Use outputSelector to include more information in the
response. The additional data is grouped into discrete nodes. You can
specify multiple nodes by including this field multiple times, as
needed, in the request.
If you specify this field, the additional fields returned can affect
the call’s response time (performance), including in the case with
feedback data.
@property (nonatomic, retain) NSMutableArray *outputSelector
Discussion
Defines what data to return, in addition to the default set of data,
in a response.
If you don’t specify this field, eBay returns a default set of item
fields. Use outputSelector to include more information in the
response. The additional data is grouped into discrete nodes. You can
specify multiple nodes by including this field multiple times, as
needed, in the request.
If you specify this field, the additional fields returned can affect
the call’s response time (performance), including in the case with
feedback data.
entry type : string constant in Finding_OutputSelectorType.h
Declared In
Finding_FindCompletedItemsRequest.h
productId
Input ISBN, UPC, EAN, or ReferenceID (ePID) to specify the type of
product for which you want to search.
For example, to search using an ISBN, specify productID.type=ISBN and
set productID.value to an ISBN value. To search using an eBay Product
Reference ID, specify productID.type= ReferenceID and set
productID.value to an ePID value (also known as an Bay Product
Reference ID). If you do not know the ePID value for a product, use
FindProducts in the eBay Shopping API to retrieve the desired ePID:
<a
href=“ http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindProducts.html”
FindProducts
@property (nonatomic, retain) Finding_ProductId *productId
Discussion
Input ISBN, UPC, EAN, or ReferenceID (ePID) to specify the type of
product for which you want to search.
For example, to search using an ISBN, specify productID.type=ISBN and
set productID.value to an ISBN value. To search using an eBay Product
Reference ID, specify productID.type= ReferenceID and set
productID.value to an ePID value (also known as an Bay Product
Reference ID). If you do not know the ePID value for a product, use
FindProducts in the eBay Shopping API to retrieve the desired ePID:
<a
href=“ http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindProducts.html”
FindProducts
type : class Finding_ProductId
Declared In
Finding_FindCompletedItemsRequest.h