PlentyONE REST API (ehem. Plentymarkets REST-API)
Mit dem Synesty Studio PlentyONE Add-On automatisieren Sie den Austausch von Produkt-, Kunden- und Bestelldaten zwischen einem PlentyONE-System und externen Systemen.
-
Automatischer Abgleich von Warenbestand, Verfügbarkeit oder Auftragsdaten zwischen Shop und Drittsystemen
-
Abruf von Artikeldaten/Variantendaten, Preisen und Lagerbeständen
-
Setzen von Lagerbeständen und Verfügbarkeiten der Artikel / Varianten, die Aktualisierung des Warenbestands in PlentyONE mit Hilfe einer CSV-Datei
-
Abruf von Auftragsdaten um diese z.B. in ein externes System zu übertragen
-
Anlage und Update von Aufträgen in PlentyONE
-
Abgleich auch zwischen verschiedenen PlentyONE-Systemen möglich
PlentyONE Zugangsdaten einrichten
Damit Synesty Studio auf Ihr PlentyONE System zuzugreifen müssen sie zunächst folgendes einrichten.
Einen Nutzer in in PlentyONE mit entsprechenden Berechtigungen (REST-API) anlegen
Sie können für die Verbindung einen beliebigen PlentyONE Nutzer vom Typ Admin oder Variabel verwenden. Wir empfehlen allerdings einen eigenen Nutzer für die Verbindung Synesty Studio - PlentyONE zu erstellen.
Einen neuen PlentyONE Benutzer können sie in ihrem Backend unter Einstellungen » Grundeinstellungen » Benutzer » Konten anlegen. Bei der Erstellung des Nutzer können sie die Benutzerklasse Admin oder Variabel auswählen. Nach der Erstellung des neuen Nutzers müssen sie bei der für Benutzerklasse Variabel (je nach verwendeten Step) sind die Berechtigungen im Tab REST-API zu setzen. Beachten Sie dazu die Hinweise zu den Berechtigungen auf den Seiten der Steps. Die Benutzerklasse Admin verfügt bereits über alle Berechtigungen.
Neuen Nutzer anlegen:
REST API Berechtigungen setzen:
Erstellung einer neue PlentyONE REST API Verbindung in Synesty Studio
Im zweiten Schritt müssen die Zugangsdaten in ihrem Synesty Studio Account hinterlegt werden. Dazu müssen sie sich zunächst einloggen und unter *Mein Konto » Meine Verbindungen » PlentyONE REST API *eine neuen Account anlegen. Den Accountnamen können Sie frei vergeben. Username und password müssen mit den Zugangsdaten ihres PlentyONE Nutzers gefüllt werden. Als host tragen Sie die Domain ihres Shops ein. Wenn Sie die Felder ausgefüllt haben, können Sie die Accountdaten speichern.
PlentyONE REST API - Verbindungstest (optional)
Sie können ihre neu erstellte Verbindung direkt in den PlentyONE REST API Step verwenden. Um zu prüfen ob die eingegebenen Accountdaten korrekt sind, können Sie einen Verbindungstest durchführen. Bei einer neu erstellten Verbindung müssen Sie zunächst auf den Konfiguration starten Button klicken, damit ein neuer PlentyONE REST-API Token abgerufen wird. Wenn dieser Schritt erfolgreich war, können Sie über den Verbindung testen Button Ihre neue PlentyONE prüfen. Sie erhalten dann eine Erfolgsmeldung mit den konfigurierten Webstores.
REST API Limits
Die PlentyONE REST API ist in der Anzahl der Calls pro Minute und pro Tag limitiert. Es werden dabei lesende und schreibende Calls unterschieden. Die Limits unterscheiden sich je nach PlentyONE Tarif. Ihre persönlichen Limits finden Sie im PlentyONE Tarif-Konfigurator unter REST-API.
Die Folgende Fehlermeldungen bei der Ausführung weisen auf eine Überschreitung eines der Limits hin:
-
“long period read limit reached” → Max. Anzahl der lesenden Calls pro Tag wurde erreicht.
-
“long period write limit reached” → Max. Anzahl der schreibenden Calls pro Tag wurde erreicht.
-
“short period read limit reached” → Max. Anzahl der lesende Calls pro Minute wurde erreicht.
-
“short period write limit reached” → Max. Anzahl der schreibende Calls pro Minute wurde erreicht.
Die Anzahl der lesenden und schreibenden Calls pro Minute (“short period” limits) werden über den sogenannten “Rate Limiter” automatisch angepasst. Sollten Sie dennoch eine entsprechende Fehlermeldung erhalten, prüfen Sie bitte ob die Option “rateLimiter” in ihrer PlentyONE Verbindung aktiviert ist. In Ausnahmefällen kann eine Überschreitung des Minuten-Limits auch auftreten, wenn einige PlentyONE gleichzeitig ausgeführt werden. Versuchen Sie in diesem Fall die Ausführung der Steps/Flows so zu planen, dass diese nacheinander ausgeführt werden.
Wenn Sie eine “long period” Fehlermeldung erhalten können Sie die Limits in ihrer Tarif-Konfiguration anpassen. Wir empfehlen ihnen vorab zu prüfen, ob Calls eingespart werden können.
Steps im PlentyONE Add-On
- PlentyAddCategories (REST 1.0)
- PlentyAddItemCrossSelling (REST 1.0)
- PlentyAddItemImages (REST 1.0)
- PlentyAddItems (REST 1.0)
- PlentyAddOrderDocument (REST 1.0)
- PlentyAddOrderShippingReturns (REST 1.0)
- PlentyAddOrders (REST 1.0)
- PlentyAddOrdersPackage (REST 1.0)
- PlentyAddPropertyToItem (REST 1.0)
- PlentyAddStorageLocation (REST 1.0)
- PlentyAddVariationImageLink (REST 1.0)
- PlentyAddVariationToBundle (REST 1.0)
-
PlentyAddVariations (REST 2.0)
Klicken Sie hier, um alle Versionen anzuzeigen
- PlentyCreateDeliveryOrder (REST 1.0)
- PlentyElasticExport (REST 1.0)
- PlentyElasticSyncTrigger (REST 1.0)
- PlentyEndListings (REST 1.0)
- PlentyGetAddresses (REST 1.0)
- PlentyGetAttributes (REST 1.0)
- PlentyGetCategories (REST 1.0)
- PlentyGetCurrentStocks (REST 1.0)
- PlentyGetCurrentStocksByIDs (REST 1.0)
- PlentyGetCustomers (REST 1.0)
- PlentyGetDeleteLog (REST 1.0)
- PlentyGetFeedback (REST 1.0)
- PlentyGetItemBundles (REST 1.0)
- PlentyGetItemCrossSellingLinks (REST 1.0)
- PlentyGetItemImages (REST 1.0)
- PlentyGetItemsSuppliers (REST 1.0)
- PlentyGetListingHistory (REST 1.0)
- PlentyGetListingTexts (REST 1.0)
- PlentyGetListings (REST 1.0)
- PlentyGetManufacturers (REST 1.0)
- PlentyGetOrderDocuments (REST 1.0)
- PlentyGetOrderSerialNumbers (REST 1.0)
- PlentyGetOrderShippingPackage (REST 1.0)
- PlentyGetOrderShippingPallets (REST 1.0)
- PlentyGetOrderShippingReturns (REST 1.0)
- PlentyGetOrderStatusHistory (REST 1.0)
- PlentyGetProperties (REST 1.0)
- PlentyGetReorders (REST 1.0)
- PlentyGetSalesPriceSettings (REST 1.0)
- PlentyGetStockMovements (REST 1.0)
- PlentyGetStorageLocations (REST 1.0)
- PlentyGetTickets (REST 1.0)
- PlentyGetVariationAdditionalSKUs (REST 1.0)
- PlentyGetVariationImages (REST 1.0)
-
PlentyGetVariationMarketIdentNumbers (REST 2.0)
Klicken Sie hier, um alle Versionen anzuzeigen
- PlentyGetVariationProperties (REST 2.0)
- PlentyGetVariationSKUs (REST 1.0)
- PlentyGetVariationWarehouses (REST 1.0)
-
PlentyGetVariations (REST 2.0)
Klicken Sie hier, um alle Versionen anzuzeigen
- PlentyGetVariationsSalesPriceUpdate (REST 1.0)
- PlentyGetVariationsSalesPrices (REST 1.0)
- PlentyGetWarehouses (REST 1.0)
- PlentyRESTAuthenticate (REST 1.0)
- PlentyRemoveVariationSKUs (REST 1.0)
- PlentySearchOrders (REST 2.0)
- PlentySetAddress (REST 1.0)
- PlentySetAttributeValues (REST 1.0)
- PlentySetAttributes (REST 1.0)
- PlentySetBookOutgoingItems (REST 1.0)
- PlentySetBookReorderItems (REST 1.0)
- PlentySetContactBankAccount (REST 1.0)
- PlentySetCurrentStocks (REST 1.0)
- PlentySetCustomers (REST 1.0)
- PlentySetIncomingStocks (REST 1.0)
- PlentySetItemTexts (REST 1.0)
- PlentySetItemsShippingProfiles (REST 1.0)
- PlentySetOrderItems (REST 1.0)
- PlentySetOrdersHead (REST 1.0)
- PlentySetOutgoingStocks (REST 1.0)
- PlentySetProperties (REST 1.0)
- PlentySetProperty (REST 2.0)
- PlentySetTicket (REST 1.0)
- PlentySetTransferStocks (REST 1.0)
- PlentySetVariationBarcodes (REST 1.0)
- PlentySetVariationCategories (REST 1.0)
- PlentySetVariationDefaultCategories (REST 1.0)
-
PlentySetVariationMarketItemNumber (REST 2.0)
Klicken Sie hier, um alle Versionen anzuzeigen
- PlentySetVariationProperties (REST 2.0)
- PlentySetVariationSKUs (REST 1.0)
- PlentySetVariationSuppliers (REST 1.0)
- PlentySetVariationWarehouse (REST 1.0)
- PlentySetVariationsPrices (REST 1.0)
- PlentyUpdateImages (REST 1.0)
- PlentyUpdateItems (REST 1.0)
-
PlentyUpdateVariations (REST 2.0)
Klicken Sie hier, um alle Versionen anzuzeigen