eBay::API::XML::Call::GetSearchResults::GetSearchResultsRequestType(3)

NAME
eBay::API::XML::Call::GetSearchResults::GetSearchResultsRequestType

DESCRIPTION
Retrieves item listings based on keywords you specify. The keywords can include wildcards. <br> <br> It is recommended that you consider using FindItemsAdvanced (in the Shopping API) instead of GetSearchResults because FindItemsAdvanced is easier to use and faster. See <a href="http://developer.ebay.com/products/shopping/" target="_blank">Shopping AP/a for more information. <br> <br> The response is in the form of an array whose size and contents you specify, using a variety of input fields. You can filter the item listings returned using such criteria as the listing category, location, whether the item is listed in an ebay Store, and listing type. You can include or exclude specified sellers. <br> <br> The call returns those item listings where the keywords appear in the title, subtitle, and (optionally) the description. Some input fields (e.g., Query) are primary search criteria that let you specify data to match in listings. For example, you can search for all listings that include the word "Toy" in the title. <br> <br> Some fields (e.g., ItemTypeFilter) are secondary search criteria that let you further refine data to match in listings. For example, you can search for all toys that are listed as auctions. In general, the effect of secondary search fields is cumulative (using "AND" logic) unless otherwise specified. Some fields (e.g., TotalOnly) control what is actually returned in the result set. For example, you can search for all toys that are listed as Chinese auctions, but just retrieve the total count (not the listings themselves). <br> <br> Some fields (e.g., IncludeCondition) affect the data to retrieve for each listing in the result set. For example, for each toy returned in the result, you can also choose to see the toy's new or used condition. <br> <br> Some fields (e.g., Order) control the way the listings are organized in the response. For example, you can retrieve all the toy listings in chronological order, with the newest one first. Use the DetailLevel ItemReturnCategories to return the primary category and, if applicable, the secondary category. <br> <br> Use a DetailLevel value of ItemReturnAttributes (or ReturnAll) to return summary Item Specifics (only returned for categories that support summary Item Specifics in search results). <br><br>Not applicable to eBay Express or Half.com.

SYNOPSIS

INHERITANCE
eBay::API::XML::Call::GetSearchResults::GetSearchResultsRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

  setAdFormat()
Restricts listings to return only items that have the Ad Format feature. If true, the values of ItemTypeFilter and StoreSearchFilter are ignored (if they are specified). That is, "AND" logic is not applied.

  RequiredInput: No
#    Argument: 'xs:boolean'

  isAdFormat()
# Returns: 'xs:boolean'

  setAffiliateTrackingDetails()
Container for affiliate tags. If you use affiliate tags, it is possible to get affiliate commissions based on calls made by your application. (See the <a href="https://www.ebaypartnernetwork.com/" target="_blank">eBay Partner Network</a> for information about commissions.) Affiliate tags enable the tracking of user activity. You can use child tags of AffiliateTrackingDetails if you want call output to include a string that includes affiliate tracking information.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AffiliateTrackingConcepts Title: Affiliate Tracking Concepts

  RequiredInput: No
#    Argument: 'ns:AffiliateTrackingDetailsType'

  getAffiliateTrackingDetails()
# Returns: 'ns:AffiliateTrackingDetailsType'

  setBidRange()
Limits the results to items with a minimum or maximum number of bids. You also can specify a bid range by specifying both a minimum and maximum number of bids in one call.

  RequiredInput: No
#    Argument: 'ns:BidRangeType'

  getBidRange()
# Returns: 'ns:BidRangeType'

  setCategories()
Retrieves statistical (histogram) information about categories that contain items that match the query. Can also cause the result to include information about buying guides that are associated with the matching categories. Does not control the set of listings to return or the details to return for each listing.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingForMatchingCategories Title: Searching for Matching Categories

  RequiredInput: No
#    Argument: 'ns:RequestCategoriesType'

  getCategories()
# Returns: 'ns:RequestCategoriesType'

  setCategoryID()
Limits the result set to items in the specified category. If no category ID is specified, all categories are searched by default.<br> <br> <span class="tablenote"><b>Note:</b> CategoryID does not control whether you will see the item's categories in the response. Set the value of DetailLevel to ItemReturnCategories to retrieve each item's primary category and secondary category (if any) in the response.</span><br> <br> If the specified category ID doesn't match an existing category for the site, an invalid-category error message is returned. Here are a few ways to determine valid categories:<br> - Use the Categories input field to retrieve matching categories, and then submit the request again with one of those categories.<br> - Find items in all categories but set DetailLevel to ItemReturnCategories, determine the primary (or secondary) category ID for a similar item in the results, and then submit the request again with that category ID.<br> - Use another call like GetCategories or GetSuggestedCategories to find a valid category ID.<br> <br> You must pass ProductID, Query, ExternalProductID, or CategoryID in the request. CategoryID can be used in combination with Query. It is not allowed with ExternalProductID or ProductID. If you pass CategoryID without Query, it must specify a leaf category ID. That is, it cannot be a meta-category ID (e.g., 267 for "Books").

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByCategoryID Title: Searching by Category ID MaxLength: 10

  RequiredInput: Conditionally
#    Argument: 'xs:string'

  getCategoryID()
# Returns: 'xs:string'

  setCharityID()
Restricts listings to return only items that support the specified nonprofit charity organization. Retrieve CharityID values with GetCharities.

  RequiredInput: No
#    Argument: 'xs:int'

  getCharityID()
# Returns: 'xs:int'

  setEndTimeFrom()
Limits the results to items ending within a time range. EndTimeFrom specifies the beginning of the time range. Specify a time in the future. If you specify a time in the past, the current time is used. If specified, EndTimeTo must also be specified (with a value equal to or later than EndTimeFrom). Express the time in GMT. Cannot be used with the ModTimeFrom filter.

  RequiredInput: Conditionally
#    Argument: 'xs:dateTime'

  getEndTimeFrom()
# Returns: 'xs:dateTime'

  setEndTimeTo()
Limits the results to items ending within a time range. EndTimeTo specifies the end of the time range. If specified, EndTimeFrom must also be specified (with a value equal to or earlier than EndTimeTo). Express the time in GMT. Cannot be used with the ModTimeFrom filter.

  RequiredInput: Conditionally
#    Argument: 'xs:dateTime'

  getEndTimeTo()
# Returns: 'xs:dateTime'

  setExpandSearch()
Expands search results when a small result set is returned. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, then if you specify true for this tag, the search results are expanded. Specifically, the search returns items (if there are matches) in one or more of the following containers: InternationalExpansionArray (for items available from international sellers), FilterRemovedExpansionArray (items that would be returned if filters such as PriceRangeFilter are removed), StoreExpansionArray (for items listed in the Store Inventory Format), and AllCategoriesExpansionArray (for items available if category filters are removed). Maximum number of items returned in each expansion container is 6 to 10.

  RequiredInput: No
#    Argument: 'xs:boolean'

  isExpandSearch()
# Returns: 'xs:boolean'

  setExternalProductID()
An exclusive query to only retrieve items that were listed with the specified ISBN or UPC. Only applicable for items that were listed with Pre-filled Item Information in media categories (Books, Music, DVDs and Movies, and Video Games). You must pass ProductID, Query, ExternalProductID, or CategoryID in the request. If you use ExternalProductID, do not use Query, ProductID, or CategoryID.

  RequiredInput: Conditionally
#    Argument: 'ns:ExternalProductIDType'

  getExternalProductID()
# Returns: 'ns:ExternalProductIDType'

  setFreeShipping()
If true, only items with free shipping for the user's location are returned. The user's location is determined from the site ID specified in the request. If false, no filtering is done via this attribute. A listing is not considered a free shipping listing if it requires insurance or requires pick up or requires a shipping surcharge.

Default: false

  RequiredInput: No
#    Argument: 'xs:boolean'

  isFreeShipping()
# Returns: 'xs:boolean'

  setGranularityLevel()
Optional tag that currently accepts only one value for this call: Coarse. Other values return an error. If you specify Coarse, the call returns the fields shown in the <a href="#GranularityLevel">GranularityLevel table</a> plus any tags resulting from the detail level you specify. Controls the fields to return for each listing (not the set of listings that match the query).

PresentDetails: Yes

  RequiredInput: No
#    Argument: 'ns:GranularityLevelCodeType'

  getGranularityLevel()
# Returns: 'ns:GranularityLevelCodeType'

  setGroup()
You can group Best Match search results by category by specifying BestMatchCategoryGroup in the Order field. When you specify BestMatchCategoryGroup in the Order field, you can also specify Group.MaxEntriesPerGroup and/or Group.MaxGroups. When you specify BestMatchCategoryGroup in the Order field, there will be fewer results returned because Best Matches in lower-level (leaf) categories and higher-level categories are taken into account. There is not a direct correlation between the number of items returned in a regular sort (or in a BestMatch sort) and the number of items that are returned when you specify BestMatchCategoryGroup in the Order field. When you specify BestMatchCategoryGroup in the Order field, not more than 2 pages of results are returned. See also the GroupCategoryID element in ItemType.

  RequiredInput: No
#    Argument: 'ns:GroupType'

  getGroup()
# Returns: 'ns:GroupType'

  setIncludeCondition()
If true, each item in the result set can also include the item condition (e.g., New or Used) in the ItemSpecific property of the response. An item only includes the condition in the response if the seller filled in the Item Condition in the Item Specifics section of the listing. (That is, the condition is not returned if the seller only put the word "New" in the listing's title.) <br> <br> Controls the details to return for each listing (not the set of listings that match the query). <br> <br>To control whether to retrieve only new or used items, see ItemCondition (or SearchRequest).

  RequiredInput: No
#    Argument: 'xs:boolean'

  isIncludeCondition()
# Returns: 'xs:boolean'

  setIncludeFeedback()
If true, each item in the result set also includes information about the seller's feedback. Controls the details to return for each listing (not the set of listings that match the query). <br> For GetSearchResults, if set to true will also return the seller's User ID.

  RequiredInput: No
#    Argument: 'xs:boolean'

  isIncludeFeedback()
# Returns: 'xs:boolean'

  setIncludeGetItFastItems()
When passed with a value of true, limits the results to Get It Fast listings.

  RequiredInput: No
#    Argument: 'xs:boolean'

  isIncludeGetItFastItems()
# Returns: 'xs:boolean'

  setItemCondition()
Limits the results to new or used items, plus items that have no condition specified.<br> <br> Matches the new or used condition that the seller specified in the Item Specifics section of the listing. (That is, this won't specifically match on items where the seller only put the word "New" in the listing's title.)<br> <br> Only applicable to sites and categories that support a sitewide (global) item condition. For example, the US site does not currently support this. See GetCategory2CS. To search for the item condition on the US site, use a product finder instead (see SearchRequest).

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ItemCondition Title: Specifying an Item's Condition , URL: GetSearchResults.html#Request.SearchRequest Title: (GetSearchResults) SearchRequest , URL: GetSearchResults.html#Request.IncludeCondition Title: (GetSearchResults) IncludeCondition

  RequiredInput: No
#    Argument: 'ns:ItemConditionCodeType'

  getItemCondition()
# Returns: 'ns:ItemConditionCodeType'

  setItemTypeFilter()
Filters items based on the ListingType set for the items. If ItemTypeFilter is not specified (or if the AllItemTypes value of ItemTypeFilter is specified), all listing types can be returned unless another relevant filter is specified. You cannot use GetSearchResults to search eBay Express.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByListingType Title: Searching By Listing Type

  RequiredInput: No
  Default: AllItems
#    Argument: 'ns:ItemTypeFilterCodeType'

  getItemTypeFilter()
# Returns: 'ns:ItemTypeFilterCodeType'

  setLocalSearchPostalCode()
Include local items in returning results near this postal code. This postal code is the basis for local search.

  RequiredInput: No
#    Argument: 'xs:string'

  getLocalSearchPostalCode()
# Returns: 'xs:string'

  setLot()
Limits the results to only those listings for which Item.LotSize is 2 or greater.

  RequiredInput: No
#    Argument: 'xs:boolean'

  isLot()
# Returns: 'xs:boolean'

  setMaxRelatedSearchKeywords()
The maximum number of related keywords to be retrieved. Use this field if you want the search results to include recommended keywords (that is, keywords matching one or more of the original keywords) in a RelatedSearchKeywordArray container. A value of 0 (the default) means no related search information is processed.

Max: 100 Min: 0

  RequiredInput: No
#    Argument: 'xs:int'

  getMaxRelatedSearchKeywords()
# Returns: 'xs:int'

  setModTimeFrom()
Limits the results to active items whose status has changed since the specified time. Specify a time in the past. Time must be in GMT. Cannot be used with the EndTime filters.

  RequiredInput: No
#    Argument: 'xs:dateTime'

  getModTimeFrom()
# Returns: 'xs:dateTime'

  setMotorsGermanySearchable()
Limits the results based on each item's eligibility to appear on the mobile.de site. If false, excludes eligible items from search results. If true, queries for eligible items only. If not specified, the search results are not affected. Only applicable for items listed on the eBay Germany site (site ID 77) in subcategories of mobile.de search-enabled categories.

  RequiredInput: No
#    Argument: 'xs:boolean'

  isMotorsGermanySearchable()
# Returns: 'xs:boolean'

  setOrder()
Specifies the order in which listings are returned in a result set. Listings may be sorted by end time, start time, and in other ways listed in the SearchSortOrderCodeType. Controls the way the listings are organized in the response (not the details to return for each listing). For most sites, the default sort order is by items ending soonest. Store Inventory listings are usually returned after other listing types, regardless of the sort order.

Default: BestMatchSort

  RequiredInput: No
#    Argument: 'ns:SearchSortOrderCodeType'

  getOrder()
# Returns: 'ns:SearchSortOrderCodeType'

  setPagination()
Controls the pagination of the result set. Child elements specify the maximum number of item listings to return per call and which page of data to return. Controls the way the listings are organized in the response (not the details to return for each listing).

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PaginatingSearchResults Title: Paginating Search Results

  RequiredInput: No
#    Argument: 'ns:PaginationType'

  getPagination()
# Returns: 'ns:PaginationType'

  setPaymentMethod()
Limits the results to items that accept a specific payment method or methods.

  RequiredInput: No
#    Argument: 'ns:PaymentMethodSearchCodeType'

  getPaymentMethod()
# Returns: 'ns:PaymentMethodSearchCodeType'

  setPriceRangeFilter()
Limits the result set to just those items where the price is within the specified range. The PriceRangeFilterType includes a minimum and a maximum price.

  RequiredInput: No
#    Argument: 'ns:PriceRangeFilterType'

  getPriceRangeFilter()
# Returns: 'ns:PriceRangeFilterType'

  setProductID()
An exclusive query to retrieve items that were listed with the specified eBay catalog product. You must pass ProductID, Query, ExternalProductID, or CategoryID in the request. If you use ProductID, do not use Query, ExternalProductID, or CategoryID.<br> <br> As of mid-2008, 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.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByProductID Title: Searching for Listings by ProductID

  RequiredInput: Conditionally
#    Argument: 'xs:string'

  getProductID()
# Returns: 'xs:string'

  setProximitySearch()
Limits the result set to just those items whose location is within a specified distance of a postal code. The ProximitySearchType includes a maximum distance and a postal code.

  RequiredInput: No
#    Argument: 'ns:ProximitySearchType'

  getProximitySearch()
# Returns: 'ns:ProximitySearchType'

  setQuantity()
Limits the results to listings that offer a certain number of items matching the query. If Lot is also specified, then Quantity is the number of lots multiplied by the number of objects in each lot. Use QuantityOperator to specify that you are seeking listings with quantities greater than, equal to, or less than Quantity.

  RequiredInput: No
#    Argument: 'xs:int'

  getQuantity()
# Returns: 'xs:int'

  setQuantityOperator()
Limits the results to listings with quantities greater than, equal to, or less than Quantity. Controls the set of listings to return (not the details to return for each listing).

  RequiredInput: No
#    Argument: 'ns:QuantityOperatorCodeType'

  getQuantityOperator()
# Returns: 'ns:QuantityOperatorCodeType'

  setQuery()
A query that specifies a search string. The search string consists of one or more keywords to search for in the listing title and/or description. The words "and" and "or" are treated like any other word. Only use "and", "or", or "the" if you are searching for listings containing these words. You can use AND or OR logic by including certain modifiers. Wildcards (e.g., *) are also supported. Be careful when using spaces before or after modifiers and wildcards (+, -, or *). See the
eBay Web Services Guide    for a list of valid modifiers and examples.
Query is not applicable in combination with ExternalProductID or ProductID.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByKeywords Title: Searching by Keywords MaxLength: 350 (characters)

  RequiredInput: Conditionally
#    Argument: 'xs:string'

  getQuery()
# Returns: 'xs:string'

  setSearchFlags()
Secondary search criterion that checks item descriptions for keywords that match the query, limits the search results to only charity items, limits the result set to those items with PayPal as a payment method, and/or provides other criteria to refine the search.

  RequiredInput: No
#    Argument: reference to an array
                      of 'ns:SearchFlagsCodeType'

  getSearchFlags()
# Returns: reference to an array
                      of 'ns:SearchFlagsCodeType'

  setSearchLocationFilter()
Limits the result set to just those items that meet location criteria: listed in a specified eBay site, location where the seller has the item, location from which the user is searching, and/or items listed with a specified currency. You cannot use GetSearchResults to search eBay Express.

  RequiredInput: No
#    Argument: 'ns:SearchLocationFilterType'

  getSearchLocationFilter()
# Returns: 'ns:SearchLocationFilterType'

  setSearchRequest()
A query consisting of a set of attributes (Item Specifics). Use this kind of query to search against the Item Specifics in listings (e.g., to search for a particular shoe size). If the query includes multiple attributes, the search engine will apply "AND" logic to the query and narrow the results. Use GetProductFinder to determine the list of valid attributes and how many are permitted for the specified characteristic set. Retrieves items along with any buying guide details that are associated with the specified product finder. Applicable in combination with the Query argument. Cannot be used in combination with ProductID or ExternalProductID.<br> <br> If you are searching for tickets, see TicketFinder instead.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByItemSpecifics Title: Searching by Item Specifics (Buy-Side Product Finder) , URL: CallName.html#Request.TicketFinder Title: (GetSearchResults) TicketFinder

  RequiredInput: No
#    Argument: 'ns:SearchRequestType'

  getSearchRequest()
# Returns: 'ns:SearchRequestType'

  setSearchType()
Limits the listings in the result set based on whether they are in the Gallery. The choices are items in the Gallery or Gallery and non-Gallery items.

  RequiredInput: No
#    Argument: 'ns:SearchTypeCodeType'

  getSearchType()
# Returns: 'ns:SearchTypeCodeType'

  setSellerBusinessType()
Limits the results to those of a particular seller business type such as commercial or private.

  RequiredInput: No
#    Argument: 'ns:SellerBusinessCodeType'

  getSellerBusinessType()
# Returns: 'ns:SellerBusinessCodeType'

  setStoreSearchFilter()
Limits the result set to just those items that meet criteria related to eBay Stores sellers and eBay Stores. Use this to retrieve items listed in a particular seller's eBay Store or in all store sellers' eBay Stores. This filter always causes item description text to be searched with the string specified in the Query field. That is, StoreSearchFilter forces the type of search that would have occurred if you had specified SearchInDescription in the SearchFlags field.

  RequiredInput: No
#    Argument: 'ns:SearchStoreFilterType'

  getStoreSearchFilter()
# Returns: 'ns:SearchStoreFilterType'

  setTicketFinder()
Searches for event ticket listings only. If specified, this cannot be empty. For example, to search for all tickets (with no event, date, city, or quantity constraints), specify EventType with a value of Any. If specified, Query is optional. Query is useful when the user wants to search for a particular event name (like "eric clapton") or a venue that might be included in the listing title. If TicketFinder and SearchRequest are both specified in the same request, SearchRequest is ignored.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=TicketFinder Title: Performing a Simple Ticket Finder Search

  RequiredInput: No
#    Argument: 'ns:TicketDetailsType'

  getTicketFinder()
# Returns: 'ns:TicketDetailsType'

  setTotalOnly()
Retrieves the total quantity of matching items, without returning the item data. See PaginationResult.TotalNumberOfEntries in the response. If TotalOnly and Categories.CategoriesOnly are both specified in the request and their values are inconsistent with each other, TotalOnly overrides Categories.CategoriesOnly. That is, if TotalOnly is true and Categories.CategoriesOnly is false, the results include matching categories but no item data or buying guides. If TotalOnly is false and Categories.CategoriesOnly is true, the results include matching categories, item data, and buying guides. If TotalOnly is not specified, it has no logical effect.

  RequiredInput: No
#    Argument: 'xs:boolean'

  isTotalOnly()
# Returns: 'xs:boolean'

  setUserIdFilter()
Limits the the result set to just those items listed by one or more specified sellers or those items not listed by the one or more specified sellers.

  RequiredInput: No
#    Argument: 'ns:UserIdFilterType'

  getUserIdFilter()
# Returns: 'ns:UserIdFilterType'