eBay Shopping APIVersion 1145

FindProductsRequestType ( AbstractRequestType )

This type is the base request type of the FindProducts call. The FindProducts call returns one or more eBay catalog products based upon the query string or product ID value that is passed in the call request

Important: Historically, through an ItemArray container, this call returned detailed information on active listings that are associated with the retrieved eBay catalog product(s). However, active listing data is no longer retrieved in the FindProducts response, so some of the fields/filters in the FindProducts request payload are no longer applicable.

Call that uses FindProductsRequestType:

Fields



AvailableItemsOnly ( boolean ) [0..1]
Not used by any call.

This filter is no longer applicable since the FindProducts call no longer retrieves any active listings associated with the retrieved catalog products. If this field is used, it will have no effect on the response.
See the Field Index to learn which calls use AvailableItemsOnly.

CategoryID ( string ) [0..1]
This field is included to restrict the catalog products that are returned. Only the catalog products associated with this category ID are returned.

This field is generally used with the QueryKeywords field.

The GetCategories or GetSuggestedCategories calls of the Trading API can be used to retrieve CategoryID values.
See the Field Index to learn which calls use CategoryID.

DomainName ( string ) [0..*]
Important: The use of domain histograms and DomainName filters is no longer recommended, as the domain histogram data that is returned in the response, and filtering by domain logic is no longer reliable.
An eBay domain to search in. This is like searching a section of the eBay catalog. If this field is not included, the catalog product search is conducted across all defined eBay domains. The user can use multiple DomainName filters to search multiple defined eBay domains. If you are using a URL, and you want to specify multiple values, use an index value (not a comma). For example, to specify DomainName=Textbooks,Education, specify DomainName(0)=Textbooks,%20Education. To retrieve valid domain names, first use this call with your query string specified in QueryKeywords, and the IncludeSelector field's value set to DomainHistogram. After retrieving all eBay defined domain names for the query string under the DomainHistogram container, the user can select the eBay domains relevant to the product they're searching for, and then they can do another FindProducts call with one or more DomainName filters.

Generally, DomainName filter(s) are only useful for query string searches using QueryKeywords field. If you are searching for a specific catalgo product based on eBay Product ID (ePID) or a Global Trade Item Number (GTIN), such as a UPC, ISBN, or EAN, a lt;b>DomainName filter is not needed.
See the Field Index to learn which calls use DomainName.

HideDuplicateItems ( boolean ) [0..1]
Not used by any call.

This filter is no longer applicable since the FindProducts call no longer retrieves any active listings associated with the retrieved catalog products.
See the Field Index to learn which calls use HideDuplicateItems.

IncludeSelector ( string ) [0..1]
Important: The use of domain histograms and DomainName filters is no longer recommended, as the domain histogram data that is returned in the response, and filtering by domain logic is no longer reliable. DomainHistogram is the only value that can be used for IncludeSelector, so this filter has no practical use, and may be deprecated in the near future.
This filter is included and set to DomainHistogram if the user would like to view domain histogram data in the response. The DomainHistogram container that is returned displays all eBay category domains associated with all eBay catalog products that are retrieved. The count of eBay catalog products associated with each domain is also shown under each Domain container. If this field is omitted, only the catalog product records and pagination data is returned.

Important: Historically, the IncludeSelector field supported two other values - Items and Details. However, both of these enumeration values controlled the data that was returned through the ItemArray container, and this container is no longer returned at all. The FindProducts call now only retrieves one or more eBay catalog products, and no longer retrieves active listing data related to these catalog products. The Items or Details values will have no effect is used.
See the Field Index to learn which calls use IncludeSelector.

MaxEntries ( int ) [0..1]
This field is used to limit/control the maximum number of catalog products that are returned per page of data in a single call. This is generally used with string query searches using the QueryKeywords field.

If this field is not used, its value defaults to '1', and only one catalog product is returned. The user may want to look at the TotalProducts field's value to see how many eBay catalog products matched the search criteria, and then the user may want to do another call, possibly refining/narrowing the search with a more precise query string in the QueryKeywords field, or perhaps with one or more DomainName filters.

If the MoreResults field is returned as true, this indicates that more than one page of results are available based on the current search criteria, so the user will have to make additional calls to view additional pages of results, changing the PageNumber value as needed.
See the Field Index to learn which calls use MaxEntries.

PageNumber ( int ) [0..1]
This field is used to control the page number of results to retrieve in the call. If this field is omitted, the first page of results is returned by default. You know that you have additional pages or results if the MoreResults field is returned as true.

This field takes a positive integer value equal to or lower than the number of pages available. The total number of pages in the results set is shown in the ApproximatePages field of the response.
See the Field Index to learn which calls use PageNumber.

ProductID ( ProductIDType (string) ) [0..1]
Use this field to find a catalog product (or products) associated with an eBay Product ID (ePID) or a Global Trade Item Number (GTIN), such as a UPC, ISBN, or EAN. The product identifier is expressed as a string value, and the type of product identifier is expressed in the type attribute.

See the ProductIDCodeType definition to view the supported enumeration values for the type attribute. Note that it is possible that there may be multiple eBay catalog products associated with the same GTIN value, but there can only be one eBay catalog product associated with a specific ePID value.
See the Field Index to learn which calls use ProductID.

ProductSort ( ProductSortCodeType ) [0..1]
This field allows the user to control the order in which the retrieved catalog products are displayed in the response. If this field is not included, the results are sorted by the catalog product's popularity.

See the ProductSortCodeType definition to view the available sort values.

This field can be used in conjunction with the SortOrder field. The SortOrder field controls whether catalog products are returned in ascending or descending order (according to the ProductSort value). If neither ProductSort nor SortOrder fields are used, catalog products are sorted by popularity in descending order.
See the Field Index to learn which calls use ProductSort.

QueryKeywords ( string ) [0..1]
This string field is used to defined a query string using one or more keywords. When you use a keyword search, eBay searches the product catalog for matching words in the product title, description, and/or Item Specifics, and it returns a list of matching catalog products. If used, the response will also be affected by any eBay domains that are specified through one or more DomainName filters.

The query string must contain at least three alphanumeric characters.

The words "and" and "or" are treated like any other word. Only use "and", "or", or "the" if you are searching for products containing these words. To use AND or OR logic, use eBay's standard search string modifiers. Wildcards (+, -, or *) are also supported. Be careful when using spaces before or after modifiers and wildcards.

Some keyword queries can result in response times of 30 seconds or longer. If too many results are returned, you may want to refine the search by passing in more keywords and/or by using one or more DomainName filters. Using a CategoryID value is also an option, as this will return only catalog products associated with that eBay category.

If you know your product's UPC, EAN, or ISBN, you may want to use the ProductID field instead of the QueryKeywords field.

See the Field Index to learn which calls use QueryKeywords.

SortOrder ( SortOrderCodeType ) [0..1]
This field is used to control whether catalog products are returned in ascending or descending order (according to the ProductSort value). If neither ProductSort nor SortOrder fields are used, catalog products are sorted by popularity in descending order.
See the Field Index to learn which calls use SortOrder.