eBay Product APIVersion 1.4.0

ProductRequest

Container for request data used in product search calls.

Types that use ProductRequest:

Calls that use ProductRequest:

Fields



categoryId ( string ) [0..1]
Specifies the category from which you want to retrieve product details. When categoryId is used with findProducts, the category must be catalog- enabled, or it will contain no product data, and the request will fail. When categoryId is used with findProductsByCompatibility, the category must be compatibility-enabled. A category must be catalog-enabled to be compatibility-enabled.

Your request must contain categoryId and/or keywords.
See the Field Index to learn which calls use categoryId.

dataset ( token ) [0..*]
This will define what are properties that will be returned for this catelog-enabled category.
Dataset values:
DisplayableProductDetails
Properies for use in a user interface to describe products.
DisplayableSearchResults
Properties for use in results for product searches.
Searchable
Properties for use in searches.
Sortable
Properties that are suitable for sorting.
User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time.
See the Field Index to learn which calls use dataset.

datasetPropertyName ( string ) [0..*]
Individual property name from the dataset. You can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time.
See the Field Index to learn which calls use datasetPropertyName.

invocationId ( string ) [1]
A unique identifer for a given product request. Use invocationId to prevent the submission of duplicate data. In the event of a partial failure, the invocation ID can also be used to identify a product request that did not succeed.

If the same invocationId is passed in more than once in the same request, then an error will be returned. The identifier must be a number .
See the Field Index to learn which calls use invocationId.

keywords ( string ) [0..1]
Use keywords to refine your product search query. Products whose catalog searchable property values contain these keywords will be returned. Returned products must match both the specified keywords and the name- value pairs constraint.

Keyword searches are not case sensitive. Keywords are used for exact word matching only, wildcards or search string modifiers are not supported.

Your request must contain categoryId and/or keywords.
See the Field Index to learn which calls use keywords.

paginationInput ( PaginationInput ) [0..1]
Controls the pagination of the result set. Child elements specify the maximum number of products to return per call and the page of data to return. Controls the number of products returned in the response, but does not specify the amount of data to return for each product.

Note: No more than 10,000 products can be retrieved for a given search, regardless of how many matches are found. This limit is enforced by the maximum page number allowed (100) and the maximum entries per page allowed (20).
See the Field Index to learn which calls use paginationInput.

productStatusFilter ( ProductStatus ) [0..1]
Specifies whether or not to filter out the products which are disabled for selling, product reviews, or use on half.com.
See the Field Index to learn which calls use productStatusFilter.

propertyFilter ( PropertyValue ) [0..*]
One or more name-value pairs that describe the product.
See the Field Index to learn which calls use propertyFilter.

sortOrder ( SortOrder ) [0..1]
Sort Order for the result set. Any of the searchable property can be used to specify the sort order. If no sort order is specified then default sort order(popularity descending) will be applied.
See the Field Index to learn which calls use sortOrder.