{"id":1888,"date":"2020-09-22T13:39:08","date_gmt":"2020-09-22T13:39:08","guid":{"rendered":"https:\/\/support.itscope.hostpress.me\/?post_type=kb&#038;p=1888"},"modified":"2025-10-01T19:27:09","modified_gmt":"2025-10-01T17:27:09","slug":"products-search-method","status":"publish","type":"kb","link":"https:\/\/guide.itscope.com\/en\/kb\/products-search-method\/","title":{"rendered":"products\/search method"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\">Product list retrieval\/product search<\/h2>\n\n\n\n<p>Abfrage per \/products\/search gefolgt von Key\/Value-Paaren, die den Suchfilter beschreiben.<\/p>\n\n\n\n<p>A call in the form of \/products\/search followed by key\/value pairs describing the search filter:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>each key may only occur once<\/li>\n\n\n\n<li>the order of the key\/value pairs does not matter<\/li>\n\n\n\n<li>key and value are separated by an equal sign (&#8216;=&#8217;)<\/li>\n\n\n\n<li>key\/value pairs are separated from each other using semicolons (&#8216;;&#8217;)<\/li>\n\n\n\n<li>predefined keys must be used as other entries invalidate the URL<\/li>\n\n\n\n<li>for the values, HTML request invalid characters must be masked as follows: a space should be masked with the code %20, a hashtag (&#8216;#&#8217;) with the code &#8216;%23&#8217;, a slash (&#8216;\/&#8217;) with the code &#8216;%2F&#8217; etc.\n<ul class=\"wp-block-list\">\n<li><strong>please note<\/strong>: if, despite masking, no products can be found, then the % character in the masked codes may need to be explicitly coded with a %25 again (double-coding). For example, %2F would then be coded as %252F<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>up to&nbsp;<strong>50 values \u200b\u200bcan be<\/strong>&nbsp;specified for a key, separated by a comma (&#8216;,&#8217;)<br><\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">Search filter keys<\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li>keywords: free search text\n<ul class=\"wp-block-list\">\n<li>do not replace spaces with +, instead use %20. For example, a search for the Lenovo Thinkpad I5 would be structured as Lenovo%20Thinkpad%20I5 and not Lenovo+Thinkpad+I5<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>ean: a product EAN<\/li>\n\n\n\n<li>cnetid: 1WorldSync product number (formerly known as CNET)<\/li>\n\n\n\n<li>hstpid: manufacturer number, SKU (should be used in combination with &#8216;manufacturer&#8217; or with keywords to limit the manufacturer&#8217;s name)<\/li>\n\n\n\n<li>distpid: product number of the distributor<\/li>\n\n\n\n<li>manufacturer (MAN): unique identifier of the manufacturer<\/li>\n\n\n\n<li>producttype (SET): unique identifier of the product category<\/li>\n\n\n\n<li>distributor (PRL): unique identifier of the supplier<\/li>\n\n\n\n<li>cluster (CLU): unique identifier of the property cluster<\/li>\n<\/ul>\n\n\n\n<p>The resulting list can either be empty, contain exactly one product or contain up to 50 products.<br><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Query parameter page<\/h2>\n\n\n\n<p>The &#8216;page&#8217; query parameter allows the next 50 products to be requested for search results with &gt;50 products.<\/p>\n\n\n\n<p>For example, &#8216;page = 3&#8217; would request products 101 to 150.<\/p>\n\n\n\n<p><a href=\"https:\/\/api.itscope.com\/2.1\/products\/search\/hstpid=MZ-75E250B%252FEU;manufacturer=1015\/standard.xml?page=3\">https:\/\/api.itscope.com\/2.1\/products\/search\/hstpid=MZ-75E250B%252FEU;manufacturer=1015\/standard.xml?page=3<\/a><\/p>\n\n\n\n<p>No information regarding how many products were found is provided in advance during the first request, meaning it is necessary to work with page = xx until there are no more products in order to reach the end of the list.<br><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Query parameter item<\/h2>\n\n\n\n<p>The &#8216;item&#8217; parameter allows&nbsp;you to retrieve the <em>nth<\/em>&nbsp;data set.<\/p>\n\n\n\n<p>For example, if page = 2 and item = 3, this would retrieve the 3rd result from the 2nd page from a list of (e.g.) 90 products.&nbsp;As each page contains 50 results, this example would return the 53rd result from the list.<\/p>\n\n\n\n<p><a href=\"https:\/\/api.itscope.com\/2.1\/products\/search\/hstpid=MZ-75E250B%252FEU;manufacturer=1015\/standard.xml?page=2&amp;item=3\">https:\/\/api.itscope.com\/2.1\/products\/search\/hstpid=MZ-75E250B%252FEU;manufacturer=1015\/standard.xml?page=2&amp;item=3<\/a><\/p>\n\n\n\n<p>The item number can only be between 1 and 50, i.e. the item number does not depend on the parameter page.<br><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Query Parameter plzproducts<\/h2>\n\n\n\n<p>You can use the &#8216;plzproducts&#8217; query parameter to find and display&nbsp;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/qualification-of-the-product\/\">price list lines<\/a>.&nbsp;These products end with a &#8216;999&#8217; on the ITscope online platform. This parameter is&nbsp;<strong>false<\/strong>&nbsp;by&nbsp;<strong>default<\/strong>, i.e. not set.<br><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Query parameter sort<\/h2>\n\n\n\n<p>Product searches can be sorted according to specific criteria.<\/p>\n\n\n\n<p>Here is a list of sorting criteria including an explanation:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>DEFAULT: descending by relevance. If there is no relevance, then IRANK is used<\/li>\n\n\n\n<li>PRICE_ASC: ascending price<\/li>\n\n\n\n<li>PRICE_DESC: descending price<\/li>\n\n\n\n<li>SOURCES_COUNT: descending by number of sources<\/li>\n\n\n\n<li>STOCK: descending according to stock level<\/li>\n\n\n\n<li>MANUFACTURER_SKU: descending according to manufacturer&#8217;s article number<\/li>\n\n\n\n<li>NAME_ASC: ascending by product name<\/li>\n\n\n\n<li>NAME_DESC: descending by product name<\/li>\n\n\n\n<li>QUAL: descending according to&nbsp;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/qualification-of-the-product\/\">qualification of the product<\/a><\/li>\n\n\n\n<li>TOPSELLER: descending according to top product rank (number of clicks in the last 4 weeks)<\/li>\n\n\n\n<li>EXACT: descending according to exact productId hits<\/li>\n\n\n\n<li>IRANK: descending by popularity ranking, see&nbsp;&#8216;<strong>rank<\/strong>&#8216; field&nbsp;in&nbsp;<a href=\"https:\/\/guide.itscope.com\/en\/kbtopic\/api-export-data-formats-product-data\/\">format descriptions for products<\/a><br><\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">Query parameter for filtering based on product entry date<\/h2>\n\n\n\n<p>These request parameters are only available starting with&nbsp;<strong>API 2.1<\/strong>.&nbsp;These parameters filter according to the entryDate export field for the product, see the&nbsp;relevant&nbsp;<a href=\"https:\/\/guide.itscope.com\/en\/kbtopic\/api-export-data-formats-product-data\/\">format descriptions for products<\/a>&nbsp;for more information.&nbsp;The entry date indicates when the product was added to the ITscope catalogue and not when it was last modified.&nbsp;It is therefore not possible to use these parameters to search for recently modified products.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>productEntryFrom<\/strong>: the start date for the filtering of the product&nbsp;<strong>entry date<\/strong>&nbsp;period in the format&nbsp;<strong>yyyy-MM-dd<\/strong>.&nbsp;Only if this parameter is set will the products be filtered by the entry date period.&nbsp;The time is always 00:00:00.<\/li>\n\n\n\n<li><strong>productEntryTo<\/strong>: the end date for the restriction of the product&nbsp;<strong>entry date<\/strong>&nbsp;period in the format&nbsp;<strong>yyyy-MM-dd<\/strong>.&nbsp;If no value is specified, the current date is taken as the default value. The time is always 00:00:00.&nbsp;The value cannot be less than&nbsp;<strong>productEntryFrom<\/strong>, i.e. the date cannot be before&nbsp;<strong>productEntryFrom<\/strong>.<br><\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">Query parameters for historical data<\/h2>\n\n\n\n<p><a href=\"https:\/\/guide.itscope.com\/en\/kb\/historical-data\/\">Historical data and the corresponding request parameters<\/a>&nbsp;are only available starting with&nbsp;<strong>API 2.1<\/strong>.<br><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Examples &#8211; mass queries up to 50 items<\/h2>\n\n\n\n<p><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">When using more than 50 items in a request, you will get an 400 Bad Request error.<\/mark><\/p>\n\n\n\n<p><strong>Looking for a range of ITscope product IDs<\/strong>:<\/p>\n\n\n\n<p>This search can be achieved by using the <a href=\"https:\/\/guide.itscope.com\/en\/kb\/products-id-method\/\">products\/id and products\/ids api methods<\/a>.<br><\/p>\n\n\n\n<p><strong>Search for a series of EANs<\/strong>:<\/p>\n\n\n\n<p><a href=\"https:\/\/api.itscope.com\/2.1\/products\/search\/ean=8806086522977,7636490025914,0194252515587\/standard.xml\">https:\/\/api.itscope.com\/2.1\/products\/search\/ean=5032037044288,7636490025914,8806086522977\/standard.xml<\/a><\/p>\n\n\n\n<p>This example looks for the following EANs: 8806086522977, 7636490025914, 0194252515587. Up to 50 EANs can be specified in a single request.<br><\/p>\n\n\n\n<p><strong>Looking for a number of manufacturer item numbers<\/strong>:<\/p>\n\n\n\n<p><a href=\"https:\/\/api.itscope.com\/2.1\/products\/search\/hstpid=0553C001AA,N9J71AE%23301,CLT-P406B%2FELS\/standard.xml\">https:\/\/api.itscope.com\/2.1\/products\/search\/hstpid=0553C001AA,N9J71AE%23301,CLT-P406B%2FELS\/standard.xml<\/a><\/p>\n\n\n\n<p>In this example, we are looking for the following manufacturer item numbers: 0553C001AA, N9J71AE#301, CLT-P406B\/ELS.&nbsp;Up to 50 manufacturer item numbers can be specified in one request.<\/p>\n\n\n<div class=\"mkb-shortcode-container\">        <div class=\"mkb-tip\">\n            <div class=\"mkb-tip__icon\">\n                <i class=\"fa fa-lightbulb-o fa-lg\"><\/i>\n            <\/div>\n            <div class=\"mkb-tip__content\">\n                <strong>Note:<\/strong> if, despite masking, no products are found, then the % characters in the masked codes may need to be explicitly encoded with %25 again (double-coding).<br><br>For example, the character &#8216;#&#8217; as %23 -&gt; %2523, or the character &#8216;\/&#8217; as %2F -&gt; %252F            <\/div>\n        <\/div>\n        <\/div>\n\n\n<p><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Examples &#8211; filter combinations<\/h2>\n\n\n\n<p><strong>Looking for all products that match a manufacturer and their manufacturer item number:<\/strong><\/p>\n\n\n\n<p>e.g.: Samsung as the manufacturer (ID: 1015, this can be found via the&nbsp;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/company-metadata-methods\/\">manufacturer API call<\/a>) and manufacturer item number MZ-75E250B\/EU<\/p>\n\n\n\n<p><a href=\"https:\/\/api.itscope.com\/2.1\/products\/search\/hstpid=MZ-75E250B%252FEU;manufacturer=1015\/standard.xml\">https:\/\/api.itscope.com\/2.1\/products\/search\/hstpid=MZ-75E250B%252FEU;manufacturer=1015\/standard.xml<\/a><\/p>\n\n\n\n<p>Additionally, in this example with manufacturer item number &#8216;MZ-75E250B\/EU&#8217;, the \/ sign was masked by &#8216;%2F&#8217; as the &#8216;\/&#8217; sign has a special meaning in the URL and cannot be unmasked.<\/p>\n\n\n<div class=\"mkb-shortcode-container\">        <div class=\"mkb-tip\">\n            <div class=\"mkb-tip__icon\">\n                <i class=\"fa fa-lightbulb-o fa-lg\"><\/i>\n            <\/div>\n            <div class=\"mkb-tip__content\">\n                <strong>Note:<\/strong> if, despite masking, no products are found, then the % characters in the masked codes may need to be explicitly coded with %25 again (double-coding), for example %2F as %252F            <\/div>\n        <\/div>\n        <\/div>\n\n\n<p><strong>Searching all products that match a manufacturer&#8217;s item number<\/strong>:<br><em><a href=\"https:\/\/api.itscope.com\/2.1\/products\/search\/hstpid=A7E34AA%2523ABB\/standard.xml\">https:\/\/api.itscope.com\/2.1\/products\/search\/hstpid=A7E34AA%2523ABB\/standard.xml<\/a><\/em><\/p>\n\n\n\n<p>Additionally, in this example with manufacturer item number &#8216;A7E34AA#ABB&#8217;, the &#8216;#&#8217; character was masked using a &#8216;%23&#8217; as the &#8216;#&#8217; character has a special meaning in the URL and cannot be unmasked.<\/p>\n\n\n<div class=\"mkb-shortcode-container\">        <div class=\"mkb-tip\">\n            <div class=\"mkb-tip__icon\">\n                <i class=\"fa fa-lightbulb-o fa-lg\"><\/i>\n            <\/div>\n            <div class=\"mkb-tip__content\">\n                <strong>Note:<\/strong> if, despite masking, no products are found, then the % characters in the masked codes may need to be explicitly coded with %25 again (double-coding), e.g. %23 as %2523            <\/div>\n        <\/div>\n        <\/div>\n\n\n<p><strong>Searching for all products that fit a category, a manufacturer, and specific property clusters<\/strong>:<br><a href=\"https:\/\/api.itscope.com\/2.1\/products\/search\/producttype=114;manufacturer=1032;cluster=2404144;cluster=1061\/standard.xml\n\"><em>https:\/\/api.itscope.com\/2.1\/products\/search\/producttype=114;manufacturer=1032;cluster=2404144;cluster=1061\/standard.xml<\/em><br><\/a><br>This example looks for products in the &#8216;disk&#8217; category (producttype = 114), from Seagate (manufacturer ID = 1032), &#8216;size 2.5&#8243;&#8216; as the property cluster (cluster = 1061) and 4TB storage capacity (cluster = 2404144).<\/p>\n\n\n\n<p>The ITscope IDs of the manufacturers can be retrieved via the&nbsp;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/company-metadata-methods\/\">manufacturer metadata API<\/a>.<\/p>\n\n\n\n<p>The ITscope IDs of the categories can be loaded via the&nbsp;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/products-producttypes-metadata-method\/\">categories metadata API<\/a>.<\/p>\n\n\n\n<p>The ITscope IDs of the property clusters can, with the&nbsp;<strong><a href=\"https:\/\/guide.itscope.com\/en\/kb\/api-limitations\/\">appropriate authorisation<\/a><\/strong>, be retrieved via an&nbsp;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/products-methods\/\">export<\/a>&nbsp;or&nbsp;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/products-search-method\/\">product request<\/a>.&nbsp;However, only property clusters that correspond to the products in the&nbsp;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/data-formats-and-output-formats\/\">retrieval result<\/a> are output.&nbsp;<strong>There is currently no way to get a complete list of property clusters via API.<\/strong><br><\/p>\n\n\n\n<p><strong>Searching for all products that match a category, manufacturer, and specific entry date period<\/strong>:<\/p>\n\n\n\n<p><a href=\"https:\/\/api.itscope.com\/2.1\/products\/search\/producttype=114;manufacturer=1032\/standard.xml?productEntryFrom=2019-11-01\n\"><em>https:\/\/api.itscope.com\/2.1\/products\/search\/producttype=114;manufacturer=1032\/standard.xml?productEntryFrom=2019-11-01<\/em><br><\/a><br>This example looks for products in the &#8216;disk&#8217; category (producttype = 114), from Seagate (manufacturer = 1032) and an entry date between 01.11.2019 and the current date of the request.<\/p>\n\n\n\n<p><a href=\"https:\/\/api.itscope.com\/2.1\/products\/search\/producttype=114;manufacturer=1032\/standard.xml?productEntryFrom=2019-11-01&amp;productEntryTo=2019-12-01\n\"><em>https:\/\/api.itscope.com\/2.1\/products\/search\/producttype=114;manufacturer=1032\/standard.xml?productEntryFrom=2019-11-01&amp;productEntryTo=2019-12-01<\/em><br><\/a><br>This example looks for products in the &#8216;disk&#8217; category (producttype = 114), from Seagate (manufacturer = 1032), and an entry date between 01.11.2019T00:00:00 and 01.12.2019T00:00:00.<\/p>\n\n\n\n<p>The ITscope IDs of the manufacturers can be retrieved via the <a href=\"https:\/\/guide.itscope.com\/en\/kb\/company-metadata-methods\/\">manufacturer metadata API<\/a>.<\/p>\n\n\n\n<p>The ITscope IDs of the categories can be loaded via the <a href=\"https:\/\/guide.itscope.com\/en\/kb\/products-producttypes-metadata-method\/\">categories metadata API<\/a>.<br><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Examples &#8211; free text search<\/h2>\n\n\n\n<p><strong>Carrying out a free text search<\/strong><br><a href=\"https:\/\/api.itscope.com\/2.1\/products\/search\/keywords=lenovo%20thinkpad%20i5\/standard.xml\n\">https:\/\/api.itscope.com\/2.1\/products\/search\/keywords=lenovo%20thinkpad%20i5\/standard.xml<br><\/a>The example above carries out a search for a Lenovo Thinkpad I5.<br><\/p>\n\n\n\n<p><strong>Combine a category search with a free text search<\/strong><br><a href=\"https:\/\/api.itscope.com\/2.1\/products\/search\/producttype=114;keywords=SATA-600\/standard.xml\n\">https:\/\/api.itscope.com\/2.1\/products\/search\/producttype=114;keywords=SATA-600\/standard.xml<br><\/a>Combining filters provides the overlapping results of the individual filters.&nbsp;In the example above, hard-drives with SATA-600 interface are specified.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Product list retrieval\/product search Abfrage per \/products\/search gefolgt von Key\/Value-Paaren, die den Suchfilter beschreiben. A call in the form of \/products\/search followed by key\/value pairs describing the search filter: Search &#8230;<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"kbtopic":[182],"kbtag":[],"class_list":["post-1888","kb","type-kb","status-publish","hentry","kbtopic-api-methods-products-metadata"],"_links":{"self":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/1888","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb"}],"about":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/types\/kb"}],"author":[{"embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/comments?post=1888"}],"version-history":[{"count":13,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/1888\/revisions"}],"predecessor-version":[{"id":19358,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/1888\/revisions\/19358"}],"wp:attachment":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/media?parent=1888"}],"wp:term":[{"taxonomy":"kbtopic","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtopic?post=1888"},{"taxonomy":"kbtag","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtag?post=1888"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}