IWS/API IWS2/productSearch SOAP
Aus ITscope GmbH - Wissensbasis
aktuelle Version
- Service: SOAP
- Version: 2
- Empfohlen: aktueller Service
- Alternative: productLookup REST Version 3
- Beispiele: Demoprojekt für SOAPUI
Inhaltsverzeichnis |
1 Beschreibung
ProductSearch liefert Produkte aus der ITscope-Datenbank mittels Keywords oder mit in der ITscope-Suchsyntax für Schlagwortsuche formulierten Suchanfragen.
Siehe CommerceDB Referenz für den Umfang der abfragbaren Daten.
2 Ähnliche Methoden
3 Parameter
3.1 Allgemeine Parameter
Die folgenden Parameter können für jede Methode verwendet werden.
| Name des Parameters | Beschreibung | Benötigt | Zulässige Werte |
|---|---|---|---|
| method | Name der IWS-Methode, bestimmt die Funktionalität der Anfrage | Nein | |
| validate | Ist validate = true, wird die Anfrage nicht ausgeführt, sondern nur auf syntaktische und inhaltliche Korrektheit überprüft (z.B. ob Parameterwerte stimmen oder plausibel sind) | Optional |
|
| iwsKey | Der Webservice-Nutzungskey für ITscope-Kunden. Nur mit diesem Key können Web Service Requests ausgeführt werden. | Ja | Ihr IWS-Key, zum Beispiel: qnAGOar2dsAIo1EnThWsKA. Sie erhalten den Key bei der Registrierung als Enterprise-User bei ITscope. |
3.2 Allgemeine Parameter für Produktsuchen
Bei productSearch gelten die gleichen Allgemeine Parameter für Produktabfragen wie bei der productLookup Methode.
3.3 Filter Parameter
Bei productSearch werden für das Filtern nach Produkten die gleichen Filter Parameter wie bei der productLookup Methode verwendet.
3.4 Ergebnismenge Parameter
Bei productSearch gelten die gleichen Ergebnismenge Parameter wie bei der productLookup Methode.
3.5 Spezielle Such-Parameter
| Name des Parameters | Beschreibung | Benötigt | Zulässige Werte |
|---|---|---|---|
| command | Setzt den Befehl, der von der Produktsuche ausgeführt werden soll. Sinnvoll in Kombination mit einer Such-ID (stop, delete, get, save) oder einer neuen Suche (execute) oder ohne Parameter (deleteall) | Ja |
|
| keywords | Suchbegriffe, Schlüsselwörtern, siehe auch ITscope-Suchsyntax für Schlagwortsuche | Nein | Text |
| searchMode | Der Suchmodus gibt an, in welchem Index der unter keywords angegebene Suchausdruck gesucht werden soll. | Nein |
|
| searchNodeId | Suchknoten, schränkt den Zielbereich der Suche ein | Nein | ein beliebiger BrowseNode,
default ist CTL1 (Gesamtkatalog ITK) |
| scope | Qualifizierungseinschränkung des Ergebnisses | Nein |
|
| searchId | Seriennummer einer bereits existierenden Suche (ersetzt alle Parameter zuvor außer command) | Nein | Such-ID, z.B.
45c50020-b4f4-11db-bef0-cf785ec7b2f1 |
3.5.1 keywords
Der Parameter keywords bietet folgende Suchmöglichkeiten:
- Volltextsuche nach beliebigen Schlüsselwörtern
- Suchsyntax, mit der die meisten anderen Filterparameter ersetzt werden können. Siehe ITscope-Suchsyntax für Schlagwortsuche.
- Optimierte Suche nach Teilen von Artikelnummern (um auch bei nicht vollständiger Eingabe der Artikelnummer ein Ergebnis zu erzielen)
3.5.2 searchMode
Der Suchmodus gibt an, in welchem Index der unter keywords angegebene Suchausdruck gesucht werden soll. Standardwert ist 1 = automatisch. Folgende Werte sind möglich:
- 1: automatische Auswahl des Index (geeignet in den meisten Fällen)
- 2: Volltext: sucht explizit im Volltext ohne die speziellen Artikelnummer-Indizes zu berücksichtigen
- 3: Hersteller-Artikelnummern-Index: sucht explizit nach Hersteller-Artikelnummern
- 4: Lieferanten-Artikelnummern-Index: sucht explizit nach Lieferanten-Artikelnummern
- 5: EAN-index: Sucht explizit nach EANs oder Teilen von EANs (z.B. Angabe mit *)
4 Beispielaufrufe
- Beispiele für REST productSearch REST
- Beispiele für SOAP productSearch SOAP
4.1 SOAP
4.1.1 Requests
Suche alle Produkte des Hersteller Sanyo (1018) anhand der IWS Suchsysntax
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.itscope.de/IWS/2006-04-20"> <soapenv:Header/> <soapenv:Body> <ns:catalogueRequest resultsPerPage="700" maxResults="1000" page="1"> <ns:requestHeader> <ns:customerAuthentication> <ns:iwsKey><IhrWebserviceKey></ns:iwsKey> </ns:customerAuthentication> </ns:requestHeader> <ns:extendedResult>false</ns:extendedResult> <ns:qual>0 1 2 3</ns:qual> <ns:searchRequest> <ns:search> <ns:scope>1</ns:scope> <ns:keywords>hstid:1018</ns:keywords> <ns:searchMode>1</ns:searchMode> </ns:search> <ns:command>execute</ns:command> </ns:searchRequest> <ns:profileId>XMLFIND_ONLY4DEMO</ns:profileId> <ns:sendFilterNodes>false</ns:sendFilterNodes> </ns:catalogueRequest> </soapenv:Body> </soapenv:Envelope>
Suche nach dem Produkt des Hersteller Sanyo (1018) mit Hersteller Artikelnummer PLC-XR201 anhand der IWS Suchsysntax
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.itscope.de/IWS/2006-04-20"> <soapenv:Header/> <soapenv:Body> <ns:catalogueRequest> <ns:requestHeader> <ns:customerAuthentication> <ns:iwsKey><IhrWebserviceKey></ns:iwsKey> </ns:customerAuthentication> </ns:requestHeader> <ns:extendedResult>false</ns:extendedResult> <ns:qual>0 1 2 3</ns:qual> <ns:searchRequest> <ns:search> <ns:scope>1</ns:scope> <ns:keywords>hstid:1018 hpid:PLC-XR201</ns:keywords> <ns:searchMode>1</ns:searchMode> </ns:search> <ns:command>execute</ns:command> </ns:searchRequest> <ns:profileId>XMLFIND_ONLY4DEMO</ns:profileId> <ns:sendFilterNodes>false</ns:sendFilterNodes> </ns:catalogueRequest> </soapenv:Body> </soapenv:Envelope>
Suche nach dem Produkten mit Suchfilter mx320 anhand der IWS Suchsysntax
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.itscope.de/IWS/2006-04-20"> <soapenv:Header/> <soapenv:Body> <ns:catalogueRequest resultsPerPage="100" maxResults="500" page="1"> <ns:requestHeader> <ns:customerAuthentication> <ns:iwsKey><IhrWebserviceKey></ns:iwsKey> </ns:customerAuthentication> </ns:requestHeader> <ns:extendedResult>false</ns:extendedResult> <ns:qual>1 2 3</ns:qual> <ns:searchRequest> <ns:search> <ns:scope>1</ns:scope> <ns:keywords>mx320</ns:keywords> <ns:searchMode>1</ns:searchMode> </ns:search> <ns:command>execute</ns:command> </ns:searchRequest> <ns:productFlags>0</ns:productFlags> <ns:sendFilterNodes>false</ns:sendFilterNodes> <ns:profileId>XMLFIND_ONLY4DEMO</ns:profileId> </ns:catalogueRequest> </soapenv:Body> </soapenv:Envelope>
4.1.2 Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns3:catalogueResponse xmlns:ns2="http://www.itscope.de/IWS3/2008-05-01" xmlns:ns3="http://www.itscope.de/IWS/2006-04-20"> <ns3:responseHeader> <ns3:requestId>1773967394</ns3:requestId> <ns3:customerId><IhreITscopeKundennummer></ns3:customerId> <ns3:processingTime>305</ns3:processingTime> <ns3:serverMasterdataTimestamp>0</ns3:serverMasterdataTimestamp> <ns3:messageDate>2010-06-01T10:14:16.955+02:00</ns3:messageDate> </ns3:responseHeader> <ns3:searchResponse>true</ns3:searchResponse> <ns3:productResponse> <ns3:productResults>5</ns3:productResults> <ns3:sourcesResults>0</ns3:sourcesResults> <ns3:numPages>1</ns3:numPages> <ns3:currentPage>1</ns3:currentPage> <ns3:premiumContent>true</ns3:premiumContent> <ns3:product entryDate="2006-09-01T16:58:06+02:00"> <ns3:uid>PRO117313000</ns3:uid> <ns3:manufacturer> <ns3:uid>MAN686</ns3:uid> <ns3:shortName>Logitech</ns3:shortName> </ns3:manufacturer> <ns3:productType> <ns3:uid>SET109</ns3:uid> <ns3:name>Eingabegeräte</ns3:name> </ns3:productType> <ns3:ean>5099206991330</ns3:ean> <ns3:manufacturerId>967688-0102</ns3:manufacturerId> <ns3:shortInfo>RF, Maus, kabelloser Empfänger (USB), Schwarz, Deutsch</ns3:shortInfo> <ns3:productName>Cordless Desktop MX 3200 Laser - Tastatur - drahtlos</ns3:productName> <ns3:recRetailPrice>130.88</ns3:recRetailPrice> <ns3:sortOrder>-0.862</ns3:sortOrder> <ns3:shipping/> <ns3:qualification>3</ns3:qualification> <ns3:weight>1.65</ns3:weight> <ns3:endOfLife>false</ns3:endOfLife> <ns3:productDatasheet>true</ns3:productDatasheet> <ns3:productImage>true</ns3:productImage> <ns3:priceMin>43.55</ns3:priceMin> <ns3:sourcesNumber>25</ns3:sourcesNumber> <ns3:priceMax>75.3</ns3:priceMax> <ns3:priceAvg>61.28000000000002</ns3:priceAvg> <ns3:priceMinSupplier>BWZ Elektronik</ns3:priceMinSupplier> <ns3:status>1</ns3:status> <ns3:stock>156</ns3:stock> <ns3:dciImageLink>http://www.webdatenblatt.de/cds/de/?pid=<IhrDCIKey>D_I470995</ns3:dciImageLink> <ns3:bestImageLink>http://www.webdatenblatt.de/cds/de/?pid=<IhrDCIKey>E_I470995</ns3:bestImageLink> <ns2:irank>1588</ns2:irank> </ns3:product> <ns3:product entryDate="2010-01-21T01:36:36+01:00"> <ns3:uid>PRO1363924000</ns3:uid> <ns3:manufacturer> <ns3:uid>MAN686</ns3:uid> <ns3:shortName>Logitech</ns3:shortName> </ns3:manufacturer> <ns3:productType> <ns3:uid>SET109</ns3:uid> <ns3:name>Eingabegeräte</ns3:name> </ns3:productType> <ns3:ean/> <ns3:manufacturerId>920-000422</ns3:manufacturerId> <ns3:shortInfo>Tastatur, Laser, Kabellos, USB 1.x</ns3:shortInfo> <ns3:productName>Logi Cordless Desktop MX 3200 Laser BLACK - Tastatur</ns3:productName> <ns3:recRetailPrice>0.0</ns3:recRetailPrice> <ns3:sortOrder>-0.676</ns3:sortOrder> <ns3:shipping/> <ns3:qualification>2</ns3:qualification> <ns3:weight>1.48</ns3:weight> <ns3:endOfLife>false</ns3:endOfLife> <ns3:productDatasheet>false</ns3:productDatasheet> <ns3:productImage>false</ns3:productImage> <ns3:priceMin>44.0</ns3:priceMin> <ns3:sourcesNumber>2</ns3:sourcesNumber> <ns3:priceMax>55.08</ns3:priceMax> <ns3:priceAvg>49.54</ns3:priceAvg> <ns3:priceMinSupplier>Wortmann</ns3:priceMinSupplier> <ns3:status>1</ns3:status> <ns3:stock>100</ns3:stock> <ns3:bestImageLink/> <ns2:irank>59178</ns2:irank> </ns3:product> <ns3:product entryDate="2008-05-31T21:33:00+02:00"> <ns3:uid>PRO867176000</ns3:uid> <ns3:manufacturer> <ns3:uid>MAN550</ns3:uid> <ns3:shortName>IBM</ns3:shortName> </ns3:manufacturer> <ns3:productType> <ns3:uid>SET153</ns3:uid> <ns3:name>Server</ns3:name> </ns3:productType> <ns3:ean>5051045036122</ns3:ean> <ns3:manufacturerId>4368K4G</ns3:manufacturerId> <ns3:shortInfo>5U, 1-Weg, 1 x Quad-Core Xeon X3320 / 2.5 GHz, RAM 1 GB, SAS, Hot-Swap 3.5", keine Festplatte, DVD-Writer, ATI ES1000, Gigabit Ethernet, Monitor : keine(r), Express Seller</ns3:shortInfo> <ns3:productName>System x3200 M2 4368 - Server - Midi-Tower</ns3:productName> <ns3:recRetailPrice>1004.36</ns3:recRetailPrice> <ns3:sortOrder>-0.349</ns3:sortOrder> <ns3:shipping/> <ns3:qualification>3</ns3:qualification> <ns3:weight>19.0</ns3:weight> <ns3:endOfLife>false</ns3:endOfLife> <ns3:productDatasheet>false</ns3:productDatasheet> <ns3:productImage>true</ns3:productImage> <ns3:priceMin>679.0</ns3:priceMin> <ns3:sourcesNumber>4</ns3:sourcesNumber> <ns3:priceMax>1025.71</ns3:priceMax> <ns3:priceAvg>849.6366666666667</ns3:priceAvg> <ns3:priceMinSupplier>Macle</ns3:priceMinSupplier> <ns3:status>1</ns3:status> <ns3:stock>1</ns3:stock> <ns3:dciImageLink>http://www.webdatenblatt.de/cds/de/?pid=<IhrDCIKey>D_I619523</ns3:dciImageLink> <ns3:bestImageLink>http://www.webdatenblatt.de/cds/de/?pid=<IhrDCIKey>E_I619523</ns3:bestImageLink> <ns2:irank>21552</ns2:irank> </ns3:product> <ns3:product entryDate="2008-07-19T00:14:46+02:00"> <ns3:uid>PRO893016000</ns3:uid> <ns3:manufacturer> <ns3:uid>MAN743</ns3:uid> <ns3:shortName>Memorysolution</ns3:shortName> </ns3:manufacturer> <ns3:productType> <ns3:uid>SET118</ns3:uid> <ns3:name>Speicherbausteine</ns3:name> </ns3:productType> <ns3:ean>4047762028558</ns3:ean> <ns3:manufacturerId>MS64CO147*</ns3:manufacturerId> <ns3:shortInfo>64 MB</ns3:shortInfo> <ns3:productName>COMPAQ DESKPRO 2000/ 4000/ 4000N/ 4000S MMX</ns3:productName> <ns3:recRetailPrice>0.0</ns3:recRetailPrice> <ns3:sortOrder>-0.317</ns3:sortOrder> <ns3:shipping/> <ns3:qualification>2</ns3:qualification> <ns3:weight>1.0</ns3:weight> <ns3:endOfLife>false</ns3:endOfLife> <ns3:productDatasheet>false</ns3:productDatasheet> <ns3:productImage>true</ns3:productImage> <ns3:priceMin>9.3</ns3:priceMin> <ns3:sourcesNumber>1</ns3:sourcesNumber> <ns3:priceMax>9.3</ns3:priceMax> <ns3:priceAvg>9.3</ns3:priceAvg> <ns3:priceMinSupplier>Memorysolution</ns3:priceMinSupplier> <ns3:status>1</ns3:status> <ns3:stock>50</ns3:stock> <ns3:bestImageLink>http://www.memorysolution.de/mso_upload/pl/special.jpg</ns3:bestImageLink> <ns2:irank>2147483647</ns2:irank> </ns3:product> <ns3:product entryDate="2008-07-19T00:09:06+02:00"> <ns3:uid>PRO890605000</ns3:uid> <ns3:manufacturer> <ns3:uid>MAN743</ns3:uid> <ns3:shortName>Memorysolution</ns3:shortName> </ns3:manufacturer> <ns3:productType> <ns3:uid>SET118</ns3:uid> <ns3:name>Speicherbausteine</ns3:name> </ns3:productType> <ns3:ean>4047762028565</ns3:ean> <ns3:manufacturerId>MS128CO147*</ns3:manufacturerId> <ns3:shortInfo>128 MB</ns3:shortInfo> <ns3:productName>COMPAQ DESKPRO 2000/ 4000/ 4000N/ 4000S MMX</ns3:productName> <ns3:recRetailPrice>0.0</ns3:recRetailPrice> <ns3:sortOrder>-0.297</ns3:sortOrder> <ns3:shipping/> <ns3:qualification>2</ns3:qualification> <ns3:weight>1.0</ns3:weight> <ns3:endOfLife>false</ns3:endOfLife> <ns3:productDatasheet>false</ns3:productDatasheet> <ns3:productImage>true</ns3:productImage> <ns3:priceMin>14.3</ns3:priceMin> <ns3:sourcesNumber>1</ns3:sourcesNumber> <ns3:priceMax>14.3</ns3:priceMax> <ns3:priceAvg>14.3</ns3:priceAvg> <ns3:priceMinSupplier>Memorysolution</ns3:priceMinSupplier> <ns3:status>1</ns3:status> <ns3:stock>50</ns3:stock> <ns3:bestImageLink>http://www.memorysolution.de/mso_upload/pl/special.jpg</ns3:bestImageLink> <ns2:irank>2147483647</ns2:irank> </ns3:product> </ns3:productResponse> <ns3:productSearchResponse> <ns3:search entryDate="2010-06-01T10:14:16.960+02:00"> <ns3:uid>QRYabfbae10-6d55-11df-9e6e-001517876d1d</ns3:uid> <ns3:serial>abfbae10-6d55-11df-9e6e-001517876d1d</ns3:serial> <ns3:searchTerm> <ns3:term>vt:(mx3200)</ns3:term> <ns3:results>6</ns3:results> <ns3:changedByEngine>false</ns3:changedByEngine> <ns3:omitted>false</ns3:omitted> <ns3:manual>true</ns3:manual> <ns3:error/> <ns3:originalTerm>mx3200</ns3:originalTerm> <ns3:display>mx3200</ns3:display> <ns3:originalTermAll/> <ns2:passThrough>false</ns2:passThrough> </ns3:searchTerm> <ns3:resultsQual>5</ns3:resultsQual> <ns3:resultsUnqual>0</ns3:resultsUnqual> <ns3:scope>1</ns3:scope> <ns3:keywords>mx3200</ns3:keywords> <ns3:stdSearchExpression/> <ns3:searchMode>1</ns3:searchMode> <ns3:userId>000</ns3:userId> <ns3:productFlags>0</ns3:productFlags> <ns3:feedback>Mehr Ergebnisse? Versuchen Sie <a href="SEARCH:mx 3200">mx 3200</a>. - Diese Suche als <a href='SEARCH:vt:(mx3200) '>Web Service</a>.</ns3:feedback> <ns3:vsettable>true</ns3:vsettable> <ns3:searchNodeId>NBN0_CTL1_CLS1</ns3:searchNodeId> </ns3:search> </ns3:productSearchResponse> </ns3:catalogueResponse> </soap:Body> </soap:Envelope>