Method: FindProducts

Description

Finds products based on the given search criteria.

Action

Style

Document

Input (Literal)

The input of this method is the document element ns:FindProductsRequest 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:AvailableItemsOnly	xs:boolean	0..1	If true, only retrieve data for products that have been used to pre-fill active listings on the specified eBay site. If false, retrieve all products that match the query.
ns:DomainName	xs:string	0..*	A domain to search in.
ns:ProductID	ns:ProductIDType	0..1	Use this to retrieve product details for one specific product.
ns:QueryKeywords	xs:string	0..1	One or more keywords to search for. When you use a keyword search, eBay searches the product catalogs for matching words in the product title, description, and/or Item Specifics, and it returns a list of matching products, with no items.
ns:ProductSort	ns:ProductSortCodeType	0..1	Sorts the list of products returned.
ns:SortOrder	ns:SortOrderCodeType	0..1	Sorts search results in ascending or descending order. Only applicable with ProductSort.
ns:MaxEntries	xs:int	0..1	Specifies the maximum number of products to return per page in a single call.
ns:PageNumber	xs:int	0..1	Specifies which page of data to return in the current call.
ns:CategoryID	xs:string	0..1	Include a Category ID number in your request to restrict your query to a specific category.
ns:HideDuplicateItems	xs:boolean	0..1	Specifies whether or not to remove duplicate items from search results.

Output (Literal)

The output of this method is the document element ns:FindProductsResponse 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:ApproximatePages	xs:int	0..1	The total number of pages that can be returned, given the same query and filters in the request.
ns:MoreResults	xs:boolean	0..1	If true, more pages of results are available. That is, PageNumber is less than ApproximatePages.
ns:DomainHistogram	ns:DomainHistogramType	0..1	A histogram that lists the number of matching products found and the domains in which they were found.
ns:ItemArray	ns:SimpleItemArrayType	0..1	A list of active items that were listed with the requested product.
ns:PageNumber	xs:int	0..1	The number of the page of data returned.
ns:Product	ns:CatalogProductType	0..*	An eBay catalog product.
ns:TotalProducts	xs:int	0..1	The total number of matching products found. (If more than 2000 products are found, the call fails with an error.)
ns:DuplicateItems	xs:boolean	0..1	Indicates whether there are duplicated items not returned by this response when HideDuplicateItems is true in the request.

---