eBay Shopping Web Service

Method: FindItemsAdvanced

Description

Advanced item search adding more search parameters.

Action

Style

Document

Input (Literal)

The input of this method is the document element ns:FindItemsAdvancedRequest of type having the structure defined by the following table.

Element  Type  Occurs  Description 
    1..1   
ns:MessageID  xs:string  0..1  If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any    0..*   
ns:IncludeSelector  xs:string  0..1  Defines standard subsets of fields to return within the response.
ns:BidCountMax  xs:int  0..1  Limits the results to items with a maximum number of bids.
ns:BidCountMin  xs:int  0..1  Limits the results to items with a minimum number of bids.
ns:CategoryHistogramMaxParents  xs:int  0..1  Maximum number of matching categories to return at the highest level (root level) of the category hierarchy (level 1).
ns:CategoryHistogramMaxChildren  xs:int  0..1  Maximum number of matching subcategories to return at each level of the category hierarchy below the root level.
ns:QueryKeywords  xs:string  0..1  A query that specifies a string for searching titles of items on eBay.
ns:CategoryID  xs:string  0..1  Specify CategoryID to restrict your query to a specific category.
ns:ItemSort  ns:SimpleItemSortCodeType  0..1  Sorts search results based on the value you specify.
ns:SortOrder  ns:SortOrderCodeType  0..1  Sorts search results in ascending or descending order, in conjunction with the value you specify in ItemSort.
ns:GroupMaxEntries  xs:int  0..1  GroupMaxEntries is used when you specify that BestMatch search results are grouped by category (by using BestMatchCategoryGroup in the ItemSort field.)
ns:GroupsMax  xs:int  0..1  GroupsMax is used when you specify that BestMatch search results are grouped by category (by using BestMatchCategoryGroup in the ItemSort field.)
ns:EndTimeFrom  xs:dateTime  0..1  Limits the results to items ending within a time range.
ns:EndTimeTo  xs:dateTime  0..1  Limits the results to items ending within a time range.
ns:ModTimeFrom  xs:dateTime  0..1  Limits the results to active items whose status has changed since the specified time.
ns:SellerID  xs:string  0..*  The ID of a specific seller.
ns:SellerIDExclude  xs:string  0..*  Specify this value if you want search results to be filtered so that the items returned do not include items sold by a specific seller or by specific sellers.
ns:ItemType  ns:ItemTypeCodeType  0..1  Filters items based on criteria related to the listing type of items.
ns:MaxDistance  xs:int  0..1  The maximum distance from the postal code specified in the PostalCode field. (The PostalCode field contains the postal code of the buyer.)
ns:PostalCode  xs:string  0..1  The postal code where the buyer is located.
ns:ProductID  ns:ProductIDType  0..1  You can use this input field to search by ISBN, UPC, EAN, or eBay Product Reference ID, as in the following examples. To search using an ISBN, specify ProductID.Type=ISBN and set ProductID.Value to an ISBN value. To search using an eBay Product Reference ID, specify ProductID.Type=Reference and set ProductID.Value to an eBay Product Reference ID value.
ns:MaxEntries  xs:int  0..1  Specifies the maximum number of entries to be returned in a single call.
ns:PageNumber  xs:int  0..1  Specifies the number of the page of data to return in the current call.
ns:PriceMax  ns:AmountType  0..1  Specifies the maximum current price an item can have to be included in the response.
ns:PriceMin  ns:AmountType  0..1  Specifies the minimum current price an item listing can have to be included in the searches result set.
ns:Condition  ns:ItemConditionCodeType  0..1  Limits the results to new OR used items (exclusive, not both), plus items that have no condition specified.
ns:CharityID  xs:int  0..1  Limits results to items that support the specified nonprofit charity organization.
ns:SearchFlag  ns:SearchFlagCodeType  0..*  Search for charity listings, free-shipping listings, and listings with other features.
ns:PaymentMethod  ns:PaymentMethodSearchCodeType  0..1  Limits results to items that accept a specific payment method or methods.
ns:StoreName  xs:string  0..1   
ns:StoreSearch  ns:StoreSearchCodeType  0..1  Specifies the type of store search used for filtering results.
ns:SellerBusinessType  ns:SellerBusinessCodeType  0..1  Limits the results to those of a particular seller business type such as commercial or private.
ns:Quantity  xs:int  0..1  Limits the results to listings that offer a certain number of items matching the query.
ns:QuantityOperator  ns:QuantityOperatorCodeType  0..1  Limits the results to listings with quantities greater than, equal to, or less than the value you specify in Quantity.
ns:Currency  ns:CurrencyCodeType  0..1  Limits the result set to just those items with a specified currency.
ns:ItemsAvailableTo  ns:CountryCodeType  0..1  Limits the result set to just those items available to the specified country.
ns:ItemsLocatedIn  ns:CountryCodeType  0..1  Limits the result set to just those items located in the specified country.
ns:PreferredLocation  ns:PreferredLocationCodeType  0..1  Specifies the criteria for filtering search results by site, where site is determined by the site ID in the request.
ns:FeedbackScoreMax  xs:int  0..1  Specifies the maximum feedback score of a seller whose items can be included in the response.
ns:FeedbackScoreMin  xs:int  0..1  Specifies the mininum feedback score of a seller whose items can be included in the response.
ns:ExcludeFlag  ns:ExcludeFlagCodeType  0..*  Excludes items with the specified flag from the search.
ns:DescriptionSearch  xs:boolean  0..1  Specifies whether you want to include the item's description in a search.
ns:HideDuplicateItems  xs:boolean  0..1  Specifies whether or not to remove duplicate items from search results.
ns:ShippingLocation  ns:CountryCodeType  0..1  ShippingLocation should be used together with PostalCode for shipping cost calculations.
ns:ShippingPostalCode  xs:string  0..1  This postal code is for international shipping cost calculations.
ns:ItemLocationRegion  ns:ItemLocationRegionCodeType  0..1  Allows you to search for items in a specified region.
ns:CategoryIDExclude  xs:string  0..*  Specify a CategoryIDExclude value in your request if you want search results to be filtered so that the items returned do not include items that belong to the specified category.

Output (Literal)

The output of this method is the document element ns:FindItemsAdvancedResponse of type having the structure defined by the following table.

Element  Type  Occurs  Description 
    1..1   
ns:Timestamp  xs:dateTime  0..1  This value represents the date and time when eBay processed the request.
ns:Ack  ns:AckCodeType  0..1  Indicates whether the call was successfully processed by eBay.
ns:Errors  ns:ErrorType  0..*  A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build  xs:string  0..1  This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version  xs:string  0..1  The release version that eBay used to process the request.
ns:CorrelationID  xs:string  0..1  If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any    0..*   
ns:SearchResult  ns:SearchResultType  0..*  Contains the returned item listings, if any.
ns:PageNumber  xs:int  0..1  Indicates the page of data returned by the current call. For instance, for the first set of items returned, this field has a value of 1.
ns:TotalPages  xs:int  0..1  Indicates the total number of pages of data that could be returned by repeated requests.
ns:TotalItems  xs:int  0..1  Indicates the total number of items that could be returned by repeated requests.
ns:CategoryHistogram  ns:CategoryArrayType  0..1  Statistical (histogram) information about categories that contain items that match the query, if any.
ns:TotalStoresExpansionItems  xs:int  0..1  Total item count for a store expansion of the search.
ns:TotalInternationalExpansionItems  xs:int  0..1  Total item count for an international expansion of the search.
ns:ItemSearchURL  xs:anyURI  0..1  A URL for search results that corresponds to your search request.
ns:DuplicateItems  xs:boolean  0..1  Indicates whether there are duplicated items not returned by this response when HideDuplicateItems is true in the request.