GetSearchResults - Call Reference - eBay Trading Web Services

GetSearchResults

Retrieves item listings based on keywords you specify. The keywords can include wildcards.

It is recommended that you consider using FindItemsAdvanced (in the Shopping API) instead of GetSearchResults because FindItemsAdvanced is easier to use and faster. See Shopping API for more information.

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.

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.

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

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.

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.

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

Not applicable to eBay Express or Half.com.

See:
    Searching for Items by Using a Query
    Introduction to Pictures in Item Listings
    GetSearchResults
    Search Type Differences

GetSearchResults Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetSearchResultsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <DetailLevel> DetailLevelCodeType </DetailLevel>
  <!-- ... more DetailLevel nodes here ... -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <OutputSelector> string </OutputSelector>
  <!-- ... more OutputSelector nodes here ... -->
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <AdFormat> boolean </AdFormat>
  <AffiliateTrackingDetails> AffiliateTrackingDetailsType 
    <AffiliateUserID> string </AffiliateUserID>
    <TrackingID> string </TrackingID>
    <TrackingPartnerCode> string </TrackingPartnerCode>
  </AffiliateTrackingDetails>
  <BidRange> BidRangeType 
    <MaximumBidCount> int </MaximumBidCount>
    <MinimumBidCount> int </MinimumBidCount>
  </BidRange>
  <Categories> RequestCategoriesType 
    <CategoriesOnly> boolean </CategoriesOnly>
    <DemandData> boolean </DemandData>
    <Levels> int </Levels>
    <MaxCategories> int </MaxCategories>
    <MaxSubcategories> int </MaxSubcategories>
  </Categories>
  <CategoryID> string </CategoryID>
  <CharityID> int </CharityID>
  <EndTimeFrom> dateTime </EndTimeFrom>
  <EndTimeTo> dateTime </EndTimeTo>
  <ExpandSearch> boolean </ExpandSearch>
  <ExternalProductID> ExternalProductIDType 
    <Type> ExternalProductCodeType </Type>
    <Value> string </Value>
  </ExternalProductID>
  <FreeShipping> boolean </FreeShipping>
  <GranularityLevel> GranularityLevelCodeType </GranularityLevel>
  <Group> GroupType 
    <MaxEntriesPerGroup> int </MaxEntriesPerGroup>
    <MaxGroups> int </MaxGroups>
  </Group>
  <HideDuplicateItems> boolean </HideDuplicateItems>
  <IncludeCondition> boolean </IncludeCondition>
  <IncludeFeedback> boolean </IncludeFeedback>
  <IncludeGetItFastItems> boolean </IncludeGetItFastItems>
  <ItemCondition> ItemConditionCodeType </ItemCondition>
  <ItemTypeFilter> ItemTypeFilterCodeType </ItemTypeFilter>
  <LocalSearchPostalCode> string </LocalSearchPostalCode>
  <Lot> boolean </Lot>
  <MaxRelatedSearchKeywords> int </MaxRelatedSearchKeywords>
  <ModTimeFrom> dateTime </ModTimeFrom>
  <MotorsGermanySearchable> boolean </MotorsGermanySearchable>
  <Order> SearchSortOrderCodeType </Order>
  <Pagination> PaginationType 
    <EntriesPerPage> int </EntriesPerPage>
    <PageNumber> int </PageNumber>
  </Pagination>
  <PaymentMethod> PaymentMethodSearchCodeType </PaymentMethod>
  <PriceRangeFilter> PriceRangeFilterType 
    <MaxPrice> AmountType (double) </MaxPrice>
    <MinPrice> AmountType (double) </MinPrice>
  </PriceRangeFilter>
  <ProductID> string </ProductID>
  <ProximitySearch> ProximitySearchType 
    <MaxDistance> int </MaxDistance>
    <PostalCode> string </PostalCode>
  </ProximitySearch>
  <Quantity> int </Quantity>
  <QuantityOperator> QuantityOperatorCodeType </QuantityOperator>
  <Query> string </Query>
  <SearchFlags> SearchFlagsCodeType </SearchFlags>
  <!-- ... more SearchFlags nodes here ... -->
  <SearchLocationFilter> SearchLocationFilterType 
    <CountryCode> CountryCodeType </CountryCode>
    <Currency> CurrencyCodeType </Currency>
    <ItemLocation> ItemLocationCodeType </ItemLocation>
    <SearchLocation> SearchLocationType 
      <RegionID> string </RegionID>
      <SiteLocation> SiteLocationType 
        <SiteID> SiteIDFilterCodeType </SiteID>
      </SiteLocation>
    </SearchLocation>
  </SearchLocationFilter>
  <SearchRequest> SearchRequestType 
    <ProductFinderID> int </ProductFinderID>
    <SearchAttributes> SearchAttributesType 
      <AttributeID> int </AttributeID>
      <DateSpecifier> DateSpecifierCodeType </DateSpecifier>
      <RangeSpecifier> RangeCodeType </RangeSpecifier>
      <ValueList> ValType 
        <ValueID> int </ValueID>
        <ValueLiteral> string </ValueLiteral>
      </ValueList>
      <!-- ... more ValueList nodes here ... -->
    </SearchAttributes>
    <!-- ... more SearchAttributes nodes here ... -->
  </SearchRequest>
  <SearchType> SearchTypeCodeType </SearchType>
  <SellerBusinessType> SellerBusinessCodeType </SellerBusinessType>
  <StoreSearchFilter> SearchStoreFilterType 
    <StoreName> string </StoreName>
    <StoreSearch> StoreSearchCodeType </StoreSearch>
  </StoreSearchFilter>
  <TicketFinder> TicketDetailsType 
    <CityName> string </CityName>
    <EventDate> DateType 
      <Day> int </Day>
      <Month> int </Month>
      <Year> int </Year>
    </EventDate>
    <EventType> TicketEventTypeCodeType </EventType>
    <StateOrProvince> string </StateOrProvince>
    <TicketQuantity> int </TicketQuantity>
  </TicketFinder>
  <TotalOnly> boolean </TotalOnly>
  <UserIdFilter> UserIdFilterType 
    <ExcludeSellers> UserIDType (string) </ExcludeSellers>
    <IncludeSellers> UserIDType (string) </IncludeSellers>
  </UserIdFilter>
</GetSearchResultsRequest>

Argument	Type	Reqd?	Meaning
Standard Input Fields [Jump to call-specific fields]
DetailLevel	DetailLevelCodeType (repeatable)	Optional	Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request. The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.) Note that DetailLevel is required input for GetMyMessages. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. Applicable values: • ItemReturnAttributes (in) For GetItem, returns Item Specifics and Pre-filled Item Information, if any. For GetSearchResults, only returns Item Specifics (if any) that are applicable to search results, and only under certain conditions. See the description of Item.AttributeSetArray for details about the effects for applicable calls. Also see the description of Item.ProductListingDetails for GetItem. • ItemReturnCategories (in) For the GetSearchResults call, returns the primary category and, if applicable, the secondary category • ReturnAll (in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. (Not all values in DetailLevelCodeType apply to this field.)
ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
OutputSelector	string (repeatable)	Optional	You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. See Selecting Fields to Retrieve.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: HTTP Headers (XML API Only) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.
Call-specific Input Fields
AdFormat	boolean	Optional	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.
AffiliateTrackingDetails	AffiliateTrackingDetailsType	Optional	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 eBay Partner Network 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. See Affiliate Tracking Concepts.
AffiliateTrackingDetails .AffiliateUserID	string	Conditional	Need not be specified. You can define an AffiliateUserID (up to 256 characters) if you want to leverage it to better monitor your marketing efforts. If you are using the eBay Partner Network, and you provide an AffiliateUserID, the tracking URL returned by eBay Partner Network will contain the AffiliateUserID, but it will be referred to as a "customid".
AffiliateTrackingDetails .TrackingID	string	Conditional	The value you specify is obtained from your tracking partner. For eBay Partner Network, the TrackingID is the Campaign ID ("campid") provided by eBay Partner Network. A Campaign ID is a 9-digit, unique number to be used for associating traffic. A Campaign ID is valid across all programs to which you have been accepted. Another example is the Affiliate ID given to you by TradeDoubler.
AffiliateTrackingDetails .TrackingPartnerCode	string	Conditional	Specifies your tracking partner for affiliate commissions. Affiliates earn money from eBay for driving traffic to eBay. Required if you specify a TrackingID. Depending on your tracking partner, specify one of the following values. Not all partners are valid for all sites. For PlaceOffer, only eBay Partner Network and Mediaplex are valid: 2 = Be Free 3 = Affilinet 4 = TradeDoubler 5 = Mediaplex 6 = DoubleClick 7 = Allyes 8 = BJMT 9 = eBay Partner Network For information about the eBay Partner Network, see eBay Partner Network. See Affiliate Tracking Concepts.
BidRange	BidRangeType	Optional	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.
BidRange.MaximumBidCount	int	Optional	Limits the results to items with a maximum number of bids.
BidRange.MinimumBidCount	int	Optional	Limits the results to items with a minimum number of bids.
Categories	RequestCategoriesType	Optional	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. See Searching for Matching Categories.
Categories.CategoriesOnly	boolean	Optional	Filter to retrieve matching categories but not matching items or buying guides. If true, only matching categories are returned (with no item or buying guide details). If false or not present, matching items and matching categories are both returned, along with buying guide details (if any). 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.
Categories.DemandData	boolean	Optional	If you specify that DemandData is true, then the categories returned will be sorted based on Best Match. The most relevant categories will be returned first.
Categories.Levels	int	Optional	Filter to control the deepest matching category level to return. If you specify 0, no category data is returned. If you specify a negative number, the results are unpredictable. Min: 1. Default: 2.
Categories.MaxCategories	int	Optional	Maximum quantity of matching categories to return at the first level of the category hierarchy (CategoryLevel 1). Default: 3.
Categories.MaxSubcategories	int	Optional	Maximum quantity of matching subcategories to return at each lower level of the hierarchy. Default: 3.
CategoryID	string	Conditional	Limits the result set to items in the specified category. If no category ID is specified, all categories are searched by default. Note: 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. 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: - Use the Categories input field to retrieve matching categories, and then submit the request again with one of those categories. - 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. - Use another call like GetCategories or GetSuggestedCategories to find a valid category ID. 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"). Max length: 10. See Searching by Category ID.
CharityID	int	Optional	Restricts listings to return only items that support the specified nonprofit charity organization. Retrieve CharityID values with GetCharities.
EndTimeFrom	dateTime	Conditional	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.
EndTimeTo	dateTime	Conditional	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.
ExpandSearch	boolean	Optional	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.
ExternalProductID	ExternalProductIDType	Conditional	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.
ExternalProductID.Type	ExternalProductCodeType	Conditional	The kind of identifier being used. The choices are listed For requests, required if Value is specified. For Half.com listing use cases, only ISBN, UPC, and EAN are supported. GetSearchResultsExpress returns this value in ProductArray.Product.ExternalProductID.Type. To pass an external product ID in the request, use ExternalProductIDType and ExternalProductIDValue instead. GetProducts supports ISBN, UPC, and EAN. Applicable values: • EAN (in/out) ExternalProductID.Value contains an EAN value. Required when you pass an EAN as the external product ID. Not applicable with GetSearchResultsExpress. • ISBN (in/out) ExternalProductID.Value contains an ISBN value. Required when you pass an ISBN as the external product ID. (This value is also applicable to Half.com listings.) • UPC (in/out) ExternalProductID.Value contains a UPC value. Required when you pass a UPC as the external product ID. (This value is also applicable to Half.com listings.) (Not all values in ExternalProductCodeType apply to this field.)
ExternalProductID.Value	string	Conditional	An industry-standard value that uniquely identifies the product. The valid values are dictated by the Type property. Required if Type is specified. Max length 13 for ISBN (as of February 2007), 13 for EAN, 12 for UPC, and 4000 for ProductID. No max length for ticket keywords (but passing too much data can result in "no match found" errors). For AddItem and related calls: If the primary and secondary categories are both catalog-enabled, the value must apply to the primary category. Event tickets listings support a set of keywords that uniquely identify the listing. The ticket keywords specify the event name (the title shown on the ticket), venue name, and event date and time. See the eBay Web Services guide for more information and validation rules. For convenience, you can pass an eBay product ID as input (not limited to media categories). Required for Half.com listing use cases, and this can only be an ISBN, UPC, or EAN value. For GetSearchResults and GetProducts input only: Only ISBN, EAN, and UPC values are currently supported as input. For GetSearchResultsExpress input only: To pass an external product ID in the request, use ExternalProductIDValue and ExternalProductIDType instead. For GetSearchResultsExpress, GetProducts, and GetSellerPayments output only: Also see AlternateValue, which is returned if the catalog defines multiple ISBN values (e.g., one for ISBN-13 and one for ISBN-10). Please note that some catalogs return ISBN values that are not 10 or 13 characters, and some values contain non-alphanumeric symbols (e.g., $). Max length: See description.
FreeShipping	boolean	Optional	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.
GranularityLevel	GranularityLevelCodeType	Optional	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 GranularityLevel table 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). Applicable values: • Coarse (in) For each record in the response, retrieves less data than Medium. See the eBay Web Services guide for a list of the output fields that are returned when this level is specified. • CustomCode (in) • Fine (in) For each record in the response, retrieves more data than Medium. See the eBay Web Services guide for a list of the output fields that are returned when this level is specified. • Medium (in) For each record in the response, retrieves more data than Coarse and less data than Fine. See the eBay Web Services guide for a list of the output fields that are returned when this level is specified.
Group	GroupType	Optional	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.
Group.MaxEntriesPerGroup	int	Optional	Use a positive whole number to specify the maximum number of entries per group that you want to include in the search result.
Group.MaxGroups	int	Optional	Use a positive whole number to specify the maximum number of groups that you want to include in the search result.
HideDuplicateItems	boolean	Optional	Specifies whether or not to remove duplicate items from search results. When set to true, and there are duplicate items for an item in the search results, the subsequent duplicates will not appear in the results. Item listings are considered duplicates in the following conditions: Items are listed by the same seller Items have exactly the same item title Items have similar listing formats Auctions: Auction Items, Auction BIN items, Multi-Quantity Auctions, and Multi-Quantity Auctions BIN items Fixed Price: Fixed Price, Multi-quantity Fixed Price, Fixed Price with Best Offer, and Store Inventory Format items Classified Ads For Auctions, items must also have the same price and number of bids to be considered duplicates. Filtering of duplicate item listings is not supported on all sites. Default: false.
IncludeCondition	boolean	Optional	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.) Controls the details to return for each listing (not the set of listings that match the query). To control whether to retrieve only new or used items, see ItemCondition (or SearchRequest).
IncludeFeedback	boolean	Optional	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). For GetSearchResults, if set to true will also return the seller's User ID.
IncludeGetItFastItems	boolean	Optional	When passed with a value of true, limits the results to Get It Fast listings.
ItemCondition	ItemConditionCodeType	Optional	Limits the results to new or used items, plus items that have no condition specified. 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.) 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). Applicable values: • CustomCode (in/out) Reserved for internal or future use. • New (in/out) The seller specified the Item Condition as New, or did not specify a condition. (Excludes items that the seller listed as Used.) • Used (in/out) The seller specified the Item Condition as Used, or did not specify a condition. (Excludes items that the seller listed as New.) See: Specifying an Item's Condition (GetSearchResults) SearchRequest (GetSearchResults) IncludeCondition
ItemTypeFilter	ItemTypeFilterCodeType	Optional	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. Default: AllItems. Applicable values: • AllFixedPriceItemTypes (in) Retrieves fixed-price items. Whether StoresFixedPrice items are retrieved does not depend on the site default. The StoresFixedPrice items are retrieved after the basic fixed price items. Items are retrieved whether or not ListingType is set to StoresFixedPrice. Does not retrieve items for which ListingType is AdType or Live. Does not retrieve auction items for which BuyItNowEnabled is false. • AllItems (in) It is recommended that you use AllItemTypes instead of AllItems. Return all listing types (the default for GetSearchResults). Whether StoresFixedPrice items are retrieved depends on the site default. • AllItemTypes (in) Retrieve listings whether or not ListingType is set to StoresFixedPrice; include auction items. • AuctionItemsOnly (in) Only retrieve listings eligible for competitive bidding at auction. That is, only retrieve listings for which ListingType is Chinese, Dutch, or Live (regardless of the BuyItNowEnabled value). If a listing has a ListingType of any of the following, it is not retrieved: StoresFixedPrice, FixedPriceItem, and AdType. • ClassifiedItemsOnly (in) Only retrieve Classified Ad format listings. • CustomCode (in) Reserved for internal or future use. • ExcludeStoreInventory (in) Exclude listings that have ListingType set to StoresFixedPrice. • FixedPricedItem (in) Only retrieves listings that can be purchased at a fixed price. That is, only retrieves listings for which ListingType is StoresFixedPrice or FixedPriceItem. Whether StoresFixedPrice items are retrieved depends on the site default. If StoresFixedPrice items are retrieved, they are returned after the other retrieved items. Also retrieves Chinese and Dutch auction listings for which BuyItNowEnabled is true. Does not retrieve listings for which ListingType is AdType or Live, and does not retrieve auction listings for which BuyItNowEnabled is false. • FixedPriceExcludeStoreInventory (in) Exclude listings that have ListingType set to StoresFixedPrice. Exclude listings that have ListingType set to AdType or Live. Exclude auction listings in which BuyItNowEnabled is false. • StoreInventoryOnly (in) Only retrieve listings for which ListingType is StoresFixedPrice. See Searching By Listing Type.
LocalSearchPostalCode	string	Optional	Include local items in returning results near this postal code. This postal code is the basis for local search.
Lot	boolean	Optional	Limits the results to only those listings for which Item.LotSize is 2 or greater.
MaxRelatedSearchKeywords	int	Optional	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. Min: 0. Max: 100.
ModTimeFrom	dateTime	Optional	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.
MotorsGermanySearchable	boolean	Optional	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.
Order	SearchSortOrderCodeType	Optional	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. Applicable values: • BestMatchCategoryGroup (in) Groups BestMatch results. BestMatch results are based on community buying activity and other relevance-based factors. You can also set the number of groups to be returned and you can set the number of items to be returned in each group. • BestMatchSort (in) Sorts items by Best Match, which is based on community buying activity and other relevance-based factors. • CustomCode (in) Reserved for internal or future use. • PricePlusShippingAsc (in) This value is part of the Price Plus Shipping Sort feature, to be enabled by the end of Sept. 2007 for the following sites: US (site ID 0), Germany (77), Canada (2), and Australia (15). The Price Plus Shipping Sort feature causes item sorting to consider shipping costs. Specify PricePlusShippingAsc to sort items by lowest cost first, as follows: Lowest-total-cost (for items where shipping was properly specified), then freight-shipping items, then items for which shipping was not specified (sorted by price). • PricePlusShippingDesc (in) This value is part of the Price Plus Shipping Sort feature, to be enabled by the end of Sept. 2007 for the following sites: US (site ID 0), Germany (77), Canada (2), and Australia (15). The Price Plus Shipping Sort feature causes item sorting to consider shipping costs. Specify PricePlusShippingDesc to sort items by highest cost first, as follows: highest-total-cost (for items where shipping was properly specified), then freight-shipping items, then items for which shipping was not specified (sorted by price). • SortByBidCountAsc (in) Sorts items based on the number of bids, fewest bids first. • SortByBidCountDesc (in) Sorts items based on the number of bids, most bids first. • SortByCountryAsc (in) Sorts items in ascending order by the country in which the items are located. • SortByCountryDesc (in) Sorts items in descending order by the country in which the items are located. • SortByCurrentBid (in) Sorts items by current price (lowest bid first). Note that if an item was listed in a different currency from the site's currency, that item is sorted is based on its ConvertedCurrentPrice value. • SortByCurrentBidAsc (in) Due to the new Price Plus Shipping Sort feature, SortByCurrentBidAsc is no longer functional. The Price Plus Shipping Sort feature causes item sorting to consider shipping costs. For more information, please see the PricePlusShippingAsc value. Formerly, SortByCurrentBidAsc sorted items by the current bid price in ascending order (lowest bid first). (If an item was listed in a different currency from the site currency, the item was sorted based on its ConvertedCurrentPrice value.) • SortByCurrentBidDesc (in) Sorts items by the current bid price in descending order (highest bid first). Note that if an item was listed in a different currency from the site's currency, the item is sorted based on its ConvertedCurrentPrice value. • SortByDistanceAsc (in) Sorts items based on distance from the buyer, with the nearest items returned first. • SortByEndDate (in) Sorts items by the end date (items ending soonest). This is the default for most sites, except where noted for other values. • SortByEscrowAsc (in) Sorts items in ascending order based on whether Escrow is applicable (applicable followed by inapplicable). • SortByEscrowDesc (in) Sorts items in descending order based on whether Escrow is applicable (inapplicable followed by applicable). • SortByListingDate (in) Sorts items by the listing date in descending order. • SortByPayPalAsc (in) This input value for sorting is no longer functional. Formerly, this input value sorted items in ascending order based on whether PayPal was accepted (accepted followed by unaccepted). • SortByPayPalDesc (in) This input value for sorting is no longer functional. Formerly, this input value sorted items in descending order based on whether PayPal was accepted (unaccepted followed by accepted). • SortByStartDate (in) Sorts items by the start date (most recently listed first).
Pagination	PaginationType	Optional	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). See Paginating Search Results.
Pagination.EntriesPerPage	int	Optional	Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value in EntriesPerPage, then the lower number is returned. For most calls, the max is 200 and the default is 25. For GetUserDisputes, the value is hard-coded at 200, and any input is ignored. For GetProducts, the maximum is 20 (and higher values are ignored). See the annotations for other individual calls to determine the correct max and default values. For GetOrders, not applicable to eBay.com (but applicable to Half.com for GetOrders). Min: 1. Max: 400.
Pagination.PageNumber	int	Optional	Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Min: 0. Max: 2147483647. Default: 0.
PaymentMethod	PaymentMethodSearchCodeType	Optional	Limits the results to items that accept a specific payment method or methods. Applicable values: • CustomCode (in/out) • PaisaPay (in/out) PaisaPay payment method. The PaisaPay payment method is only for the India site (site ID 203). • PaisaPayEscrowEMI (in/out) PaisaPayEscrowEMI (Equal Monthly Installments) payment method. The PaisaPayEscrowEMI payment method is only for the India site (site ID 203). • PayPal (in/out) PayPal payment method. • PayPalOrPaisaPay (in/out) Either the PayPal or the PaisaPay payment method. The PaisaPay payment method is only for the India site (site ID 203).
PriceRangeFilter	PriceRangeFilterType	Optional	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.
PriceRangeFilter.MaxPrice	AmountType (double)	Optional	Specifies the maximum current price an item listing can have to be included in the searches result set. Use alone to specify a maximum price or with MinPrice to define a range the items' prices must be. See "Data Types" in the eBay Web Services Guide for information about specifying double values.
PriceRangeFilter.MinPrice	AmountType (double)	Optional	Specifies the minimum current price an item listing can have to be included in the searches result set. Use alone to specify a minimum price or with MaxPrice to define a range the items' prices must be. See "Data Types" in the eBay Web Services Guide for information about specifying double values.
ProductID	string	Conditional	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. 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. See Searching for Listings by ProductID.
ProximitySearch	ProximitySearchType	Optional	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.
ProximitySearch.MaxDistance	int	Optional	The maximum distance from the specified postal code to search for items.
ProximitySearch.PostalCode	string	Optional	The postal code to use as the basis for the proximity search.
Quantity	int	Optional	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.
QuantityOperator	QuantityOperatorCodeType	Optional	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). Applicable values: • CustomCode (in/out) Reserved for internal or future use. • Equal (in/out) Used by QuantityOperator to specify that you are seeking quantities equal to Quantity. • GreaterThan (in/out) Used by QuantityOperator to specify that you are seeking quantities greater than Quantity. • GreaterThanOrEqual (in/out) Used by QuantityOperator to specify that you are seeking quantities greater than or equal to Quantity. • LessThan (in/out) Used by QuantityOperator to specify that you are seeking quantities less than Quantity. • LessThanOrEqual (in/out) Used by QuantityOperator to specify that you are seeking quantities less than or equal to Quantity.
Query	string	Conditional	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. Max length: 350 (characters). See Searching by Keywords.
SearchFlags	SearchFlagsCodeType (repeatable)	Optional	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. Applicable values: • Charity (in) Return only charity item listings. • CustomCode (in) Reserved for internal or future use. • NowAndNew (in) Return only items that have been listed with Now and New. Applicable for certain sites only. See the eBay Web Services Guide. • PayPalBuyerPaymentOption (in) Return only item listings where PayPal is a payment method offered by the seller. • SearchInDescription (in) Include the description field of item listings in keyword search. Item listings returned are those where specified search keywords appear in the description, as well as the title and sub-title.
SearchLocationFilter	SearchLocationFilterType	Optional	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.
SearchLocationFilter .CountryCode	CountryCodeType	Optional	Country the item is either located in or available to (depending on the value specified in ItemLocation). Applicable values: See CountryCode.
SearchLocationFilter.Currency	CurrencyCodeType	Optional	Limits the result set to just those items with a specified currency. Applicable values: See Currency.
SearchLocationFilter .ItemLocation	ItemLocationCodeType	Optional	Specifies whether the filter should be for items located in the country specified in Country or available to that country. Applicable values: • CustomCode (in) Reserved for internal or future use. • ItemAvailableIn (in) Items available to the specified country. • ItemLocatedIn (in) Items located in the specified country.
SearchLocationFilter .SearchLocation	SearchLocationType	Optional	Specifies filtering based on the location of the item or its availability relative to an eBay site. Or, allows for filtering based on regional listing.
SearchLocationFilter .SearchLocation.RegionID	string	Optional	Specifies a region ID. The item must have been listed for the specified region to be returned in the search result set.
SearchLocationFilter .SearchLocation.SiteLocation	SiteLocationType	Optional	Specifies a filter based on a particular eBay site and the item's relation to that site (items listed with a site's currency, items located in the country for the site, items available to the country for the site, and items listed on the specified site).
SearchLocationFilter .SearchLocation.SiteLocation .SiteID	SiteIDFilterCodeType	Optional	Specifies the criteria for filtering search results by site, where site is determined by the site ID in the SOAP URL or, for Unified Schema XML requests, X-EBAY-API-SITEID HTTP Header. Applicable values: • AvailableInCountryImplied (in) Items available to the country implied by the site specified in the request. For the US site, this implies listings from ALL English-language countries that are available to the US. • BelgiumListing (in) Items located in Belgium or listed on one of the two Belgian sites. • CustomCode (in) Reserved for internal or future use. • ListedInCurrencyImplied (in) Items listed in the currency implied by the site specified in the request. • LocatedInCountryImplied (in) Items located in the country implied by the site specified in the request. • SiteImplied (in) Items listed on the site specified in the request, regardless of listing currency.
SearchRequest	SearchRequestType	Optional	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. If you are searching for tickets, see TicketFinder instead. See: Searching by Item Specifics (Buy-Side Product Finder) (GetSearchResults) TicketFinder
SearchRequest.ProductFinderID	int	Conditional	Numeric identifier for a buy-side product finder. A product finder defines how to search for Item Specifics in listings (e.g., how to search against a particular shoe size). See the eBay Web Services guide for details about product finders. You need to specify a product finder ID when you are searching against a listing's Item Specifics (i.e., when you use SearchAttributes). A few categories, such as US Event Tickets and US eBay Motors, can also return a subset of Item Specifics (e.g., the event venue, section, and row for a ticket listing) in the search results. To retrieve this data, you must specify the product finder ID, and also specify a detail level of ItemReturnAttributes or ReturnAll. Use GetProductFinder to determine valid product finder IDs. If you have trouble with GetProductFinder, use the pfid parameter from the URL of the Product Finder search page on the site you're interested in. See the Knowledge Base article referenced below for more details. See Knowledge Base: ProductFinderID for Buy-Side Searches.
SearchRequest.SearchAttributes	SearchAttributesType (repeatable)	Optional	A query consisting of a set of attributes (search criteria). If the query includes multiple attributes, the search engine will apply "AND" logic to the query. Use GetProductFinder to determine the list of valid attributes and how many are permitted for the specified characteristic set. If specified, ProductFinderID must also be specified.
SearchRequest.SearchAttributes .AttributeID	int	Conditional	Unique identifier for the attribute within the characteristic set. Required if SearchAttributes is specified.
SearchRequest.SearchAttributes .DateSpecifier	DateSpecifierCodeType	Conditional	Specifies the date sub-component that the attribute represents. This only applies to date attributes. Required when searching by date attributes. Allows for separate text fields or drop-down lists to be rendered for each sub-component. For example, the day, month, and year can be rendered as separate drop-down lists. Applicable values: • CustomCode (in) Reserved for internal or future use. • D (in) The day subcomponent of a date. • M (in) The month subcomponent of a date. • Y (in) The year subcomponent of a date.
SearchRequest.SearchAttributes .RangeSpecifier	RangeCodeType	Conditional	Indicates that the attribute represents the high or low end in a range, such as a date range or a price range. Required when searching on ranges. Applicable values: • CustomCode (in) Reserved for internal or future use. • High (in) High end of the range. • Low (in) Low end of the range.
SearchRequest.SearchAttributes .ValueList	ValType (repeatable)	Conditional	Container for the list of one or more valid values that the user has selected for the searchable attribute. If multiple values are specified, the search engine applies "OR" logic to the query (i.e., at least one of the specified values must match). Required if SearchAttributes is specified.
SearchRequest.SearchAttributes .ValueList.ValueID	int	Conditional	Constant value that identifies the attribute or characteristic in a language-independent way. Unique within the characteristic set. In item-listing requests, if the ID is defined as -3 or -6 (Other) in GetAttributesCS or GetProductSellingPages, use ValueLiteral to specify the string value that the user entered. Otherwise, use ValueID to specify the ID that is pre-defined in GetAttributesCS or GetProductSellingPages. In item-listing requests and product searches, the possible ID values are: -3 = User entered an arbitrary value (not an "Other" field) -6 = User entered a value in an "Other" field -100 = Value not specified (null) #### (integer) = Identifier for a pre-defined value that the user selected (e.g., -14 or 1001) For eBay.com, required if ValueList is specified. Not applicable to Half.com. See Attribute Elements.
SearchRequest.SearchAttributes .ValueList.ValueLiteral	string	Conditional	The descriptive name of an attribute or characteristic value (e.g., "New" might be a literal value for a Condition attribute). In item-listing requests, if you send ValueID with an id of -3 or -6, you must use ValueLiteral to enter the value the user specified. Otherwise, eBay treats the request as if no value was sent at all. For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value.ValueLiteral. The max length allowed varies per attribute. For GetSearchResults requests (in SearchRequest), only use ValueLiteral for attributes that support free-text values. That is, if eBay defines a value name and a unique value ID for an attribute in GetProductFinder, do not pass the name in ValueLiteral (because it won't work). Instead, specify the unique value ID in ValueID. For Half.com, use AttributeArray.Attribute.Value.ValueLiteral in listing requests. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, AttributeArray.Attribute.Value.ValueLiteral is required when you use AddItem. See the eBay Web Services Guide for valid values. For the Half.com Notes attribute, the max length is 500 characters. You can revise AttributeArray.Attribute.Value.ValueLiteral for Half.com listings. Max length: see description.
SearchType	SearchTypeCodeType	Optional	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. Applicable values: • All (in) Return Gallery and non-Gallery item listings. • CustomCode (in) Reserved for internal or future use. • Gallery (in) Return Gallery items only.
SellerBusinessType	SellerBusinessCodeType	Optional	Limits the results to those of a particular seller business type such as commercial or private. Applicable values: • Commercial (in/out) Commercial seller account. • CustomCode (in/out) • Private (in/out) Private seller account. • Undefined (in/out) Type of seller account not defined.
StoreSearchFilter	SearchStoreFilterType	Optional	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.
StoreSearchFilter.StoreName	string	Optional	The name of the eBay Store in which the item is listed. The name of the store is case sensitive.
StoreSearchFilter.StoreSearch	StoreSearchCodeType	Optional	Specifies the type of store search used in the filtering: one eBay Store (name specified in StoreName) or all eBay stores, and also by listing type. Possible values are enumerated in the StoreSearchCodeType code list. Applicable values: • AllItemsInTheStore (in) Within a single store for all items (specify store in SearchStoreFilterType.StoreName). • AuctionItemsInTheStore (in) Within a single store for auction items (specify store in SearchStoreFilterType.StoreName). • BuyItNowItemsInAllStores (in) Across all stores for basic fixed price items, Store Inventory format items, and auction items with Buy It Now. • BuyItNowItemsInTheStore (in) Within a single store for basic fixed price items, Store Inventory format items, and auction items with Buy It Now. (Specify store in SearchStoreFilterType.StoreName). • CustomCode (in) Reserved for internal or future use.
TicketFinder	TicketDetailsType	Optional	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. See Performing a Simple Ticket Finder Search.
TicketFinder.CityName	string	Optional	The city in which the event venue is located. Specify the full name of the city. Use the canonical spelling, such as "Los Angeles" (not "LA"). When you search for tickets, if eBay doesn't recognize the city, eBay drops CityName and returns results that match other fields in the request. For the eBay US site, eBay only searches by CityName if you also specify StateOrProvince. Note: If your application needs to provide users with a predefined list of city names that eBay recognizes, you can call GetProductFinder to find all the cities that the ticket finder currently supports. GetProductFinder is a more complex call. Max length: 60.
TicketFinder.EventDate	DateType	Optional	The date of the event. If specified, the results only include listings that specify this date in their Item Specifics. When you search for tickets, we support these combinations: - Year (matches any ticket in the specified year) - Month (matches any day in the specified month, in any year) - Year and Month (matches any day in the specified year and month) - Month and Day (matches the specified month and day in any year) - Year, Month, and Day (matches the specified year, month, and day)
TicketFinder.EventDate.Day	int	Optional	A calendar day (e.g., 2 or 02). For ticket searches, Day is only valid if Month is also specified. Min: 1. Max: 31.
TicketFinder.EventDate.Month	int	Conditional	A calendar month (e.g., 2 or 02 for February). For ticket searches, Month is required if Day is specified. Min: 1. Max: 12.
TicketFinder.EventDate.Year	int	Optional	A year in the form YYYY. For ticket searches on the US site, only specify 2007 or 2008. If you specify any other year, it is ignored.
TicketFinder.EventType	TicketEventTypeCodeType	Conditional	The type of event, such as a concert or a sporting event. The eBay US, UK, and Germany sites support different values. Default: Any. Applicable values: See EventType.
TicketFinder.StateOrProvince	string	Optional	The state or province where the event venue is located. Applicable to eBay US searches only. Use the full name, such as "California" (not "CA"). If StateOrProvince isn't specified or no match is found in the product finder, eBay ignores CityName (if it is also specified). Max length: 60.
TicketFinder.TicketQuantity	int	Optional	The number of tickets available in the listing, as defined in the listing's Item Specifics. (This is not the same as LotSize or Quantity.) - For the US site, specify a value from 1 to 10. - For the UK site, specify a value from 1 to 10. - For the DE site, specify a value from 1 to 4. To search for any quantity (or to include other quantities in the results), do not specify TicketQuantity at all. Min: 1. Max: 10.
TotalOnly	boolean	Optional	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.
UserIdFilter	UserIdFilterType	Optional	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.
UserIdFilter.ExcludeSellers	UserIDType (string

eBay Trading API Call Reference Version 585

eBay Trading API
Call Reference Version 585