Inherits from Finding_BaseFindingServiceRequest : Finding_BestMatchFindingServiceRequest : Finding_BaseServiceRequest : NSObject
Declared in Finding_FindItemsAdvancedRequest.h
Finding_FindItemsAdvancedRequest.m

Overview

Request container for the findItemsAdvanced call.

@ingroup FindingServicePortType

Tasks

  •   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.



    findItemsAdvanced requires that you
    specify keywords and/or a <b
    class=“con”>categoryId in the request. The exception to
    this rule is when the Seller item filter is used. The Seller item
    filter can be used without specifying either
    keywords
    or categoryId to
    retrieve all active items for the specified seller.


    property
  •   categoryId

    Specifies the category from which you want to retrieve item listings.
    This field can be repeated to include multiple categories. Up to
    three (3) categories can be specified.



    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.



    findItemsAdvanced requires that you
    specify keywords and/or a <b
    class=“con”>categoryId in the request. The exception to
    this rule is when the Seller item filter is used. The Seller item
    filter can be used without specifying either
    keywords
    or categoryId to
    retrieve all active items for the specified seller.



    Category searches are not supported on the eBay Italy site (global ID
    EBAY-IT) at this time.

    property
  •   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
  •   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 refine 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
  •   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
  •   descriptionSearch

    Specifies whether your keyword query should be applied to item
    descriptions in addition to titles. Searching the text of item
    descriptions incurs a performance hit (it can take longer than
    searches that don’t include description searches). If true, the text
    of the item’s description and subtitles will be included in the
    search. If false, only item titles are included in keyword searches.

    property
  •   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

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 refine 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 refine 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_FindItemsAdvancedRequest.h

categoryId

Specifies the category from which you want to retrieve item listings.
This field can be repeated to include multiple categories. Up to
three (3) categories can be specified.



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.



findItemsAdvanced requires that you
specify keywords and/or a <b
class=“con”>categoryId in the request. The exception to
this rule is when the Seller item filter is used. The Seller item
filter can be used without specifying either
keywords
or categoryId to
retrieve all active items for the specified seller.



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. Up to
three (3) categories can be specified.



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.



findItemsAdvanced requires that you
specify keywords and/or a <b
class=“con”>categoryId in the request. The exception to
this rule is when the Seller item filter is used. The Seller item
filter can be used without specifying either
keywords
or categoryId to
retrieve all active items for the specified seller.



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_FindItemsAdvancedRequest.h

descriptionSearch

Specifies whether your keyword query should be applied to item
descriptions in addition to titles. Searching the text of item
descriptions incurs a performance hit (it can take longer than
searches that don’t include description searches). If true, the text
of the item’s description and subtitles will be included in the
search. If false, only item titles are included in keyword searches.

@property (nonatomic, retain) NSNumber *descriptionSearch

Discussion

Specifies whether your keyword query should be applied to item
descriptions in addition to titles. Searching the text of item
descriptions incurs a performance hit (it can take longer than
searches that don’t include description searches). If true, the text
of the item’s description and subtitles will be included in the
search. If false, only item titles are included in keyword searches.

type : NSNumber, wrapper for primitive bool

Declared In

Finding_FindItemsAdvancedRequest.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_FindItemsAdvancedRequest.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_FindItemsAdvancedRequest.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.



findItemsAdvanced requires that you
specify keywords and/or a <b
class=“con”>categoryId in the request. The exception to
this rule is when the Seller item filter is used. The Seller item
filter can be used without specifying either
keywords
or categoryId to
retrieve all active items for the specified seller.


@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.



findItemsAdvanced requires that you
specify keywords and/or a <b
class=“con”>categoryId in the request. The exception to
this rule is when the Seller item filter is used. The Seller item
filter can be used without specifying either
keywords
or categoryId to
retrieve all active items for the specified seller.


type : NSString, wrapper for primitive string

Declared In

Finding_FindItemsAdvancedRequest.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_FindItemsAdvancedRequest.h