Calls
Themen bzw. Einstellungen dieses Kapitels:
1) Die WSDL-Datei
Die URL zur WSDL-Datei ist in Ihrem plentyMarkets-System im Menü Einstellungen > plentyAPI Daten unter SOAP WSDL zu finden.
Bild 1: URL zur WSDL-Datei
Versionsangabe in der URL zur SOAP WSDL
In der URL erscheint am Ende die Versionsnummer, in Bild 1 z.B. version103.
Hier eine Übersicht der plentyMarkets-Versionen mit Angabe der entsprechenden SOAP API-Versionen:
| plentyMarkets-Version | SOAP API-Version |
|---|---|
| 4.400 | 105 |
| 4.306 | 103 |
| 4.305 | 100 |
WSDL für C# (ab Version 103)
C#-kompatible WSDL; die Formatierung ist im Gegensatz zu den bekannten WSDLs abgeändert.
In der Versionsangabe der URL wird ein c angehängt: .../version105c/?xml.
2) Call-Übersicht
Details zu den Calls, die in den Unterkapiteln erläutert werden mit Verlinkung zur jeweiligen Handbuchseite
| Authentifizierungs-Calls | Erläuterung | ab Version | Limitierung* |
|---|---|---|---|
| GetAuthentificationToken | Liefert Benutzer-ID und Token für den SoapHeader zurück. | 100 | 30 |
* Limitierung: Aufrufe pro Tag pro Benutzer
| Artikel-Calls | Erläuterung | ab Version | Limitierung* |
|---|---|---|---|
| GetItemBase | Liefert einen einzelnen Artikeldatensatz zurück. | 100 | |
| GetItemsBase | Liefert eine Liste von Artikeldatensätzen zurück. | 100 | |
| AddItemsBase | Fügt eine Liste von Artikeldatensätzen hinzu. | 100 | |
| SetItemsBase | Editiert eine Liste von Artikeldatensätzen. | 100 | |
| GetLinkedItems | Liefert eine Cross-Selling-Artikelliste pro übergebenem Artikel zurück. | 101 | |
| AddItemsImages | Fügt einem Artikel ein Artikelbild hinzu. | 100 | |
| GetItemsImage | Liefert die Artikelbilder für eine Gruppe von bis zu 50 Artikeln zurück. | 100 | |
| DeleteItems | Löschen einer Liste von Artikeln (unwiderruflich). | 101 | |
| DeleteItemsImage | Löscht alle Bilder eines Artikels. | 100 | |
| GetItemCategoryCatalogBase | Liefert eine Liste mit allen im System angelegten Kategorien zurück. | 100 | |
| GetItemCategoryCatalog | Liefert eine detaillierte Liste mit allen im System angelegten Kategorien zurück. | 100 | |
| GetItemCategoryTree | Liefert einen Kategoriebaum in Bezug zum jeweiligen Multishop zurück. | 104 | |
| AddItemCategory | Fügt eine Kategorie hinzu. | 100 | |
| GetProducers | Liefert eine Liste mit allen im System angelegten Herstellern zurück. | 100 | |
| SetProducers | Fügt eine Liste von Herstellern hinzu oder bearbeitet vorhandene Hersteller. | 101 | |
| GetProperties | Liefert eine Liste mit allen im System angelegten Merkmalen zurück. | 104 | |
| GetPropertyGroups | Liefert eine Liste mit allen im System angelegten Merkmalgruppen zurück. | 104 | |
| GetPropertiesList | Liefert eine Liste mit allen im System angelegten Merkmalgruppen mit den jeweils zugehörigen Merkmalen zurück. | 104 | |
| GetItemsPropertiesList | Liefert alle im System angelegten Merkmale und (Merkmal-)Gruppen zurück. | 101 | |
| AddProperty | Fügt ein Merkmal hinzu. | 105 | |
| AddPropertyToItem | Fügt eine Merkmalverknüpfung zu einem Artikel hinzu. | 105 | |
| AddPropertyGroup | Fügt eine Merkmalgruppe hinzu. | 105 | |
| RemovePropertyFromItem | Entfernt eine Merkmalverknüpfung von einem Artikel. | 105 | |
| DeleteProperty | Löscht ein Merkmal. | 105 | |
| DeletePropertyGroup | Löscht eine Merkmalgruppe. | 105 | |
| GetItemsPriceLists | Liefert zu einer Liste von Artikeln die angelegten Preislisten zurück. | 101 | |
| SetPriceSets | Setzt bei Preis-Sets die angegebenen Parameter. | 103 | |
| GetAttributeValueSets | Liefert für eine Liste von Artikelvarianten die zugehörigen Attribute und Werte zurück. | 101 | |
| GetItemsStock | Liefert die Anzahl der Artikel in einem Lager zurück. | 101 | |
| GetItemsStockSearch | Liefert die Anzahl der Artikel in einem Lager anhand der ID der Herkunft zurück. | 101 | |
| AddItemAttribute | Fügt eine Liste von Attributen zum System hinzu. | 102 | |
| AddItemAttributeValueSets | fügt einem Artikel eine Variante hinzu. | 102 | |
| GetItemAvailabilityConfig | Liefert eine Liste der im System hinterlegten Artikelverfügbarkeiten zurück. | 104 | |
| SetItemsAvailability | Setzt für eine Liste von Artikeln die übergebenen Sicht- und Verfügbarkeiten. | 103 | |
| GetCategoryMappingForMarket | Liefert für einen angegebenen Marktplatz die hinterlegte Kategorieverknüpfung zurück. | 103 | |
| GetItemBundles | Liefert entweder ein bestimmtes Artikelpaket zurück, oder alle Artikelpakete mit einem bestimmten Artikel oder Artikelpakete anhand verschiedener Suchparameter. | 104 | |
| AddItemsToBundle | Fügt Artikel zu einem Artikelpaket hinzu. | 104 | |
| RemoveItemsFromBundle | Löscht Artikel aus einem Artikelpaket. | 104 |
| Auktionen-Calls | Erläuterung | ab Version | Limitierung* |
|---|---|---|---|
| GetAuctions | Liefert (je nach Suchparameter) alle Auktionen von eBay, AuVito und ricardo zurück. | 104 | |
| AddAuction | Legt eine neue Auktion an. | 104 | |
| GetAuctionMarketsShopCategories | Liefert die Shop-Kategorien der Marktplätze eBay und AuVito zurück. | 104 | |
| GetEbayItemVariations | Liefert Artikelvarianten von eBay zurück. | 104 | |
| SetAuctionStartTimestamp | Legt den Startzeitpunkt einer Auktion fest. | 105 |
| Warenbestands-Calls | Erläuterung | ab Version | Limitierung* |
|---|---|---|---|
| GetCurrentStocks | Liefert aktuelle Warenbestände zurück. | 100 | |
| SetCurrentStocks | Ändert bei mehreren Artikeln den Warenbestand. | 100 | |
| SetIncomingStocks | Bucht Wareneingänge für mehrere Artikel. | 100 | |
| SetStocksTransfer | Warenbestände werden umgebucht. | 100 | |
| GetWarehouseList | Liefert eine Liste der verfügbaren Lager zurück. | 100 | 30 |
| GetStockMovements | Liefert eine Liste von Warenbewegungen zurück. | 104 |
| Nachbestellungs-Calls | Erläuterung | ab Version | Limitierung* |
|---|---|---|---|
| AddReorder | Legt eine Nachbestellung an oder bearbeitet eine Nachbestellung. | 104 | |
| GetReorders | Liefert eine Liste von Nachbestellungen zurück. | 104 | |
| DeleteReorder | Löscht eine Nachbestellung. | 104 |
| Kunden-Calls | Erläuterung | ab Version | Limitierung* |
|---|---|---|---|
| GetCustomer | Liefert einen einzelnen Kundendatensatz zurück. | 100 | |
| GetCustomers | Liefert eine Liste von Kundendatensätzen zurück. | 100 | |
| AddCustomers | Fügt eine Liste von Kundendatensätzen hinzu. | 100 | |
| SetCustomers | Editiert eine Liste von Kundendatensätzen. | 100 | |
| GetCustomerClasses | Liefert eine Liste aller verfügbaren Kundenklassen zurück. | 100 | |
| GetCustomerNotes | Liefert eine Liste von Notizen eines Kundendatensatzes zurück. | 100 | |
| AddCustomerNote | Fügt einem Kundendatensatz eine Notiz hinzu. | 100 | |
| GetCustomerDeliveryAddresses | Liefert eine Liste von Lieferanschriften eines Kundendatensatzes zurück. | 100 | |
| AddCustomerDeliveryAddresses | Fügt eine Lieferanschrift einem Kundendatensatz hinzu. | 100 | |
| SetCustomerDeliveryAddresses | Editiert eine Lieferanschrift eines Kundendatensatzes. | 100 | |
| GetCountriesOfDelivery | Liefert eine Liste der Lieferländer zurück. | 100 | 30 |
| SetBankCreditCardData | Fügt den Kundendaten eines Kunden jeweils die Bank- und/oder Kreditkartendaten hinzu. | 103 | |
| GetCustomerOrders | Liefert eine Liste aller Aufträge eines Kunden zurück. | 104 | |
| GetCustomerOrderOverviewLink | Liefert den Link zur Auftragsübersicht in der Kaufabwicklung. | 105 |
| Auftrags-Calls | Erläuterung | ab Version | Limitierung* |
|---|---|---|---|
| GetOrder | Liefert einen Auftrag zurück. | 100 | |
| SearchOrders | Liefert eine Liste von Aufträgen zurück. | 100 | |
| AddOrders | Fügt eine Liste von Aufträgen hinzu. | 100 | |
| AddOrderItems | Fügt einem Auftrag eine Liste von Artikeln hinzu. | 100 | |
| SetOrdersHead | Editiert eine Liste von Aufträgen ohne Artikelpositionen. | 100 | |
| SetOrderItems | Überschreibt bestehende Artikelpositionen in einem Auftrag. | 100 | |
| SetOrderItemsQuantity | Ändert die Anzahl der Artikelpositionen in einem Auftrag. | 100 | |
| SetOrderStatus | Setzt einen Auftrag in einen neuen Auftragsstatus. | 100 | |
| AddOrdersPackageNumber | Setzt bei einer Liste von Aufträgen eine Paketnummer. | 100 | |
| DeleteOrderPackageNumber | Entfernt bei einem Auftrag die Paketnummer. | 100 | |
| AddOrdersInvoice | Fügt einer Liste von Aufträgen Rechnungsdokumente hinzu. | 101 | |
| GetOrdersInvoiceDocumentURLs | Liefert zu einer Liste von Auftrags-IDs die URLs der Rechnungsdokumente zurück. | 100 | |
| GetOrdersCreditNoteDocumentURLs | Liefert zu einer Liste von Auftrags-IDs die URLs der Gutschriftendokumente zurück. | 101 | |
| GetOrdersDeliveryNoteDocumentURLs | Liefert zu einer Liste von Auftrags-IDs die URLs der Lieferscheindokumente zurück. | 101 | |
| GetOrdersDunningLetterDocumentURLs | Liefert zu einer Liste von Auftrags-IDs die URLs der Mahnungen zurück. | 101 | |
| GetOrdersOfferDocumentURLs | Liefert zu einer Liste von Auftrags-IDs die URLs der Angebotsdokumente zurück. | 101 | |
| GetOrdersOrderConfirmationDocumentURLs | Liefert zu einer Liste von Auftrags-IDs die URLs der Autragsbestätigungsdokumente zurück. | 101 | |
| SetBookOutgoingItems | Bucht den Warenausgang für die übergebenen Auftragspositionen oder den Auftrag. | 100 | |
| SetBackPostOutgoingItems | Bucht den Warenausgang wieder zurück. | 100 | |
| GetShippingProfiles | Liefert eine Liste aller Versandprofile zurück. | 100 | 30 |
| GetShippingServiceProvider | Liefert eine Liste aller eingerichteten Versanddienstleister zurück. | 100 | 30 |
| GetSalesOrderReferrer | Liefert alle eingerichteten Referrer zurück. | 100 | |
| GetOrderStatusList | Liefert eine Liste aller im System vorhandenen Auftragsstatus. | 100 | 30 |
| GetMethodOfPayments | Liefert die Zahlungsarten zurück. | 100 | 30 |
| GetIncomingPayments | Liefert eine Liste von Zahlungseingängen zurück. | 100 | |
| AddIncomingPayments | Fügt einen neuen Zahlungseingang hinzu. | 100 | |
| GetReasonsForReturn | Liefert eine Liste der Retouregründe zurück. | 100 | |
| GetItemsReturnStatus | Liefert eine Liste der Artikelstatus für eine Retoure zurück. | 100 | |
| GetReturns | Liefert eine Liste von Retoure-Aufträgen zurück. | 100 | |
| SetReturns | Fügt einen Retoure-Auftrag hinzu. | 100 | |
| SetWarranty | Legt eine neue Gutschrift an. | 104 | |
| GetLinkPriceColumnToReferrer | Liefert eine Liste mit den Auftragsherkünften und den jeweils verknüpften Preisspalten zurück. | 104 | |
| AddDeliveryOrder | Erstellt Lieferaufträge aus einem Auftrag. | 105 |
| Webshop-Calls | Erläuterung | ab Version | Limitierung* |
|---|---|---|---|
| GetMultiShops | Liefert eine Liste aller verfügbaren Multishops zurück. | 100 | |
| GetTermsAndCancellation | Liefert AGB und Widerrufsbelehrung zurück. | 103 | |
| SetTermsAndCancellation | Fügt AGB und Widerrufsbelehrung hinzu. | 103 | |
| GetLegalInformation | Liefert Datenschutzerklärung und Impressum zurück. | 104 | |
| SetLegalInformation | Fügt Datenschutzerklärung und Impressum hinzu. | 104 |
| Sonstige Calls | Erläuterung | ab Version | Limitierung* |
|---|---|---|---|
| GetServerTime | Liefert die aktuelle Serverzeit zurück. | 100 | |
| GetContentPage | Liefert eine Content-Seite in einer beliebigen Sprache zurück. | 100 | |
| SetContentPage | Ändert eine Content Seite. | 100 | |
| AddTicket | Fügt ein Ticket hinzu. | 100 | |
| AddTicketLeafe | Fügt eine Ticket-Antwort hinzu. | 100 | |
| GetEmailTemplate | Liefert ein E-Mail-Template zurück. | 100 | |
| GetPlentyMarketsVersion | Liefert die aktuelle Version eines plentyMarkets-Systems zurück. | 103 | 30 |
| GetVATConfig | Liefert die Mehrwertsteuersätze zurück. | 104 | |
| GetMarketplaceTransactions | Liefert die Transaktionen eines Marktplatzes zurück | 105 |
* Limitierung: Aufrufe pro Tag pro Benutzer
