Products list retrieval / product search

Query by / products / search followed by key / value pairs that describe the search filter.

  • Each key may only occur once
  • The order of the key / value pairs does not matter
  • Key and Value are separated by an equals sign ( '=')
  • Key / Value pairs are separated by semicolons ( ';')
  • There are predefined keys, other entries make the URL invalid
  • Inside the Value Part the common URL Characters must be escaped, a space with the escape character %20,  hashtag ('#') with the escape character '%23', a slash ('/') with the escape character '%2F', and so on...
  • Note: If there are still no entries found, then also the URL Character % must be explicitly escaped the the escape character %25 (doule escaping), e.g. %2F as %252F.
  • Key for a maximum of 50 values are specified, the per comma ( ',') separated

Search filter keys

  • Keywords: free search
    • Do not replace blanks with + but %20 e.g. a search for Lenovo Thinkpad I5 is equivalent to Lenovo%20Thinkpad%20I5 and not Lenovo+Thinkpad+I5
  • Ean: a product EAN
  • Puid: ITscope ID
  • Plzid: Reference source number
  • Pid: internal ITscope ID
  • Cnetid: Cnet product number
  • Hstpid: manufacturer number, SKU (should be used together with manufacturer or with keywords to restrict the manufacturer name)
  • Distpid: Product number of the distributor
  • Id: is interpreted as one of the internal ITscope IDs, with regression option on puid
  • Manufacturer (MAN): unique identification of the manufacturer
  • Producttype (SET): unique identifier of the product category
  • Distributor (PRL): unique identification of the supplier
  • Cluster (CLU): unique identifier of the property cluster


The resulting list can be empty, contain exactly one product, or multiple.

 

Query parameter plzproducts

This query parameter can also pricelist line products are found and displayed. These products have the ITscope online platform extension 999. This parameter is therefore not set by default false.

Query parameter realtime

With this query parameter, the realtime query is performed for all prices at the respective vendors. Vorraustzung for a realtime retrieval is successfully equipped realtime e-Service at the respective supplier.

Realtime price schedules can from load reasons, as these are passed directly to the interface of the supplier, only for ProductID queries with the following keys ean, puid, plzid, pid, cnetid, hstpid, distpid, id be used with a maximum total of 10 IDs .

Realtime price schedules can take up to 5 seconds, as these are passed directly to the interface of the supplier and up to 5 seconds to wait for the response from the supplier. This means that no real-time price can be loaded if the limit of 5 seconds is exceeded. Then the idividual price list price or the standard price is returned.

Query parameter sort

Product search can be sorted according to specific criteria.

Here is a list of the sorting criteria and their meaning:

  • DEFAULT: by relevance descending, no relevance is available, then analogous to IRANK.
  • PRICE_ASC: ascending price
  • PRICE_DESC: by price descending
  • SOURCES_COUNT: descending by number of sources
  • STOCK: according to stock descending
  • MANUFAKTURER_SKU: according to manufacturer article number descending
  • NAME_ASC: by product name ascending
  • NAME_DESC: by product name descending
  • QUAL: to qualify the product descending
  • TOPSELLER: by Top Product Rank (clicks last 4 weeks) descending
  • EXACT: after exact productId hit descending
  • IRANK: descending by general popularity rank, see field rank in format descriptions for products

 

Query parameter for historical data

Historical data and the appropriate request parameters are available in the API 2.1.

 

 

Examples- Mass query up to 50 results

Searching for more than one ITscope productIds:

https://api.itscope.com/2.0/products/search/puid=3534638001,2069677000,2650828000,4201083000/standard.xml

In this example following productIds are searched:3534638001, 2069677000, 2650828000, 4201083000. Up to 50 ITscope productsId can be added to one such search request.

 

Searching for more than one EAN:

https://api.itscope.com/2.0/products/search/ean=5032037044288,7636490025914,8806086522977/standard.xml

In this example following EAN are searched:5032037044288, 7636490025914, 8806086522977. Up to 50 EAN can be added to one such search request.

 

Searching for more than one manufacturer part number:

https://api.itscope.com/2.0/products/search/hstpid=0553C001AA,N9J71AE%23301,CLT-P406B%2FELS/standard.xml

In this example following manufacturer part number are searched: 0553C001AA, N9J71AE#301, CLT-P406B/ELS. Up to 50 manufacturer part number can be added to one such search request.

Note: If there are still no entries found, then also the URL Character % must be explicitly escaped the the escape character %25 (doule escaping), e.g. %2F as %252F.

e.g. the character # as %23 -> %2523, or the character / as %2F -> %252F

  

Examples - Filter combinationen 

Search all products with match a manufacturer part number:
https://api.itscope.com/2.0/products/search/hstpid=A7E34AA%2523ABB/standard.xml

In this example, the manufacturer part number A7E34AA#ABB also the # was escaped by '%23', because of the # in the URL has a special meaning and can not be transferred unescaped.

Note: If there are still no entries found, then also the URL Character % must be explicitly escaped the the escape character %25 (doule escaping), e.g. %2F as %252F.

e.g. the character # as %23 -> %2523, or the character / as %2F -> %252F

 

Search for all products that match a manufacturer and a manufacturer part number:

eg: Manufacturer Samsung (Id: 1015 determined on manufacturer API polling ) and manufacturer part number MZ-75E250B/EU

https://api.itscope.com/2.0/products/search/hstpid=MZ-75E250B%252FEU;manufacturer=1015/standard.xml

In this example, the manufacturerpart number "MZ-75E250B/EU" also the  / character was escaped  by '% 2F', as the / character in the URL has a special meaning and can not be transferred unescaped.

Note: If there are still no entries found, then also the URL Character % must be explicitly escaped the the escape character %25 (doule escaping), e.g. %2F as %252F.

e.g. the character # as %23 -> %2523, or the character / as %2F -> %252F

 

Suche nach allen Produkten, die zu einer Kategorie, einem Hersteller und bestimmten Eigenschaftclustern passen:
https://api.itscope.com/2.0/products/search/producttype=114;manufacturer=1032;cluster=2404144;cluster=1061/standard.xml

In diesem Beispiel werden Produkte gesucht, in der Kategorie Festplatten (producttype=114), vom Hersteller Seagate (manufacturer=1032) und den Eigenschaftscluster Baugrösse 2,5" (cluster=1061) und Speicherkapazität 4TB (cluster=2404144).

Die ITscope Ids der Hersteller kann über die Hersteller Metadaten API geladen werden.

Die ITscope Ids der Kategorie kann über die Kategorien Metadaten API geladen werden.

Die ITscope Ids der Eigenschaftscluster kann, mit der entsprechenden Berechtigung, über einen Export oder Produkt-Request geladen werden. Es werden jedoch nur die Eigenschaftscluster ausgegeben die den im Requestergebnis befindlichen Produkte entsprechen. Es gibt derzeit keine Möglichkeit per API eine komplette Liste von Eigenschaftsclustern zu erhalten.

  

Examples - Keyword search

Keywordsearch
https://api.itscope.com/2.0/products/search/keywords=lenovo%20thinkpad%20i5/standard.xml
In this example Lenovo Thinkpad I5 is searched.

 

Combine a category search with keyword search
https://api.itscope.com/2.0/products/search/producttype=114;keywords=SATA-600/standard.xml
Combine filters provides the trim of the individual filters. In this example, only SATA-600 hard disks are searched for

 

 

Note: This page has been translated with the Google Translation Service.

Have more questions? Submit a request