Die plentymarkets SOAP-API wurde in Version 114 veröffentlicht

Foto Heidi Pfannes
13.05.2015 15:45
von Heidi Pfannes

Zeitgleich mit plentymarkets 6.13 haben wir die neue SOAP-API Version 114 heraus gebracht. Auch diesmal sind neben vielen Änderungen wieder interessante und hilfreiche neue Calls dabei.

Wir empfehlen Ihnen immer die neueste SOAP-API-Version zu nutzen. Momentan sind auch noch alle anderen verfügbaren SOAP-Versionen nutzbar. Doch ab Mitte Juni 2015 werden ältere SOAP-API-Versionen bis einschließlich der Version 110 gelöscht werden. Verwenden Sie daher am Besten gleich die neu SOAP-API 114 mit all ihren Neuerungen.

Unter anderem stehen damit auch Calls zur Verfügung, die z.B. die Erstellung einer Retoure auch ohne Hauptauftrag ermöglichen oder Listen mit verschiedenen Informationen zu Newsletters oder Gutscheinen ausgeben. Alle Informationen entnehmen Sie der folgenden Liste.

Alle neuen Calls in der SOAP-Version 114

  • SetAutonomousReturn: Erstellt eine Retoure ohne einen Hauptauftrag. Der Call ist für Kassensysteme gedacht.
  • SetContentPages: Ermöglicht das Bearbeiten mehrerer Kategorieseiten. Dabei wird die Seite nur in der eingegebenen Sprache und nur für den eingegebenen Mandanten editiert.

Newsletter-Calls

  • GetEmailFolderList: Gibt eine Liste mit allen E-Mail-Verzeichnissen, NewsletterFolder, des Systems aus.
  • GetFolderEmails:Gibt Informationen über alle E-Mails, Newsletter, eines bestimmten Verzeichnisses, NewsletterFolder, aus.

Gutschein-Calls

  • ValidateCoupons: Prüft, ob ein Gutscheincode bereits eingelöst wurde. Gibt alle Infos aus, die den Gutschein mit dem eingegebenen Code betreffen.
  • GetCouponListOfCampaign: Gibt eine Liste aller Gutscheine einer "CampaignID" aus (Required Request Parameter: CampaignID).
  • GetCampaignList: Gibt eine Liste aller "Campaigns" des Systems aus.

Neben den neuen Calls gibt es auch Neuerungen an bereits bestehenden Calls. Es folgt eine Liste mit den Änderungen.

Viele Calls wurden verbessert und erweitert

    1. Die folgenden Calls wurden um den Boolean Parameter “IsGuest” erweitert:
      • GetCustomers
      • SetCustomers
    2. Bei folgenden Calls wurde der Parameter "ReferrerID" (Auftragsherkunft) von INT auf FLOAT deklariert:
      • GetDeliveryCharges
      • GetItemsDefaultShippingCost
      • GetItemsStockSearch
      • GetLinkPriceColumnToReferrer
      • GetReturns
      • GetSalesOrderReferrer
      • SearchOrders
      • SetAutonomousReturns
      • SetOrdersHead
      • AddOrders
      • GetDeliveryOrders
      • SetOrderItems
      • GetItemsBase
    3. Auch der Parameter "MarketReferrer“ wurde bei allen betroffenen Calls von INT auf FLOAT deklariert.
    4. Für den Marktplatz Zentralverkauf können Artikel mit folgenden Calls verfügbar gemacht werden:
      • SetItemsBase
      • SetItemsAvailability

Um die Verfügbarkeit wiederum abzurufen, wird der Call GetItemsBase verwendet.

  1. Die Parameter "CostDomesticShipping", "CostForeignShipping" und "CostValueInPercentage" wurden aus dem Call GetMethodOfPayments entfernt.
  2. Für die kommende neue Struktur des Lagerwesens in plentymarkets wurde dem Call SetWarehouse der neue Parameter LogisticType hinzugefügt. Der Parameter WarehouseType wurde um neue Werte erweitert.
  3. Die folgenden Calls haben “StateISOCode” als neuen Parameter erhalten:
    • GetCustomers
    • SetCustomers
    • SetCustomerDeliveryAddresses
    • GetCustomerDeliveryAdresses (hat außerdem neuen Parameter “State” für den Regionnamen erhalten)
  4. Der Call GetListing hat den neuen Parameter "ItemId" erhalten, der die ID des Artikels ausgibt, für den das Listing erstellt wurde.
  5. Der Call GetReorder hat den neuen Parameter "ReorderItemId" erhalten, der die ID der Artikelposition von der Nachbestellung ausgibt.
  6. Der Call SetReorders hat den neuen Parameter "DeliveredQuantity" erhalten, der die eingegangene Menge einer Nachbestellung ausgibt.
  7. Über den Call GetOrderDocument ist es nun möglich nicht mehr nur nach einem bestimmten Dokument zu suchen, sondern generell nach Aufträgen zu suchen, für die bereits ein Dokument erstellt wurde. Die Suche ist nach Erstellungsdatum, DocumentID und DocumentNumber möglich.

Entfernte Calls

  • Call SetContentPage wurde durch SetContentPages ersetzt.

Neues aus der SOAP-Dokumentation

Um die Dokumentation der SOAP-Calls übersichtlicher zu gestalten, haben wir die Request und die Response Objekte in Form von SV-Grafiken hinterlegt. Dabei handelt es sich um "uml class diagrams". Die Grafiken liegen jeweils einmal ohne und einmal mit Kommentar (Documented) vor und sind über die folgenden 4 neuen Buttons innerhalb der Dokumentation aufrufbar:

  1. Request SVG
  2. Documented Request SVG
  3. Respond SVG
  4. Documented Respond SVG

Die komplette Dokumentation zur SOAP-API-Version 114 finden Sie in unserem Handbuch.



Vorheriger Blog

Mehrzeilige Code-Blocks machen die CMS-Syntax noch flexibler

Zum vorherigen Blog

Nächster Blog

Retouren ganz einfach anlegen mit plentymarkets Client 217

Zum nächsten Blog

Nach oben