Page tree
Skip to end of metadata
Go to start of metadata
 

Bitte beachten Sie, dass seit TecArt Version 4.10 und aufwärts der SOAP Webservice nicht mehr weiterentwickelt wird. Ab der TecArt Version 5.1 ist der SOAP Webservice nicht mehr unterstützt.

Please note: with the release of TecArt version 4.10 onwards SOAP Webservice will no longer be updated or expanded. With the release of TecArt version 5.1, the soap webservice will be deprecated.

1. WSDL-URI

http://hostname/dirname/soap/index.php?op=articles&wsdl

z.B. https://test.tecart-system.de/soap/index.php?op=articles&wsdl

2. Methods

2.1. crmAddArticle

(Version >= 4.1)

Syntax:

int crmAddArticle( string $session_id, array $article_data )

Eigenschaften von$article_data:

Typ(Länge)              Eigenschaft                          Beschreibung
---------------------------------------------------------------------------------------------
string                  name                                 Bezeichnung des Artikels
int                     realnumber                           Artikelnummer (optional)
double                  price_purchase                       Einkaufspreis
double                  price_netto                          Netto-Preis
int                     tax_rate                             Steuersatz-Index
int                     articlegroup                         Warengruppe-ID
int                     vendor                               Kontakt-ID des Lieferanten
bool                    partslist                            Ist ein Stücklistenartikel?
bool                    autoprice                            Wenn Stücklistenartikel, dann automatische Preisberechnung
int                     billing_interval                     Abrechnungszeitraum-Index
int                     posting_account_source               Quelle zur Ermittlung der Buchungskonten (0=Steuersatz, 1=Warengruppe, 2=Artikel)
string                  posting_account_revenue              Wenn posting_account_source=2: Buchungskonto für Umsatz
string                  posting_account_shipment_eg          Wenn posting_account_source=2: Buchungskonto für Lieferung in die EG ohne UstID
string                  posting_account_shipment_eg_ustid    Wenn posting_account_source=2: Buchungskonto für Lieferung in die EG mit UstID
string                  posting_account_shipment_foreign     Wenn posting_account_source=2: Buchungskonto für Lieferung in die Nicht-EG
string                  posting_account_purchase             Wenn posting_account_source=2: Buchungskonto für Einkauf Inland
string                  posting_account_purchase_eg          Wenn posting_account_source=2: Buchungskonto für Einkauf EG ohne UstID
string                  posting_account_purchase_eg_ustid    Wenn posting_account_source=2: Buchungskonto für Einkauf EG mit UstID
string                  posting_account_purchase_foreign     Wenn posting_account_source=2: Buchungskonto für Einkauf aus Nicht-EG
bool                    deactivated                          Artikel deaktiviert
string                  notes                                Notizen
int                     ext_id                               Externe ID ( ab Version 4.2 )

Beschreibung: Der Rückgabewert ist die ID des angelegten Artikel. Im Fehlerfall wird eine CRMException geworfen.

Beispiel:

<?php
 
ini_set("soap.wsdl_cache_enabled", "0");
 
try {
  $client_logon = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=logon&wsdl");
     $session_id = $client_logon->crmLogin('test', 'test');
     if (!$session_id) die("invalid login");
   
     $client_articles = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=articles&wsdl");
 
   $article_data = array(
     'name'   => 'Testarticle',
     'realnumber' => 'A12345',
     'price_netto'  => 10.00,
     'price_purchase' => 5.00,
     'tax_rate' => 1
   );
 
   $article_id = $client_articles->crmAddArticle(string $session_id, $article_data);
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.2. crmAddArticleToList

(Version >= 4.1)

Syntax:

array crmAddArticleToList(string $session_id, int $object_id, int $article_id)

Beschreibung:

Fügt den Artikel mit der übergebenen ID zu einer des Artikels hinzu. Im Erfolgsfall wird 1 zurückgegeben.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Beispiel:

<?php
 
try {
  $success = $client_articles->crmAddArticleToList($session_id, $object_id, 10);    
     echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.3. crmAddGrouplineToList

(Version >= 4.1)

Syntax:

array crmAddGrouplineToList(string $session_id, int $object_id, array $crmBillingItem)

Beschreibung:

Fügt eine Gruppenzeile zu einer des Artikels hinzu. Im Erfolgsfall wird 1 zurückgegeben.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

crmBillingItem kann ein assoziatives Array oder ein Objekt sein.

Eigenschaften:

Typ             Eigenschaft                          Beschreibung
---------------------------------------------------------------------------------------------
int             $quantity                             Menge
string          $name                                 Bezeichnung
int             $taxrate                              Steuersatz-Index
double          $discount                             Rabatt
int             $interval                             Abrechnungszeitraum-Index
string          $description                          Beschreibung
int             $ext_id                               Externe ID ( ab Version 4.2 )

Beispiel:

<?php
 
try {
  $data = array(
       'quantity' => 3,
       'name'   => 'API Groupline',
       'description'  => 'API Groupline',
       'taxrate'    => 19,
       'discount' => 100,
       'interval' => 1
     );
 
   $success = $client_articles->crmAddGrouplineToList($session_id, $object_id, $data);
   echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.4. crmAddMultipleToList

(Version >= 4.1)

Syntax:

array crmAddMultipleToList(string $session_id, int $object_id, array $crmMultipleListItems)

Beschreibung:

Fügt der Artikelliste mehrere Artikel und Texte und Gruppenzeilen zu einer des Artikels hinzu. Im Erfolgsfall wird 1 zurückgegeben.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

crmMultipleListItems ist ein Array von Artikeln, die Eigenschaften sind die selben wie crmAddArticleToList, crmAddTextToList, crmAddSpecialToList und crmAddGrouplineToList. Die Unterscheidung erfolgt über das Feld "type".

Eigenschaften:

Typ             Eigenschaft                          Beschreibung
---------------------------------------------------------------------------------------------
array           $crmMultipleListItems                Artikelliste

Beispiel:

<?php
 
try {
 
   $items = array();
 
   $items['crmMultipleListItems'][] = array('type' => 'article', 'id' => 10);
   $items['crmMultipleListItems'][] = array('type' => 'text','text' => 'API-AddMultiple Text');
 
   $specialItem = array(
  'quantity'  => 10,
  'realnumber'  => '100001',
  'name'    => 'API Special Article',
  'description' => 'API Special Article',
  'taxrate' => 19,
  'discount'  => 100,
  'interval'  => 1,
  'type'    => 'special'
  );    
     $items['crmMultipleListItems'][] = $specialItem;
 
   $data = array(
     'quantity' => 3,
     'name'   => 'API Groupline',
     'description'  => 'API Groupline',
     'taxrate'    => 19,
     'discount' => 100,
     'interval' => 1,
     'type'   => 'groupline'
   );
   $items['crmMultipleListItems'][] = $specialItem;
   
 
   $success = $client_articles->crmAddMultipleToList($session_id, $object_id, $items);
 
   echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.5. crmAddSpecialToList

(Version >= 4.1)

Syntax:

array crmAddSpecialToList($session_id, $object_id, $crmBillingItem)

Beschreibung:

Fügt einen Sonderartikel zu einer des Artikels hinzu. Im Erfolgsfall wird 1 zurückgegeben.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

crmBillingItem kann ein assoziatives Array oder ein Objekt sein.

Eigenschaften:

Typ             Eigenschaft                          Beschreibung
---------------------------------------------------------------------------------------------
int             $quantity                            Menge
string          $realnumber                          Artikelnummer
string          $name                                Bezeichnung
int             $taxrate                             Steuersatz-Index
double          $discount                            Rabatt
int             $interval                            Abrechnungszeitraum-Index
string          $description                         Beschreibung
int             $ext_id                              Externe ID ( ab Version 4.2 )

Beispiel:

<?php
 
try {
  $data = array(
       'quantity' => 10,
       'realnumber' => '100001',
       'name'   => 'API Special Article',
       'description'  => 'API Special Article',
       'taxrate'    => 19,
       'discount' => 100,
       'interval' => 1
     );
 
   $success = $client_articles->crmAddSpecialToList($session_id, $object_id, $data);
   echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.6. crmAddTextToList

(Version >= 4.1)

Syntax:

array crmAddTextToList($session_id, $object_id, $text)

Beschreibung:

Fügt einen Artikel-Text zu einer des Artikels hinzu. Im Erfolgsfall wird 1 zurückgegeben.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Beispiel:

<?php
 
try {
  $success = $client_articles->crmAddTextToList($session_id, $object_id, 'Das ist ein Text');
     echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.7. crmChangeArticle

(Version >= 4.1)

Syntax:

int crmChangeArticle( string $session_id, int $object_id, array $object_data )

$object_data siehe add()

Beschreibung: Überschreibt den Artikel mit ID $object_id mit den Daten aus $object_data. Gibt die Artikel-ID zurück bei Erfolg. Im Fehlerfall wird eine CRMException geworfen.

Beispiel:

<?php
 
try {
  $article_data = array(
       'price_netto'  => 15.00,
       'price_purchase' => 7.50,
     );
 
   $article_id = $client_articles->crmAddArticle(string $session_id, $article_id, $article_data);
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.8. crmChangeArticleInList

(Version >= 4.1)

Syntax:

int crmChangeArticleInList( string $session_id, int $object_id, $position, $object_data )

Beschreibung: Überschreibt den Artikel an Position $position in der Artikelliste vom Artikel $object_id mit den Daten aus $object_data. Gibt true zurück bei Erfolg. Im Fehlerfall wird eine CRMException geworfen.

Beispiel:

<?php
 
try {
  $article_data = array(
       'price_purchase' => 8.00,
     );
 
   $article_id = $client_articles->crmAddArticle(string $session_id, $article_id, 1, $article_data);
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.9. crmDeleteArticle

(Version >= 4.1)

Syntax:

int crmDeleteArticle( string $session_id, int $object_id )

Beschreibung: Löscht einen Artikel.

Beispiel:

<?php
 
try {
  $success = $client_articles->crmDeleteArticle($session_id, $article_id);    
     echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.10. crmGetArticle

(Version >= 4.1)

Syntax:

int crmGetArticle( string $session_id, int $object_id, boolean $format )

Beschreibung: Liefert die Daten zu einem Artikel. Ist $format true, werden die Daten entsprechend den Feldeinstellungen formatiert.

Beispiel:

<?php
 
try {
  $success = $client_articles->crmGetArticle($session_id, $article_id);    
     echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.11. crmGetArticles

(Version >= 4.1)

Syntax:

array crmGetArticles(string $session_id, int $object_id)

Beschreibung:

Gibt Artikel aus Artikelliste zurück.

Beispiel:

<?php
 
try {
  $articles = $client_articles->crmGetArticles($session_id, $article_id);
   
     foreach($articles as $article) {
       foreach($article as $key => $val) {
  echo "$key => $val<br>\n";
  }
     }
     echo "<hr/>";
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}



2.12. crmAddDescription

(Version >= 4.1)

Syntax:

int crmAddDescription( string $session_id, int $object_id, string $lang_code, string $short, string $long )

Beschreibung: Fügt einen Beschreibungstext zu dem Artikel hinzu.

Beispiel:

<?php
 
try {
  $success = $client_articles->crmAddDescription($session_id, $article_id, 'de', 'Kurzbeschreibung', 'Ausführliche Beschreibung');    
     echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.13. crmGetDescription

(Version >= 4.1)

Syntax:

int crmGetDescription( string $session_id, int $object_id, string $lang_code )

Beschreibung: Gibt den Beschreibungstext mit dem übergebenen $lang_code des Artikels zurück.

Beispiel:

<?php
 
try {
  $success = $client_articles->crmGetDescription($session_id, $article_id, 'de');    
     echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.14. crmChangeDescription

(Version >= 4.1)

Syntax:

int crmChangeDescription( string $session_id, int $object_id, string $lang_code, string $short, string $long )

Beschreibung: Ändert einen Beschreibungstext zu einem Artikel

Beispiel:

<?php
 
try {
  $success = $client_articles->crmChangeDescription($session_id, $article_id, 'de', 'Kurzbeschreibung 2', 'Ausführliche Beschreibung 2');
     echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.15. crmDeleteDescription

(Version >= 4.1)

Syntax:

int crmDeleteDescription( string $session_id, int $object_id, string $lang_code )

Beschreibung: Löscht einen Beschreibungstext.

Beispiel:

<?php
 
try {
  $success = $client_articles->crmChangeDescription($session_id, $article_id, 'de');    
     echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.16. crmAddVariant

(Version >= 4.1)

Syntax:

int crmAddVariant( string $session_id, int $object_id, array $article_data )

Beschreibung: Erstellt zu einem Artikel eine Artikelvariante.

Beispiel:

<?php
 
try {
  $article_data = array(
       'name' => 'Test-Variante'
     );
 
   $variant_id = $client_articles->crmAddVariant($session_id, $article_id, $article_data);
   echo $variant_id;
 
}
catch (Exception $e) {
  echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}

2.17. crmChangeVariant

(Version >= 4.1)

Syntax:

int crmChangeVariant( string $session_id, int $variant_id, array $crmVariantItem )

Beschreibung: Ändert Daten einer Artikelvariante.

Beispiel:

<?php
 
try {
  $article_data = array(
       'name' => 'Test-Variante 2'
     );
 
   $success = $client_articles->crmChangeVariant($session_id, $variant_id, $article_data);
   echo $success;
 
}
catch (Exception $e) {
  echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}

2.18. crmDeleteVariant

(Version >= 4.1)

Syntax:

int crmDeleteVariant( string $session_id, int $variant_id )

Beschreibung: Löschen Artikelvariante.

Beispiel:

<?php
 
try {
  $article_data = array(
       'name' => 'Test-Variante 2'
     );
 
   $success = $client_articles->crmDeleteVariant($session_id, $variant_id);
   echo $success;
 
}
catch (Exception $e) {
  echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}

2.19. crmGetVariants

(Version >= 4.1)

Syntax:

array crmGetVariants( string $session_id, int $object_id )

Beschreibung: Gibt eine Liste mit den Varianten-Artikeln des Original-Artikels zurück.

Beispiel:

<?php
 
try {
  $variants = $client_articles->crmGetVariants($session_id, $article_id);    
 
   foreach($variants as $variant) {
     foreach($variant as $key => $val) {
  echo "$key => $val<br>\n";
  }
     }
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.20. crmGetVariant

Syntax:

array crmGetVariant( string $session_id, int $variant_id )

Beschreibung: Gibt einen Varianten-Artikeln des Original-Artikels zurück.

Beispiel:

<?php
 
try {
  $variant = $client_articles->crmGetVariant($session_id, $variant_id);    
 
   foreach($variant as $key => $val) {
     echo "$key => $val<br>\n";
   }
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.21. crmRemoveArticleFromList

(Version >= 4.1)

Syntax:

array crmRemoveArticleFromList(string $session_id, int $object_id, int $article_id)

Beschreibung:

Löscht den Artikel mit der angegeben ID aus der Artikelliste der des Artikels. Im Erfolgsfall wird 1 zurückgegeben.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Beispiel:

<?php
 
try {
  $success = $client_articles->crmRemoveArticleFromList($session_id, $object_id, 11);
   
     echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.22. crmSearchArticles

(Version >= 4.1)

Syntax:

array crmSearchArticles(string $session_id, array $crmSearchArticlesParams)

Beschreibung:

Sucht nach Artikeln anhand gegebener Parameter und gibt diese als Array zurück.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Eigenschaften von $crmSearchArticlesParams:

Typ(Länge)              Eigenschaft		Beschreibung
---------------------------------------------------------------------------------------------
string			        $search			Suchtext
string			        $tax_rate		Steuersatz
int			            $count			maximale Anzahl zu suchender Elemente
int			            $offset			Suche ab Position $offset beginnen
bool			        $sorting		Rückgabe sortieren

Eigenschaften des zurückgegeben arrays:

Typ(Länge)              Eigenschaft		Beschreibung
---------------------------------------------------------------------------------------------
int                     id                                   (ab v4.6.19798) interne ID des Artikels 
string                  name                                 Bezeichnung des Artikels
int                     parent_id                            Eltern-Artikel-ID
int                     articlegroup                         Warengruppe-ID
int                     realnumber                           Artikelnummer (optional)
int                     vendor                               Kontakt-ID des Lieferanten
int                     tax_rate                             Steuersatz-Index
double                  price_purchase                       Einkaufspreis
double                  price_netto                          Netto-Preis
double                  price_brutto                         Brutto-Preis

Beispiel:

<?php
 
try {
  $crmSearchArticlesParams = array(
       'search' => 'Testarticle',
       'count'  => 100
 
   );
 
   $articles = $client_articles->crmSearchArticles($session_id, $crmSearchArticlesParams);
 
   foreach($articles AS $article_id => $article) {
     foreach($article AS $key => $key) {
  echo $key . ': ' . $key . '
';
  }      
     }
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.23. crmgetIdByExtId

(Version >= 4.2)

Syntax:

array crmgetIdByExtId( string $session_id, string $ext_id )

Beschreibung

Liefert interne ID(s) von Artikeln mit der übergebenen externen ID zurück.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Eigenschaften des zurückgegebenen article ids array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			            $id			                 Article-Id 

Beispiel:

<?php
 
try {
  $result = $client_articles->getIdByExtId(string $session_id, 12345);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}
 
foreach($result as $row) {
   
     echo $row->id."<br>  ";
}

2.24. crmgetAllExtIds

(Version >= 4.2)

Syntax:

array crmgetAllExtIds( string $session_id )

Beschreibung

Liefert eine Liste aller externen IDs in Artikeln zurück.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Eigenschaften des zurückgegebenen article ids array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			            $id			                 externe Article-Id 

Beispiel:

<?php
 
try {
  $result = $client_articles->crmgetAllExtIds($session_id);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}
 
foreach($result as $row) {
   
     echo $row->id."<br>  ";
}

2.25. crmsetDuplicateConfig

(Version >= 4.4)

Syntax:

int | string <errormessage> crmDuplicateConfig( string $session_id, crmDuplicatecheckFields $crmDuplicatecheckFields )

Beschreibung:

Ermöglicht eine temporäre Überschreibung der Dublettenprüfungsfelder für die Laufzeit der angemeldeten Session.

Eigenschaften des zu übergebenden crmDuplicatecheckFields Objektes:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
string			        $fields			     implodiertes Array ( implode(',', $myFields) ) mit gewünschten Feldern, 
						                     auf die eine Dublettenprüfung angewendet werden soll;
						                     wenn Eigenschaft auf NULL gesetzt wird, wird Override zurückgesetzt

Beispiel:

<?php
 
ini_set("soap.wsdl_cache_enabled", "0");
 
try {
  $client_logon = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=logon&wsdl");
     $session_id = $client_logon->crmLogin('test', 'test');
     if (!$session_id) die("invalid login");
 
   $client_articles = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=articles&wsdl");
 
   $fields  = array('fields' => implode(',', array('name', 'notes')) );
   $success = $client_articles->crmsetDuplicateConfig($session_id, $fields);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}
 
echo ($success == 1 ? 'override successful' : $success);

2.26. crmgetDuplicateConfig

(Version >= 4.4)

Syntax:

string crmgetDuplicateConfig( string $session_id )

Beschreibung:

Gibt implodiertes Array als Zeichenkette mit aktueller Feldkonfiguration der Dublettenprüfung zurück.

Sollte aktuell keine temporäre Überschreibung der Feldkonfiguration aktiv sein (siehe crmsetDuplicateConfig), wird die durch die Administration konfigurierte Feldliste zurückgegeben.

Beispiel:

<?php
 
ini_set("soap.wsdl_cache_enabled", "0");
 
try {
  $client_logon = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=logon&wsdl");
     $session_id = $client_logon->crmLogin('test', 'test');
     if (!$session_id) die("invalid login");
 
   $client_articles = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=articles&wsdl");
 
   $fields = $client_notes->crmgetDuplicateConfig($session_id);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}
 
$fields = explode(',', $fields);
echo '<pre>'.print_r($fields, true).'</pre>';

2.27. crmGetArticleIds

(Version >= 4.5.16732)

Syntax:

array crmGetArticleIds( string $session_id, int $timestamp )

Beschreibung

Liefert eine Liste aller IDs von Artikeln zurück, welche seit $timestamp geändert wurden. $timestamp ist ein Unit-Timestamp.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Eigenschaften des zurückgegebenen article ids array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			           $id			                 Article-Id 

Beispiel:

<?php
 
try {
  $result = $client_articles->crmGetArticleIds($session_id, 0);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}
 
foreach($result as $row) {
   
     echo $row->id."<br>  ";
}
  • No labels