User Manual

Chapter 1: Using the REST API 25
Legacy REST GetSearchResults Input
Version 3.7
The following table describes major legacy input parameters for GetSearchResults in the REST API.
Table 1-5 Legacy GetSearchResults Input Parameters (See “GetSearchResults
Input Parameters” on page 10)
Parameter Required? Data Type Purpose
Category Y/N Integer Numeric ID of the category to be searched. Defaults to all
categories if zero (0) is specified or the tag is not present. If the
specified category ID does not match an existing category for
the site, an invalid-category error message is returned.
CompatibilityLevel Y String Specifies the API version you are using for the call. If data
returned is different from expected, test your call using a
higher version, such as 491.
CharityListing N Boolean If 1 (true), limits the results to Giving Works listings (and no
other listings). If 0 (false), has no effect on the search results
(i.e., the behavior is the same as not sending CharityListing at
all). Not applicable (returns 0 items) for eBay Motors,
international sites, and Real Estate and Tickets listings.
Currency N Integer Numeric ID for a currency type. Limits the search to just those
items listed using a specified currency. Not applicable to eBay
Motors searches.
DetailLevel N Integer Controls the amount of data returned.
EndTimeFrom N Time Specifies the beginning of a time range for when items will end.
EndTimeTo N Time Specifies the end of a time range for when items will end.
ErrorLanguage N Integer Corresponds to a Site ID. If specified, returns any error
messages in the language associated with the Site ID.
ExcludeSellers N String Excludes the specified sellers from the search. Use a seller's
User ID. Separate multiple sellers with a comma. A maximum
of 100 sellers can be listed. Cannot be used with
IncludeSellers and PayPal parameters. StoreSearch
overrides ExcludeSellers.
ExpandSearch N Boolean Expands search results when a small set is returned.
ExternalProductIden
tifier
N Meta Tag Do not use the Query parameter with this parameter.
ExternalProductIdentifier only retrieves items that were listed
with the specified ISBN or UPC. Only applicable for items with
Pre-filled Item Information in media categories such as Books
and Music.
In the REST API, you can use XPATH for parameters that are
containers or have attributes (such as the
ExternalProductIdentifier parameter). In the case of
ExternalProductIdentifier, id and type are attributes because
ExternalProductIdentifier is defined as
<ExternalProductIdentifier id="value" type="value" />. An
example of using XPATH is the following search for an ISBN of
0811645169:
CallName=GetSearchResults&ExternalProductIdentifier@type
=ISBN&ExternalProductIdentifier@id=0811645169.
GranularityLevel N String Reduces the number of tags returned for items.
HighestPrice N Money The highest price in the Current Price field that any item
returned by the Search results should have.