PRODUCTS LIST RETRIEVAL / PRODUCT SEARCH

Query per / products / search followed by key / value pairs describing 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 equal sign ('=')
  • Key / value pairs are separated by semicolons (';')
  • there are predefined keys, other entries invalidate the URL
  • in the Value HTML request invalid characters must be masked, a space by the code% 20, a gate ('#') by the code '% 23', a slash ('/') by the code '% 2F', etc.
  • Note: 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), eg% 2F as% 252F.
  • For a key, up to 50 values ​​can be specified, separated by a comma (',')

SEARCH FILTER KEYS

  • keywords: free search text
    • Do not replace spaces with +, but% 20 eg a search for Lenovo Thinkpad I5 equals 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 with manufacturer or with keywords to limit the manufacturer's name)
  • distpid: Product number of the distributor
  • id: is interpreted as one of the internal ITscope IDs, with fallback option on puid
  • manufacturer (MAN): unique identifier of the manufacturer
  • producttype (SET): unique identifier of the product category
  • distributor (PRL): unique identifier of the supplier
  • cluster (CLU): unique identifier of the property cluster


The resulting list can be empty, containing exactly one product or more than 50.

QUERY PARAMETER PAGE

With the parameter page it is possible for a search result> 50 products to request the next 50 products.

eg: page = 3, means show me the products 101 to 150.

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

There is no statement in advance in the first request about how many products were found, ie it is necessary to work with page = xx until there are no more products to reach the end of the list.

QUERY PARAMETER ITEM

With the parameter item it is possible to get exactly the xth record for a search result.

eg: at page = 2, item = 3, you get from a list of eg 90 products, exactly the 3rd record on the 2nd page. At 50 records per page, it would then be the 53 record in the example.

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

The item number can only be between 1 and 50, ie the item number is not dependent on the parameter page.

QUERY PARAMETER PLZPRODUCTS

You can also use this query parameter to find and display price list lines. These products have the extension 999 in the ITscope online platform. This parameter is false by default , ie not set.

QUERY PARAMETER REALTIME

With this query parameter, real-time queries are performed for all prices at the respective suppliers. Prerequisite for a real-time call is a successfully set up real-time e-service at the respective suppliers.

Real-time price requests can only be used for ProductID requests with the following keys: ean, puid, plzid, pid, cnetid, hstpid, distpid, id with a maximum of 10 IDs for load reasons, as these are forwarded directly to the supplier's interface.

Real-time price calls can also take up to 5 seconds because they are forwarded directly to the supplier's interface and the supplier's response is waited up to 5 seconds. This means that it is also possible that no real-time price can be charged if the limit of 5 seconds is exceeded. Then the individual price list price or the standard price will be returned.

QUERY PARAMETERS SORT

Product searches can be sorted according to specific criteria.

Here is a list of sorting criteria and their meaning:

  • DEFAULT: descending by relevance, there is no relevance, then IRANK.
  • PRICE_ASC: ascending price
  • PRICE_DESC: descending price
  • SOURCES_COUNT: descending by number of sources
  • STICK: descending to stock
  • MANUFAKTURER_SKU: descending according to manufacturer's article number
  • NAME_ASC: ascending by product name
  • NAME_DESC: descending by product name
  • QUAL: descending after qualification of the product
  • TOPSELLER: descending to top product rank (clicks last 4 weeks)
  • EXACT: descending to exact productId hits
  • IRANK: descending by popularity ranking, see field rank in format descriptions for products

QUERY PARAMETER FOR PRODUCT RESTRICTION ENTRY DATE PERIOD

The corresponding request parameters are only available as of API 2.1 . The parameters filter on the entryDate export field for the product, see Format Descriptions for Products . The entry date indicates when the product was included in the ITscope catalog and not when it was last modified. So it is not possible to search these parameters for changed products.

  • productEntryFrom : The starting time for the restriction of the product entry date period in the format   yyyy-MM-dd . Only if this parameter is set will the products be filtered by the entry date period. Time is always 00:00:00.
  • productEntryTo : The end time for the restriction of the product entry date period in the format   yyyy-MM-dd . If no value is transmitted, the default value is the current date. Time is always 00:00:00. The value can not be less than productEntryFrom .

QUERY PARAMETERS FOR HISTORICAL DATA

Historical data and the corresponding request parameters are only available as of API 2.1 .

 

MASS QUERIES UP TO 50 PIECES

Looking for a range of ITscope product IDs :

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

In this example, the following ITscope product IDs are searched: 3534638001, 2069677000, 2650828000, 4201083000. Up to 50 ITscope product IDs can be specified in a request.

Search for a series of EANs :

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

This example looks for the following Eans: 5032037044288, 7636490025914, 8806086522977. Up to 50 Eans can be specified in a Request.

Looking for a number of manufacturers

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

In this example we are looking for the following manufacturer part numbers: 0553C001AA, N9J71AE # 301, CLT-P406B / ELS. Up to 50 manufacturer article numbers can be specified in one request.

Note: 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),

eg the character # as% 23 ->% 2523, or the character / as% 2F ->% 252F

 

EXAMPLES - FILTER COMBINATIONS

Search for all products that match a manufacturer and its manufacturer's article number:

eg: Manufacturer Samsung (Id: 1015 ascertainable via manufacturer API call ) and manufacturer's article number MZ-75E250B / EU

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

In addition, in this example with manufacturer part number "MZ-75E250B / EU", the / sign was masked by '% 2F' because the / sign in the URL has a special meaning and can not be unmasked.

Note: 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), eg% 2F as% 252F .

 

Search for all products that match a manufacturer's article number :
https://api.itscope.com/2.0/products/search/hstpid=A7E34AA%2523ABB/standard.xml

In addition, in this example with the manufacturer's article number A7E34AA # ABB, the # character was masked by '% 23' because the # character in the URL has a special meaning and can not be unmasked.

Note: 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), eg% 23 as% 2523.

 

Search for all products that fit a category, a manufacturer, and specific property clusters :
https://api.itscope.com/2.0/products/search/producttype=114;manufacturer=1032;cluster=2404144;cluster=1061/standard.xml

This example looks for products in the Disk category (producttype = 114), Seagate (manufacturer = 1032), and the property clusters size 2.5 "(cluster = 1061) and 4TB storage capacity (cluster = 2404144).

The manufacturer's ITscope Ids can be loaded via the manufacturer metadata API .

The ITscope Ids of the category can be loaded via the categories Metadata API .

The ITscope Ids of the property clusters can, with the appropriate authorization , be loaded via an expot or product request . However, only the property clusters are output which correspond to the products in the request result . There is currently no API way to get a complete list of property clusters.

 

Search for all products that match a category, manufacturer, and specific entry date period :

https://api.itscope.com/2.0/products/search/producttype=114;manufacturer=1032/standard.xml?productEntryFrom=2019-11-01

This example searches for products in the Disk category (producttype = 114), by the manufacturer Seagate (manufacturer = 1032) and the entry date between 01.11.2019 and the current time of the request.

https://api.itscope.com/2.0/products/search/producttype=114;manufacturer=1032/standard.xml?productEntryFrom=2019-11-01&productEntryTo=2019-12-01

This example searches for products in the Disk category (producttype = 114), Seagate (manufacturer = 1032), and the entry date between 01.11.2019T00: 00: 00 and 01.12.2019T00: 00: 00.

The manufacturer's ITscope Ids can be loaded via the manufacturer metadata API .

The ITscope Ids of the category can be loaded via the categories Metadata API .

 

EXAMPLES - FREE TEXT SEARCH

Calling a free text search
https://api.itscope.com/2.0/products/search/keywords=lenovo%20thinkpad%20i5/standard.xml
The example above looks for Lenovo Thinkpad I5.

Combine a category search with a free text search
https://api.itscope.com/2.0/products/search/producttype=114;keywords=SATA-600/standard.xml
Combining filters provides the intersection of the individual filters. In the above example, only drives with SATA-600 interface are searched

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

Have more questions? Submit a request