The main element of a GeneralSearch request. The main element of a search response. Indicates which API environment this response came from (e.g. 'production' or 'sandbox') The GeneralSearch request type containing all options available when constructing a GeneralSearch request, used to get categories, products, and offers matching provided search criteria. Contains information related to API usage and click tracking. Filter criteria must be provided in every request. You can filter by product ID or a combination of keywords and category ID. The ProductFilter element used for searching by product ID. The OfferFilter element used for searching by offer ID. The NavigationFilter element used for searching by keyword or category ID (or both). Contains all options for sorting GeneralSearch results. Contains a number of general options related to the GeneralSearch method. Contains a number of different parameters to aid the Shopping.com search engine in making relevance decisions. Contains information related to API usage and click tracking. SDC generated ID used for revenue tracking at the campaign (placement) level. Previously known as a "linkin ID". User generated ID used to further break down traffic sources beyond SDC campaign level tracking. The browser user-agent of the visitor to which this data is being presented. The IP Address of the visitor to which this data is being presented. The ProductFilter element used for searching by product ID. The product ID for which to return store offers. The NavigationFilter element used for searching by category ID. Can also include optional keyword and attribute filters. The category for which to return store offers. Currently, a leaf-level category ID must be provided for this type of search to succeed. A list of keywords and/or attribute elements possibly mixed together, in the order they were entered by the user. A search keyword entered by the user. An attribute element representing an attribute refinement made by the user. In general, not all applicable values of an attribute are returned by the search engine. Instead, the top N most relevant are presented. This element can be used to retrieve all applicable values for one particular attribute. Contains all options for sorting GeneralSearch results. As a GeneralSearch by keyword may return different results depending on the keyword, you may have to provide multiple sorting options. The attribute by which you would like to sort results in a product-only (productized) category. E.g. price, product rating, etc. Defaults to an ordering by popularity. The direction you would like to sort items in a product-only (productized) category. The attribute by which you would like to sort items in a offer-only (non-productized) category. E.g. price, store rating, etc. Defaults to an ordering which maximizes yield (relevance * bid). The direction you would like to sort items in a offer-only (non-productized) category. The attribute by which you would like to sort results from a mixed products and offers (soft-productized) category. E.g. price, popularity, etc. Defaults to an ordering by popularity. The direction you would like to sort results from a mixed products and offers (soft-productized) category. Whether to include the 'Smart Buy' offer at the top of the results in a offer-only (non-productized) category. (Will be returned below any 'Featured' offers if enabled.) The number of 'Featured' offers to return. Only used for results from a offer-only (non-productized) category with a offerSortType of 'featured-store'. The attribute by which you would like to sort product reviews. E.g. review date, product rating, etc. Defaults to an ordering by review date. The direction you would like to sort product reviews. Contains a number of general options related to the GeneralSearch method. The maximum number of categories you would like returned in a multiple category result. A default value can be set up for your account. The maximum number of items (items can be offers, products, or a mix of both) you would like returned per category. Also controls the number of offers returned when the result contains a single product. A default value can be set up for your account. The maximum number of store offers you would like returned per product when using the showProductOffers flag. A default value can be set up for your account. The maximum number of reviews you would like returned per product when using the showProductReviews flag. Only used if 'showProductReviews' is enabled. A default value can be set up for your account. The maximum number of attributes you would like returned. A default value can be set up for your account. The maximum number of attributes you would like returned along w/ the values for those attributes. For instance, you may request 10 attributes, but values for only 5 of those attributes. Will default to the number of attributes you've requested. The maximum number of values you would like returned per attribute. A default value can be set up for your account. The page number of the result set you would like returned. The page number of product reviews you would like returned. Only used if 'showProductReviews' is enabled, and applies to all products if multiple products are present in the response. The postal code entered by the user, used to calculate tax and shipping costs. Flag indicating whether keyword normalization (spell checking, stemming, etc.) should be performed. Flag indicating whether "skipping" should be enabled. Skipping is the process by which the search engine narrows the result set to a specific category or product due to the relevance of that category or product being much higher than the alternatives. Flag indicating whether items (products/offers) should be grouped by category when the search term is found in multiple categories. The default behavior in such a case is to present all items together in one long list, and allow filtering by category through the use of attributes. Flag indicating whether 'Soft Products' should be returned. Soft Products are those which were added to the SDC product catalog by a machine process which defines products by grouping together related store offers. If disabled, store offers will be returned in place of the soft products. Flag indicating whether store offers should be returned with every product. Flag indicating whether products without offers (e.g. pre-sale or obsolete products) should be included in search results. Flag indicating whether all matching categories should be returned in the results. Normally, only a limited number of matching categories are returned (based on relevance), or the system 'skips' to the most relevant category. Flag indicating if product information should be excluded from results. Flag indicating if product specifications should be returned for each product in the response. This may significantly increase response times when multiple products are present (which may be the case for any keyword or category search.) Flag indicating if product reviews should be returned for each product in the response. This may significantly increase response times when multiple products are present (which may be the case for any keyword or category search.) Flag used to enable debug information in the response. Use is restricted to requests from within SDC. The search result type containing all elements of a search result document. Information relating to the client side tracking mechanism. Information needed to create breadcrumb trails. Contains the matching SDC catalog information, beginning with categories, and optionally containing products, offers, etc as appropriate. Contains a list of search terms related to the query. Information about the state of the search engine index at the time of the search. Information regarding the client side tracking mechanism. An example implementation of this mechanism would look something like: Destination to which the tracking image should link. Title of the tracking image. Alternate text for the tracking image. Type of the tracking image, with possible values of "pixel" or "logo". Base type describing an image. URL of the image. Height of the image. Width of the image. Information to enable construction of breadcrumbs. Elements for constructing the category selection breadcrumb. Most of the time there will be three categorySelection elements: the top (grandparent) level category, mid (parent) level category, and leaf (child) level category. Elements for constructing the product selection breadcrumb. Elements for constructing the offer selection breadcrumb. Elements for constructing the 'Dynamic Navigation' breadcrumb. Dynamic Navigation is the process of combining keyword searches and the selection of relevant 'attributes' to narrow a given set of results. Base set of information describing a selected category from the SDC catalog. The name of the category for display purposes. A URL which links to the category page on the SDC site. Unique SDC ID for this category. A list of keywords and/or attribute elements possibly mixed together, in the order they were entered by the user. A keyword search element representing a keyword entered by the user. An attribute element representing an attribute refinement made by the user. Base set of information regarding an attribute in the SDC catalog. Like categories, attributes allow further refinement of a set of results, but are dynamic, and not part of the category tree. Examples of attributes are 'color' or 'size'. The name of the attribute for display purposes. A URL linking to the page on the SDC site which would result from selecting this attribute value along with any other previously selected filtering criteria. Unique SDC ID for this attribute. Indicates whether the attribute value originally entered by the user was dropped by the search engine. Contains SDC catalog information matching the query parameters. The list of matching categories, each of which may optionally contain their own lists of products, offers, refinement attributes, etc. The count of categories which matched the given query parameters. The count of categories actually present in this result set, which may be different from the matchedCategoryCount due to paging, relevance thresholds, etc. The actual matching category element, which makes up the list of all matching categories for the given query. The name of the category for display purposes. A URL which links to the category page on the SDC site. The list of items (products or offers) which match the given query parameters within this category. Used only in GeneralSearch responses. The list of matching attributes which can be used to furtner refine the item result set within this category. Used only in GeneralSearch responses. Indicates the type of items you should expect in this category (i.e. products, offers, or a mix of both.) The list of child categories - currently only used for the CategoryTree request. Unique SDC ID for this category. The list of items (products or offers) which match the given query parameters within this category. The list of matching products or offers (or a mix of both) within this category. Order will be determined by parameters provided in the request, or a default order which maximizes relevance and revenue. A matching product element. A matching store offer element. The count of items (products or offers) which matched the query parameters. The count of items actually present in this result set, which may be different from the matchedItemCount due to paging, relevance thresholds, etc. Indicates which page of items has been returned. The product element, which may be part of the list of all matching items within the current category. The name of the product for display purposes. A description of the product limited to ??? characters. May contain the full version of the truncated shortDescription element, or a different description entirely. The list of product image elements of different sizes. Information about the rating of the product according to Epinions and other sources. The lowest price at which the product is offered in the SDC catalog. The highest price at which the product is offered in the SDC catalog. A link to the page containing the list of offers for this product on the SDC site. A link to the page containing the specifications for this product on the SDC site. The list of store offer elements for this product. The complete specifications for this product. The review element containing all detailed review information for this product. The ID of the category to which this product belongs. Will only be provided when such information is not already clear by the response structure. The unique SDC ID for this product (not the MPN or UPC). The list of matching offers for a product. Order will be determined by parameters provided in the request, or a default order which maximizes relevance and revenue. An matching store offer element. The count of offers which matched the given query parameters. The count of offers actually present in this result set, which may be different from the matchedOfferCount due to paging, relevance thresholds, etc. Indicates which page of offers has been returned. A store offer, matching either an SDC product ID or category. The name of this store offer for display purposes. The description of this store offer. The manufacturer of this store offer. The list of offer image elements of different sizes. The stock status of this offer. An optional set of notes provided by the store describing the items condition, stock status, sale status, etc. The price of the offer before tax and shipping. The tax charge for this offer, based on the supplied postal code. The shipping charge for this offer, based on the supplied postal code (or flat shipping cost). The total offer price including tax and shipping (if available). The URL for this offer, which links to the offer on the stores site, after being tracked by SDCs servers. DO NOT MODIFY. The element representing the store providing this offer. The total cost to the store for a valid user click to this offer. The ID of the category to which this offer belongs. Will only be provided when such information is not already clear by the response structure. The ID of the product to which this offer belongs. Will only be provided when such information is not already clear by the response structure. The unique identifier of this offer on the merchant site, in case the merchant provides this information. A unique SDC ID for this offer. Indication of whether this offers is new or used. Indication of whether this offer is 'featured', meaning its order in the listing due to the merchants bid. Indication of whether this offer is considered the 'Smart Buy' by Shopping.com rules. The list of item (product or offer) image elements of different sizes. An item image element. Every item (product or offer) will have at least one 100x100 image, although that image may be a blank or 'no image' image. An item image element. Every item (product or offer) will have at least one 100x100 image, although that image may be a blank or 'no image' image. Indicates whether this image size is actually available, or if SDC will serve a blank or 'no image' image. Base price type extending from a simple decimal type. String indicating currency, conforming to ISO 4217 currency codes (e.g. USD). Indication of whether the price is available or 'known', or if the user needs to 'Check the site' for further pricing information. The element representing the store giving this offer. The name of this store for display purposes. Element providing the store logo. Element providing the store phone number. Information about the rating of this store according to Epinions. Element indicating the country in which this store is based, including a flag image. The unique SDC ID for this store. Indication of whether this store is considered a 'Trusted Store' by Shopping.com rules. Indication of whether this store is an 'authorized reseller' of this item. Element providing the store logo. Indicates whether the store logo is guaranteed to be available on the SDC image server. Store logos with 'available' set to false may actually still be present on the SDC image server, but only those with 'available' set to true are confirmed. URLs of store logos which do not actually exist on the image server will return a blank image. Information about the rating of the item (product or store) according to Epinions and other sources. The count of reviews for this item. If 0, then the rest of the elements in this structure will not appear. The actual rating (between 0 and 5) for this item. An SDC image representing the rating for this item. The URL linking to an Epinions page providing more detail about the rating of this item, including full review content. The list of matching attributes which can be used to furtner refine the item result set within this category. A matching attribute element which can be used to further refine the item result set within this category. The count of attributes which matched the query parameters. The count of attributes actually present in this result set, which may be different from the matchedAttributeCount due result set size limits, relevance thresholds, etc. An attribute element which can be used to further refine the item result set within this category. The name of the attribute for display purposes. A URL linking to the page on the SDC site which displays all values for this attribute applicable to the current result set. The list of values for this attribute which are found in the result set. Unique SDC ID for this attribute. The list of values for this attribute which are found in the result set. An attribute value element which can be used to furtner refine the item result set within this category. The count of values for this attribute which are found in the result set. The count of values for this attribute actually present in this result set, which may be different from the matchedValueCount due to query parameters or result set size limits. An attribute value element which can be used to further refine the item result set within this category. Examples of attributes are 'color' or 'size', while examples of attribute values are 'red' or '2'. The name of the attribute value for display purposes. A URL linking to the page on the SDC site which would result from selecting this attribute value along with any other currently selected filtering criteria. The unique SDC ID for this attribute value. This ID will need to be sent as part of the query when a user selects this attribute for refinement of the result set. The count of items in the result set to which this attribute value applies. A collection of one or more search terms related to this result set. A single search term related to this result set. Enumeration of sort types for a list of products Enumeration of sort orderings. Enumeration of sort types for a list of offers Enumeration of sort types for a hybrid list of products and offers Enumeration of the possible values of the client side tracking element type. Enumeration of the possible values of the stock status of an offer. Contains information about the state of the search engine index at the time of the search. The number of live merchants in the search engine index at the time of the request. The number of products in the search engine index at the time of the request. Enumeration of the category types, which indicates the type of items you should expect in this category (products = productized, offers = non-productized, hybrid = soft-productized, categories = parent level category.) Information regarding a keyword originally entered by the user, and the resulting keyword actually used for the search. The original keyword entered by the user. The resulting keyword after any normalization steps, in the form actually used by the search engine. Indicates whether the keyword originally entered by the user was changed in any way (spell checked, tokenized, etc.) Indicates whether the keyword originally entered by the user was dropped by the search engine Country flag image element, providing an image of the countrys flag, as well as the ISO 3166 country code. String indicating the ISO 3166 country codes (e.g. US). Set of information describing a selected product from the SDC catalog. The name of the product for display purposes. A URL which links to the products page on the SDC site. Unique SDC ID for this product. Indication of whether the selected product was dropped (invalid, not found, etc.) The main element of a CategoryTree request. The CategoryTree request type containing all options available when constructing a CategoryTree request, used to get the hierarchy of categories relative to a specified category ID (or the entire tree.) Contains information related to API usage and click tracking. The categoryFilter element used for limiting the category tree response to a subset of the entire tree. If this element is not defined, the API will use categoryId '0', meaning the returned tree will start from the root. Contains a number of general options related to the CategoryTree method. The CategoryFilter element used for limiting the category tree response to a subset of the entire tree. The category ID to which the category tree response should be limited. Must be a valid SDC category ID, or '0' for the entire tree. Contains a number of general options related to the CategoryTree method. Flag indicating if all descendants of the specified category should be returned. Normally, only the immediate children are returned. The category tree result type containing all elements of a category tree document. Information relating to the client side tracking mechanism. Information needed to create breadcrumb trails. The category element providing information for the requested category, as well as the list of child categories (if any.) The main element of a category tree response. Information to enable construction of breadcrumbs. Elements for constructing the category selection breadcrumb. The complete specifications for a product. A grouped list of features for a product. Multiple feature groups make up the complete product specifications. A grouped list of features for a product. Multiple feature groups make up the complete product specifications. The name of this group of product features. An individual product feature which comprises a product specifications feature group. An individual product feature which comprises a product specifications feature group. The name of this product feature. E.g. "Broadcast Format Supported". The (optional) description of this product feature. The actual value(s) of this product feature. A feature may have multiple values. E.g. "1080p", "1080i", etc. Enumeration of sort types for product reviews. The list of reviews for a product. If at least 1 review has been written, the first element will contain the averages of all ratings from the individual review elements. The element consisting of the averages of all individual review ratings. The element containing the details of the individual consumer review. A link back to Epinions where the user can write their own review. The count of individual reviews for this product. The count of individual reviews actually present in this result set (for this product), which may be different from the matchedReviewCount due to paging. Indicates which page of reviews has been returned. The element containing the details of the individual consumer review. The ID of the review author (generally an Epinions ID). The date this review was posted. The element consisting of the overall and individual feature ratings in this review. The '1 line' summary for this review. I.e. the review title. The summary of the list of pros in the review for this entity. The summary of the list of cons in the review for this entity. The overall summary of the review. The actual review content which comprises the bulk of the review. May be truncated, in which case a link should be provided to the complete review, using the 'fullReviewURL' element. A link back to the full review content on Shopping.com or Epinions. Element containing a rating broken down into individual features (e.g. 'Battery Life', 'Ease of Use' or 'Customer Service'). The overall rating for this entity. The list of individual feature ratings for this entity. An individual feature rating for this entity. The name of this feature being rated. The rating value for this feature. Contains a number of different parameters to aid the Shopping.com search engine in making relevance decisions. A term (word or phrase) related to the search. A term (word or phrase) which could be used as an alternative to the provided keyword. A breadcrumb trail consisting of a hyphen ('-') separated list of the partners category IDs. The name of a single item to which this query relates. The price of a single item to which this query relates. A value between 0 and 1 indicating the probability of the consumer purchasing an item on which they click. The OfferFilter element used for searching by offer ID. The offer ID for which to return offer details. Set of information describing a selected offer from the SDC catalog. The name of the offer for display purposes. A URL which links to the offer page on the SDC site. Unique SDC ID for this offer. Indication of whether the selected offer was dropped (invalid, not found, etc.)