This is the base class for request container for all service operations. This is the base class for request container for all operations in the Merchandising Service. 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 you specify, the lower number is returned. Values less than 1 or greater than 20 will be ignored. 1 20 20 No Container for affiliate details. eBay uses the specified affiliate details to build a View Item URL and Product URL string in the response that includes your affiliate tracking information in the correct format. When a user clicks through these URLs to eBay and performs certain tasks, you may get an affiliate commission. See the <a href="https://www.ebaypartnernetwork.com/" target="_blank">eBay Partner Network</a> for information about commissions. No Retrieves data for items with the highest watch counts for the entire site or for a specific category. The top 20 most watched items, if any, are returned unless maxResults is used to specify a smaller result set. The top 20 items are determined by the watch count totals from the preceding day. Ranking of the most watched items is calculated with the latest watch count information. Only active items are returned.

Retrieves data for items with the highest watch count.

Specifies the category from which to retrieve item listings. This field takes the same category ID data as used with other eBay APIs. Category IDs are site-specific. If the specified category ID doesn't match an existing category for the site, an invalid-category error message is returned. To determine valid categories, you can use either the Shopping API or the Trading API. In the Shopping API, use the <a href="http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindItemsAdvanced.html"> FindItemsAdvanced</a> call with the CategoryHistogram value in the IncludeSelector field to retrieve matching category information. In the Trading API, use calls like <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategories.html"> GetCategories</a> and <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategoryFeatures.html"> GetCategoryFeatures</a> to determine valid values for the site. 10 getMostWatchedItems No Retrieves the 20 top selling products on eBay. Products in the reponse are sorted in sales rank order, with the top selling products first. There are no call-specific input parameters for this call.

Retrieves eBay's top selling products. Products in the reponse are sorted in sales rank order, with the top selling products first.

Retrieves recommended items from categories related to a specified category or item. If categoryId is specified, then items are returned from categories related to the given category. If itemId is specified, then items are returned from categories related to the given item's category. In either case, the response contains items from the three best matching categories. The selection of items is evenly distributed between the best matching categories. The recommended items are sorted by end time, with items ending soonest first. The request must contain either categoryId or ItemId. If both itemId and categoryId are specified, categoryId takes precedence.

Retrieves items related to a specified category or item.

The ID of an active item listing. Related categories are determined from the primary category in which the item is listed. If both categoryId is also specified, it takes precedence. 19 getRelatedCategoryItems Conditionally Specifies the category used to determine related categories from which to retrieve item listings. This field takes the same category ID data as used with other eBay APIs. Category IDs are site-specific. If the specified category ID doesn't match an existing category for the site, an invalid-category error message is returned. To determine valid categories, you can use either the Shopping API or the Trading API. In the Shopping API, use the <a href="http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindItemsAdvanced.html"> FindItemsAdvanced</a> call with the CategoryHistogram value in the IncludeSelector field to retrieve matching category information. In the Trading API, use calls like <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategories.html"> GetCategories</a> and <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategoryFeatures.html"> GetCategoryFeatures</a> to determine valid values for the site. 10 getRelatedCategoryItems Conditionally Retrieves data for top 20 "best deal" items on eBay that match a simple keyword query. Items that provide the best value to buyers, such as items that are on sale or items with free shipping) are considered best deals. The query searches item titles only, and results, if any, must match all terms specified in the required keywords field. Items in the results are sorted by Best Match, which is based on community buying activity and other relevance-based factors.

Retrieves data for "best deal" items that match a simple keyword query. Best deal items include items that are on sale and items that offer free shipping.

samples A query string for searching titles of items on eBay. The query is limited to a maximum of 7 space-delimited terms. Any additional terms will be ignored. Results must match all terms in the query. The keywords field does not support wildcards, such as asterisks ("*") or question marks ("?"), or Boolean search operators, such as "AND" (or the plus sign "+"), "OR," or "NOT" (or the minus sign "-"). Search wildcard or operator characters (e.g., "*" or "+") will be ignored. The words "and" and "or" and "not" are treated like any other word, and should be used only if you are searching for listings containing these words. Note: If you are using an HTTP GET (i.e., URL) request, use "%20" to delimit terms specified in keywords. For example, use Harry%20Potter to search for items containing those words in any order. getDeals Yes Base response container for all service operations. Contains error information associated with the request. Indicates whether there are any errors or warnings associated with the processing of the request. Always Information for an error or warning that occurred when eBay processed the request. Not returned when responseStatus is Success. See <a href="http://developer.ebay.com/DevZone/merchandising/docs/CallRef/Errors/ErrorMessages.html" title="All error messages by code number">Errors by Number</a> for a list of errors and warnings that can be returned by Merchandising API calls. Conditionally Indicates the status of the call. The request was processed successfully without errors or warnings. Errors occurred that prevented the request from being processed successfully. The request was processed successfully, but some warnings were returned. Reserved for future use. Base response container for all service operations in the Merchandising Service. This is a response for operations that return item recommendations. Results consist of an itemRecommendations array containing one or more item containers. A list of items matching the given criteria. Item sort order is different for each call. Returned when there are items that match the search criteria. getDeals getMostWatchedItems getRelatedCategoryItems Always This is a response for calls that return Product Array of products. Recommendations. Returned when there are products that match the search criteria. getTopSellingProducts Conditionally This is a container for list of item recommendations. Contains details for a single recommended item. Returned when there is at least one item that matches the search criteria. getDeals getMostWatchedItems getRelatedCategoryItems Conditionally List of suggested products sorted by sales rank, with top selling products listed first. An eBay catalog product. This contains stock information about a particular DVD, camera, set of golf clubs, or other product. Returned when there is at least one product that matches the search criteria. getTopSellingProducts Conditionally Contains details for an active item listing. The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. 19 getDeals getMostWatchedItems getRelatedCategoryItems Always Name of the item as it appears in the listing or search results. 55 getDeals getMostWatchedItems getRelatedCategoryItems Always The URL of the web page where a user can view the listing. On the US site, this is called the "View Item" page. If you enabled affiliate tracking in the call, viewItemURL contains a string that includes affiliate tracking information (see the <a href="https://www.ebaypartnernetwork.com/">eBay Partner Network</a>). getDeals getMostWatchedItems getRelatedCategoryItems Always For competitive-bidding listings (Chinese and Dutch auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price, Store Inventory, or Ad type listings, this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised. getDeals getMostWatchedItems getRelatedCategoryItems Conditionally Original price of an item whose price a seller has reduced with the Promotional Price Display feature. Only returned if the price has been revised. getDeals getMostWatchedItems getRelatedCategoryItems Conditionally The site upon which the item is listed. Returns a Global ID, which is a unique identifier for combinations of site, language, and territory. For a list of possible enumeration values and how they map to eBay sites, see <a href="Enums/GlobalIdList.html">Global ID Values</a>. getDeals getMostWatchedItems getRelatedCategoryItems Conditionally Time left before the item listing ends. The duration is represented in the ISO 8601 duration format (PnDTnHnMnS). For ended listings, the time left is P0DT0H0M0S (zero days, zero hours, zero minutes, and zero seconds). getDeals getMostWatchedItems getRelatedCategoryItems Conditionally Numeric ID of the first (or only) category in which the item is listed. (Listings can appear in more than one category.) Note: Currently, the Merchandising API calls do not return a listing's secondary category, if any. 10 getDeals getMostWatchedItems getRelatedCategoryItems Conditionally Display name of the first (or only) category in which the item is listed. This is a fully qualified category breadcrumb (e.g., Computers & Networking:Laptops, Notebooks). 30 getDeals getMostWatchedItems getRelatedCategoryItems Conditionally Subtitle of the item. Only returned if the seller included a subtitle for the listing. 55 getDeals getMostWatchedItems getRelatedCategoryItems Conditionally The number of bids that have been placed on the item. getDeals getMostWatchedItems getRelatedCategoryItems Conditionally The Buy It Now Price of the item (if any), in the currency of the site on which the item was listed. For Chinese auctions (Quantity=1, competitive bidding online auctions), Buy It Now lets a user purchase the item at a fixed price and end the auction immediately. On most sites, after a Chinese auction has bids, the listing is no longer eligible for Buy It Now. However, calls can still return the Buy It Now Price that the seller set for the listing. Use the item.bidCount field to determine whether an auction with Buy It Now has bids or not. Some eBay sites also support Buy It Now for Dutch auctions (multi-quantity, competitive bidding), where you can buy multiple items from the same listing at a fixed price, instead of bidding. On some sites, the Buy It Now option remains available for Dutch auctions even after there are bids. For fixed-price (FixedPriceItem) and Store Inventory listings (StoresFixedPrice), see currentPrice instead. Only returned if an item was listed with Buy It Now. getDeals getMostWatchedItems getRelatedCategoryItems Conditionally Two-letter ISO 3166 country code to indicate the country where the item is located. For English names that correspond to each code (e.g., KY="Cayman Islands"), see the ISO site: <a href="http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html"> http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html</a>. getDeals getMostWatchedItems getRelatedCategoryItems Conditionally URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image. getDeals getMostWatchedItems getRelatedCategoryItems Conditionally The shipping cost associated with the first shipping service. Only returned when shipping type is flat. getDeals getMostWatchedItems getRelatedCategoryItems Conditionally The shipping cost model offered by the seller. <dl> <lh>Applicable values:</lh> <dt>Calculated</dt> <dd> Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts. </dd> <dt>CalculatedDomesticFlatInternational</dt> <dd> The seller specified one or more calculated domestic shipping services and one or more flat international shipping services. </dd> <dt>Flat</dt> <dd> Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller. </dd> <dt>FlatDomesticCalculatedInternational</dt> <dd> The seller specified one or more flat domestic shipping services and one or more calculated international shipping services. </dd> <dt>Free</dt> <dd> Free shipping: Seller has specified free shipping for the item. The cost of shipping is zero for the first domestic shipping service (for flat or calculated shipping). </dd> <dt>Freight</dt> <dd> Freight shipping model: The cost of shipping is determined by a third party, FreightQuote.com, based on the item location (zip code). </dd> <dt>NotSpecified</dt> <dd> The seller did not specify the shipping type. </dd> </dl> getDeals getMostWatchedItems getRelatedCategoryItems Conditionally The number of watches placed on this item from buyers' My eBay accounts. getMostWatchedItems Always An eBay catalog product. This contains stock information about a particular DVD, camera, set of golf clubs, or other product. The eBay or external IDs associated with the product. Use the Reference value as input to search for the same product in the future, or use the ISBN, EAN, or UPC value (if returned). The ISBN, EAN, and UPC values can also be useful as keys if your application is comparing products across different sites. 4000 getTopSellingProducts Always The title of the product, as specified in the catalog. Always returned when Product is returned. getTopSellingProducts Always Fully qualified URL for optional information about the product, such as a movie's description or film credits. This information is hosted through the eBay Web site and it cannot be edited. Portions of the content are protected by copyright. Applications can include this URL as a link in product search results so that end users can view additional descriptive details about the product. This is usually always returned when Product is returned, but it may be safest to check for the existence of this field. getTopSellingProducts Always Name of the catalog the product is in. Only returned if product is in a catalog. getTopSellingProducts Always Fully qualified URL for a stock image (if any) associated with the eBay catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. getTopSellingProducts Conditionally The total number of reviews available for this product on the eBay Web site. Always returned when product is returned. getTopSellingProducts Conditionally The lowest price for items listed as this product. getTopSellingProducts Conditionally The highest price for items listed as this product. getTopSellingProducts Conditionally Basic type for specifying monetary amounts. A double value (e.g.,1.00 or 1.0) is meaningful as a monetary amount when accompanied by a specification of the currency, in which case the value specifies the amount in that currency. An AmountType expresses both the value (a double) and the currency. Details such as prices, fees, costs,and payments are specified as amount types. Currency in which the monetary amount is specified. For a list of possible enumeration values, see <a href="Enums/currencyIdList.html.html">currencyId Values</a>. Always eBay uses the specified details to build a View Item URL and Product URL string in the response that includes your affiliate tracking information in the correct format. When a user clicks through the URL to eBay and performs certain tasks, you may get a commission. For information about commissions, see the <a href="https://www.ebaypartnernetwork.com/"> eBay Partner Network</a>. 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. No 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 commissions, see the <a href="https://www.ebaypartnernetwork.com/"> eBay Partner Network</a>. No 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". No Unique identifier for a product. Defines the type of ProductId. <dl> <lh>Enumeration Values:</lh> <dt> EAN </dt> <dd> EAN value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book. Max length of corresponding value: 13 </dd> <dt> ISBN </dt> <dd> ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book. Max length of corresponding value: 13 </dd> <dt> Reference </dt> <dd> The global reference ID for an eBay catalog product. A reference ID is a fixed reference to a product (regardless of version). Use this instead of CatalogItem when you know a product's reference ID (because older CatalogItem IDs are more likely to become obsolete over time.) One reference ID can be associated with multiple CatalogItem IDs. To determine valid reference IDs for products, first call FindProducts with QueryKeywords (or ProductID). Each product in the response includes a reference ID. </dd> <dt> UPC </dt> <dd> UPC value for products in Music (e.g., CDs), DVDs & Movies, and Video Games categories (or domains). If you know a product's UPC, you can use this instead of the eBay CatalogItem or Reference ID to search for that product. Max length of corresponding value: 12 </dd> </dl> getTopSellingProducts Always ErrorMessage to indicate any Error/Warning occured as part of service call. Any run time error will not be reported here, but will be reported aspart of soap fault. Details about a single error. Conditionally This represents error details. A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. Conditionally Name of the domain upon which the error occurred. <dl> <lh>Domains include:</lh> <dt> Marketplace </dt> <dd> A business or validation error occurred for the Merchandising Service. </dd> <dt> SOA </dt> <dd> An exception occurred in the Service Oriented Architecture (SOA) framework. </dd> </dl> Conditionally Indicates whether the error caused the request to fail (Error) or not (Warning). If the request fails and the source of the problem is within the application (such as a missing required element), please change the application before you retry the request. If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re- send the request to eBay. If the source of the problem is on eBay's side, you can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Conditionally There are three categories of errors: request errors, application errors, and system errors. Conditionally A detailed description of the condition that resulted in the error. Conditionally Name of the subdomain upon which the error occurred. <dl> <lh>Subdomains include:</lh> <dt> Merchandising </dt> <dd> The error is specific to the Merchandising service. </dd> <dt> MarketplaceCommon </dt> <dd> The error is common to all Marketplace services. </dd> </dl> Conditionally Unique identifier for an exception associated with an error. Conditionally Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. Conditionally Contextual information associated with an error. The name of the parameter in the list of parameter types returned within the error type. Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning. There are three categories of error: request errors, application errors, and system errors. Request and application errors are caused primarily by invalid data passed in the request. System errors are caused primarily by application failures and cannot be corrected by changing request values. Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. An error occurred due to a problem with the request, such as missing or invalid fields. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. Once the problem in the application or data is resolved, resend the corrected request to eBay. An error occurred due to a problem with the request, such as invalid or missing data. The problem must be corrected before the request can be made again. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the data is resolved, resend the request to eBay with the corrected data. 1.0.0