API - Endpunkte - ProductGroup

Owned by Former user (Deleted)
Last updated: 22 März, 2021 by Meike Blobel (Unlicensed)

Hier werden alle API-Calls rund um die Ober-, Haupt- und Warengruppen beschrieben.

Allgemeine Konfiguration

Zum Abfragen von Ober-, Haupt- und Warengruppen muss nichts separat konfiguriert sein. Es müssen nur Gruppen im System angelegt und untereinander verknüpft sein.

Die WSDL kann direkt über den TRADEMAN aufgerufen werden: https://<trademanURL>/api/soap/productgroup/wsdl

Inhaltsverzeichnis

getProductGroup

Abfragen von Warengruppen mit möglichen Filtern

  • mainProductGroupId: ID (integer) der übergeordneten Hauptwarengruppe
  • withItems: Bool-Flag zum Abfragen von Artikel innerhalb der Warengruppe

Aufruf:

Hier ein Beispiel für eine SOAP-Anfrage mit möglichen Filtern

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prod="http://productgroup.soap.poe.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <prod:GetProductGroup>
         <!--Optional:-->
         <prod:mainProductGroupId>12</prod:mainProductGroupId>
         <!--Optional:-->
         <prod:withItems>false</prod:withItems>
      </prod:GetProductGroup>
   </soapenv:Body>
</soapenv:Envelope>

Antwort:

Bei einer erfolgreichen Anfrage könnte dieses Ergebnis wieder gegeben werden

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://productgroup.soap.poe.de/">
   <SOAP-ENV:Body>
      <ns1:GetProductGroupResult>
         <ProductGroup>
            <name>Küchengeräte</name>
            <shortname>Kü</shortname>
            <productgroup>14</productgroup>
            <mainproduct>13</mainproduct>
         </ProductGroup>
         <ProductGroup>
            <name>Keller/Werkraum</name>
            <shortname>KW</shortname>
            <productgroup>16</productgroup>
            <mainproduct>13</mainproduct>
         </ProductGroup>
         <ProductGroup>
            <name>Fürs ganze Haus</name>
            <shortname>gH</shortname>
            <productgroup>15</productgroup>
            <mainproduct>13</mainproduct>
         </ProductGroup>
      </ns1:GetProductGroupResult>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Wenn z.B. die Hauptwaregruppen-ID nicht zugeordnet werden kann, kommt dieser Fehler:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
         <faultcode>HAUPTWARENGRUPPE_NICHT_GEFUNDEN</faultcode>
         <faultstring>Die angegebene Hauptwarengruppe konnte nicht gefunden werden</faultstring>
      </SOAP-ENV:Fault>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getMainProductGroup

Abfragen von Hauptwarengruppen

Aufruf:

Hier ein Beispiel für eine SOAP-Anfrage mit möglichen Filtern

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prod="http://productgroup.soap.poe.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <prod:GetMainProductGroup>
         <!--Optional:-->
         <prod:productGroupId>?</prod:productGroupId>
      </prod:GetMainProductGroup>
   </soapenv:Body>
</soapenv:Envelope>

Antwort:

Bei einer erfolgreichen Anfrage könnte dieses Ergebnis wieder gegeben werden

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://productgroup.soap.poe.de/">
   <SOAP-ENV:Body>
      <ns1:GetMainProductGroupResult>
         <MainProductGroup>
            <name>Hauptwarengruppe</name>
            <shortname>THWGRP</shortname>
            <mainproductgroup>1</mainproductgroup>
            <productcategory>0</productcategory>
         </MainProductGroup>
      </ns1:GetMainProductGroupResult>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Wenn z.B. die Hauptwarengruppen-ID nicht zugeordnet werden kann, kommt dieser Fehler:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
         <faultcode>OBERWARENGRUPPE_NICHT_GEFUNDEN</faultcode>
         <faultstring>Die angegebene Oberwarengruppe konnte nicht gefunden werden</faultstring>
      </SOAP-ENV:Fault>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getProductCategory

Abfragen von Oberwarengruppen

Aufruf:

Hier ein Beispiel für eine SOAP-Anfrage mit möglichen Filtern

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prod="http://productgroup.soap.poe.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <prod:GetProductCategory>
         <!--Optional:-->
         <prod:productCategoryId>?</prod:productCategoryId>
      </prod:GetMainProductGroup>
   </soapenv:Body>
</soapenv:Envelope>

Antwort:

Bei einer erfolgreichen Anfrage könnte dieses Ergebnis wieder gegeben werden

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://productgroup.soap.poe.de/">
   <SOAP-ENV:Body>
      <ns1:GetProductCategoryResult>
         <ProductCategory>
            <name>Oberwarengruppe</name>
            <shortname>OT</shortname>
            <productcategory>225</productcategory>
         </ProductCategory>
      </ns1:GetProductCategoryResult>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Wenn z.B. die Oberwarengruppen-ID nicht zugeordnet werden kann, kommt dieser Fehler:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
         <faultcode>OBERWARENGRUPPE_NICHT_GEFUNDEN</faultcode>
         <faultstring>Die Oberwarengruppe konnte nicht gefunden werden</faultstring>
      </SOAP-ENV:Fault>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>