Schlagwort-Archiv API

image_pdfimage_print

weclapp

Die Rest-Schnittstelle von weclapp kann über wemalo-connect angebunden werden. Im Folgenden werden die dazu notwendigen Schritte und Informationen aufgelistet, die für die Einrichtung benötigt werden.

Mandant in wemalo anlegen 

Der Mandant wird in wemalo in gewohnter Weise angelegt. Für die weitere Einrichtungen des Mandanten in wemalo-connect müssen die Mandanten-ID und die Lager-ID bekannt sein.

User in wemalo-connect anlegen

Ein neuer Shop-User wird in wemalo-connect angelegt und mit dem zuvor angelegten Mandanten in wemalo anhand der Mandanten-ID verknüpft. Zusätzlich wird die Lager-ID hinterlegt.

Die Anlage eines REST-Keys ist notwendig!

weclapp-Schnittstelle einrichten

Die weclapp-Schnittstelle wird im Bereich „Generic REST Interfaces“ angelegt. Diese Interfaces benutzen die REST-Schnittstelle von wemalo, um mit dem Backend zu kommunizieren. Die Anlage eines Rest-Tokens ist allerdings nicht notwendig.

Durch Klick auf den Button „Neuer Eintrag“ kann eine neue Schnittstelle definiert werden. Nach Auswahl des Systems, kann über den Button „System-Template“ die Konfiguration des Systems geladen werden. Am Beispiel weclapp werden Key-Value-Paare für das Hinterlegen der benötigten Einstellungen (URL, Token, weclapp-ID etc.) geladen. Eine Übersicht der benötigten Einstellungen folgt im nächsten Unterkapitel.

Darüber hinaus können die wemalo-Instanz (zuvor durch Verlinkung von wemalo und der Mandanten-ID eingerichtet) und das Synchronisationsintervall gewählt werden.

Es muss über Einstellungen->Grundeinstellungen->Lager, ein Lager angelegt werden.
Sobald dies geschehen ist können sie über die Bearbeiten Funktion (Stift-Symbol) das Lager öffnen und die Warehouse-ID in der Browserleiste am ende sehen (entityId=XXXX).
Diese wird in den weclapp-Einstellungen benötigt.

 

weclapp-Einstellungen

Folgende Einstellungen müssen vom Kunden bereitgestellt werden:

  • Token: hier muss der Token aus dem weclapp Shop eingetragen werden, (Meine Einstellungen->API Token) der erstellt werden muss.
  • url: die URL zur API Schnittstelle von weclapp. (Shop-URL/webapp/api/v1)
    Beispiel: https://<kunde>.weclapp.com/webapp/api/v1
  • (weclappId: 1)
  • (storageLocationId: 1)
  • warehouseId: die ID des Lagers in weclapp.

 

Folgende Einstellung werden von uns vorgenommen:

  • extendedLog: hier muss true eingetragen werden, um ein erweitertes Logging zu aktivieren.

 

Abos

Die folgenden Abos können aktiviert/deaktiviert werden:

  • serviceLoadProducts: laden von Produktstammdaten aus weclapp und Übermittlung an wemalo.
  • serviceLoadGoodsOrders: laden von WA-Aufträgen von weclapp und Übermittlung an wemalo.
  • servicePushPackages: zurückmelden von versendeten Paketen von wemalo an weclapp.
  • servicePushInventoryBookings: Übermittlung von Inventurbuchungen (Ein- und Ausbuchungen).
  • servicePushIncomingBookings: Übermittlung von Wareneingangsbuchungen
  • servicePushSentBookings: Übermittlung von Warenausgangsbuchungen.
  • servicePushReturnBookings: Übermittlung von Retourenbuchungen.

Produktstammdaten

Die Felder Gewichte in weclapp sind in Kilogramm (kg) anzugeben.
Die Produktmaße und Dimensionen sind in Meter (m) anzugeben.
Produktgruppen aus weclapp werden übernommen, ansonsten wird eine Standardgruppe in Wemalo definiert.

Anmerkungen

Folgende Tätigkeiten müssen manuell im weclapp erledigt werden um dort den Auftrag zum Abruf bereitstellen zu können.

Um eine Lieferung eines Auftrages erfolgreich zu erstellen, muss der Auftrag durch manuelles klicken bestätigt werden. Die Auftragsbestätigung im Status ORDER_CONFIRMATION_PRINTED kann der Kunde manuell oder über eine Massenaktion erstellen. Wenden Sie sich für Rückfragen bitte an den weclapp Support.

Die Versendung der Lieferung und die Erstellung der Rechnung muss auch hier durch ein manuelles klicken bestätigt werden. Der Bestand wird erst aktualisiert, wenn die Lieferung versendet wurde.

Die Retoure des Auftrages kann erst generiert werden, wenn die Lieferung versendet wurde.

Die Waren aus den Retouren kann man in das Lager zurückbuchen, indem man in weclapp unter dem Punkt Wareneingänge und Workflow “Alle Positionen ins Lager buchen” auswählt.

 

wemalo connect rest api

Die Dokumention zur Schnittstelle wemalo connect REST API befindet sich hier: connect-api.wemalo.com

REST API workflow

Is using wemalos rest api, at least the following calls might be used for interacting with wemalo.

First of all, an account needs to be set up for you. You’ll get a rest api token that is being used for authorization. Please see header information: Authorization

Product master data

Orders

WordPress Wemalo API 2

Mit der zweiten Version des WordPress-Plugins hat Wemalo den Funktionsumfang erheblich erweitert.

Einrichtung

  • Plugin Wemalo Connect über den WordPress-Shop herunterladen und aktivieren.
  • Anschließend muss ein Benutzeraccount in wemalo-connect eingerichtet werden (erfolgt durch einen Wemalo-Mitarbeiter).
  • Der in wemalo-connect generierte Sicherheitsschlüssel muss in der Konfiguration des Plugins hinterlegt werden (im Admimmenü wurde dazu ein Wemalo-Eintrag hinzugefügt).

Produkte

  • wird ein Produkt aktualisiert, so wird die Änderung direkt über wemalo-connect an Wemalo gesendet.
  • Zusätzlich werden in regelmäßigen Abständen die Produktstammdaten durch Wemalo abgefragt. Da dies primär für die initiale Einrichtung benötigt wird, ist die Häufigkeit des periodischen Abfragens reduziert.

Pflichtfelder

Das einzige wirkliche Pflichtfeld ist die Artikelnummer. Wichtig für die Lagerprozesse sind allerdings auch:

  • EAN (sofern Artikelnummer nicht bereits scannbar)
  • Artikelmaße und Gewicht (für Lagerung und Versand)
  • Produktbild (zur visuellen Verifikation)
  • Produktname (zum Namensabgleich beim Picken/Packen)

Erweiterung der Produkte

Das Plugin erweitert die Produkte und Varianten und fügt folgende Informationen hinzu:

  • neues Feld alternativer Bestand (z.B. B-Ware)
  • neues Feld EAN (Tab Wemalo im Hauptprodukt)
  • neue Einstellmöglichkeit Seriennummer (Tab Wemalo im Hauptprodukt)
  • Übersicht der Seriennummern/Chargen (Tab Wemalo im Hauptprodukt)

Daten-Übermittlung

  • Beim Speichern des Hauptproduktes wird der Datensatz direkt an Wemalo übermittelt. Im Tab Wemalo wird der Zeitstempel der letzten Daten-Übermittlung angezeigt.
  • Auch beim Speichern von Varianten findet eine direkte Übermittlung statt. Hier wird der Zeitstempel mit in der Varianten-Ansicht angezeigt.
  • Kommt es bei der Übermittlung zu einem Fehler, wird die Rückgabe des Servers ausgegeben.

Product Bundles

  • Das Plugin WooCommerce Product Bundle wird seit der Version 2.0.2 des Wemalo-Plugins unterstützt. Damit das Bundle-Produkt nicht mit als Position übertragen wird, darf für das Bundle keine Artikelnummer hinterlegt worden sein.
  • Alternativ zum Einsatz eines Plugins in WooCommerce, können Sets auch in Wemalo definiert sein. Dazu muss das Set-Produkt als normales Proodukt in WooCommerce angelegt und entsprechend in Wemalo konfiguriert werden (geschieht durch den Wemalo Kundenberater).

 Bestellungen

  • Sobald eine Bestellung auf „in Bearbeitung“ gesetzt wird, erfolgt eine Datenübermittlung an wemalo-connect und somit eine direkte Übertragung an Wemalo.
  • Der Download-Zeitstempel wird unmittelbar gesetzt. Kommt es bei der Übertragung zu einem Fehler, wird die Fehlermeldung als Custom Field hinterlegt.
  • Wenn der Auftrag vollständig reserviert werden konnte, wechselt er in einen neuen Fulfillment-Status.
  • Solange der Auftrag nicht reserviert worden ist und sich im Auftrag in Bearbeitung befindet, kann er über die Wordpress Stronierfunktion auch in Wemalo storniert werden. Sollte der Auftrag sich allerdings bereit im Fulfillment-Prozess befinden, muss er in Wemalo manuell storniert werden.
  • Einmal pro Stunde wird aus WooCommerce heraus der aktuelle Auftragsstatus abgefragt, so lange der Auftrag noch nicht reserviert worden ist.

Aufträge aktualisieren

  • Sofern sich der Auftrag noch nicht im Fulfillment befindet, kann er jederzeit bearbeitet werden.

Status-Erweiterung

  • Retoure angemeldet (siehe Retouren)
  • Retoure gebucht (siehe Retouren)
  • Auftrag im Fulfillment

Wurde ein Auftrag an Wemalo übermittelt, kann dort aber nicht in den Wemalo-Status offen gesetzt werden (und damit freigegeben zum Picken), so wird er in WooCommerce auf dem Status in Bearbeitung bleiben und kann aus WooCommerce heraus auch weiterhin storniert werden.

Wemalo-Felder in Aufträgen

  • Blockiert: wenn die Checkbox markiert wird, dann erfolgt eine Übertragung an Wemalo und der Auftrag wird gepickt und gepackt. In Wemalo landet er allerdings im Status „blockiert gepackt“ und wird erst nach Freigabe versendet.
  • Notiz: über das Textfeld kann eine Notiz übermittelt werden, die dem Picker bzw. Packer angezeigt wird.
  • ETD: wenn das Datumsfeld gesetzt worden ist und in der Zukunft liegt, dann wird die Ware zwar reserviert, in Wemalo kann dazu aber noch keine Pickliste erstellt werden. Erst wenn das Datum erreicht worden ist, kann die Pickliste erstellt und der Auftrag weiter bearbeitet/versendet werden.

Zusätzlich gibt es das Panel mit wemalo mit folgenden Daten:

  • Priorität: bestimmt die Priorität des Auftrags und kann zwischen normal, hoch und sehr hoch unterschieden werden. Die Priorität wirkst sich auf die Reihenfolge bei der Kommissionierung, sowie Reservierung aus.
  • Auftrag: über Auftrag kann ein anderer WooCommerce-Auftrag verlinkt werden, in dem die Auftragsnummer eingetragen wird. Eine darüber hinaus gehende Funktion existiert nicht (keine Verlinkung in wemalo o.ä.).
  • Dokumenten-Upload: ermöglicht den Upload von Dokumenten, wie Rechnungen oder Zollinhaltserklärungen.
  • Promi: erlaubt das Markieren eines Auftrages als Promi-Versand. Zusätzlich kann ein Text eingegeben werden, der an eine in der Konfiguration hinterlegte E-Mail-Adresse verschickt wird. Hierüber können z.B. individuelle Texte zu Aufträgen geschrieben und den Paketen beigelegt werden.
  • Versand: zum Einstellen des Versanddienstleisters.
  • Produkt: je nach Versanddienstleister können die Versandprodukte gewählt werden.
  • Retoure kein SN-Check: sollten Produkte Seriennummern beinhalten, kann über dieses Flag die Validierung auf richtig zurückgeschickte Seriennummern ausgeschaltet werden. Das Flag wird beim Anmelden einer Retoure an wemalo übertragen.

Trackingnummern

Trackingnummern werden als Notiz und in das Feld tracking_number eingetragen.

Sofern wp_liste for Amazon oder Ebay installiert worden sind, wird der Versanddienstleister in das Feld _wpla_tracking_provider (Amazon) / _wpl_tracking_provider (Ebay) und die Trackingnummer in _wpla_tracking_number (Amazon) / _wpl_tracking_number (Ebay).

Die Trackingnummer kann auch in den E-Mails integriert werden, die von WooCommerce automatisch beim Fertigstellen von Aufträgen versendet werden. Eine Anleitung befindet sich hier: Trackingnummer E-Mail bei WooCommerce einfügen

Versandprofile

In Wemalo kann für das Matching des zu versendenden Versandprofils eine externe ID hinterlegt werden. Diese kommt aus der WordPress-Installation und befindet sich unter unter WooCommerce->Einstellungen->Versand.


 Bestände

  • Wemalo führt eine Bestandsaktualisierung durch. Das heißt, dass in regelmäßigen Abständen die in Wemalo geänderten Bestände an den WooCommerce-Shop übertragen werden. Die Bestände von A-Ware wird dabei in den normalen Lagerbestand übernommen. Alle weiteren Bestände (B-Ware, C-Ware etc.) werden in ein gesondertes Feld für alternative Bestände eingetragen.
  • Damit die Bestände nach WooCommerce übertragen werden können, muss shopseitig in den Produkten die Bestandsverwaltung aktiviert werden.

 Retouren

  • Das Wemalo API-Plugin bietet die Möglichkeit, aus einer Bestellung eine angemeldete Retoure zu machen. Sobald der Status der Bestellung entsprechend geändert worden ist, wird die Retoure an Wemalo übermittelt.
  • Die Retoure kann dann gegen den Ursprungsauftrag gescannt und die Ware daher validiert werden.
  • Wemalo meldet die vereinnahmte Ware an das Plugin zurück und setzt den Status auf Retoure gebucht.

Unterstützte Plugins

Unterstützte WordPress-Plugins

Unterstützte WordPress-Plugins

Unterstützte Versionen in Plugin 2.x:

WordPress/ WooCommerce 3.1.2 3.2.6
4.7.1 X ?
4.8.3 X X
4.8.4 X X
4.9.2 ? X

Version 1.x

WordPress/ WooCommerce 2.6.9 3.1.2
4.5.10 ? X
4.7.1 X ?

X => Diese Kombination wird unterstützt
? => Diese Kombination wird nicht aktiv unterstützt, könnte aber funktionieren
– => Diese Kombination wird nicht unterstützt

Beim Einsatz der Wemalo-API werden die nachfolgenden Plugins von Wemalo unterstützt:

  • Akismet von Automattic
  • FAQ von Etoile Web Design
  • Wp Cookie Choice von Marcus Franke
  • Yoast SEO von Team Yoast
  • WP-Lister for ebay Version 2.0.15 von WPLab
  • WP-Lister for amazon Version 0.9.6.31 von WPLab
  • WooCommerce Multilingual 4.2.6 (ab Version 2.0.1) von OnTheGoSystems
  • Antispam Bee 2.7.1 von pluginkollektiv
  • WooCommerce Product Bundle (ab Version 2.0.2)

Sollten im Shop darüber hinaus weitere Plugins eingesetzt werden, kann die Funktionalität des Wemalo-Plugins nicht gewährleistet werden. Ggf. muss das Plugin angepasst werden, damit es mit weiteren Plugins zusammen arbeitet.

Shopify

Die REST-Api von Shopify ist in wemalo-connect integriert und verbindet Wemalo mit dem Shopsystem Shopify.

Einstellungen in Shopify

Für die Anbindung werden ein API Key, Passwort und die URL benötigt.

Unter Apps > Manage prive apps > Generate API credentials kann der API-Zugang eingerichtet werden.
Als App-Name können Sie z.B. wemalo-connect vergeben. Nach der Key-Generierung benötigen wir den API Key, das Passwort sowie die genaue URL. Unter „Example URL“ steht ein zusammengebauter Link mit den benötigen Informationen. Diesen Link muss uns zur Verfügung gestellt werden. Hier ein Beispiel:
Die benötigten Zugriffsberechtigungen sind hier zu sehen:
api einrichten
Die benötigten Zugriffsberechtigungen umfassen derzeit folgende Anforderungen:

Unterstützte Aktionen

  • Laden von Produktstammdaten
  • Laden von Aufträgen
  • Übermittlung von versendeten Paketen
  • Übermittlung von Beständen

Produktstammdaten

  • Produkte, bei denen requires_shipping nicht gesetzt worden ist, werden nicht geladen.
  • Alle anderen auf „aktiv“ gesetzten Produkte/Varianten werden synchronisiert. Dabei werden SKU, EAN, Gewicht, Name, Produktgruppe und Hersteller ausgetauscht.
  • Bitte beachten: die SKU (auch in Varianten) muss eindeutig / unique sein.

Achtung: Ein bekannter Fehler seitens Shopify ist, dass Shopify bei der Anlage neuer Produkte, die duplizierten worden sind, keine neue externe ID vergibt. Das neu erstellte/duplizierte Produkt erhält somit die selbe externe ID. Aus diesem Grund ist es nicht möglich, neue Produkte durch die Funktion „Duplizieren“ zu erstellen, da eine neue, einmalige externe ID notwendig ist, um neue Produkte an wemalo zu übertragen.

Aufträge

  • Aufträge mit dem financial_status paid und fulfillment_status unshipped werden geladen und das Tag Wemalo_Download gesetzt.
  • Auftragskopfdaten, Lieferadresse und Positionen werden synchronisiert.
  • Über das Notizfeld kann eine Pickinfo angegeben werden.
  • Um den korrekten Versanddienstleister zu ermitteln, fragt Wemalo den Namen des gewählten Dienstleisters ab. Zum Matchen muss dieser in Wemalo bei den zu verwendenden Profilen als externe ID hinterlegt werden.
  • Es werden nur Positionen an Wemalo übermittelt, bei denen „requires_shipping“ gesetzt worden ist.
  • Achtung: sobald ein Auftrag an Wemalo übermittelt wurde, werden keine weiteren Änderungen am Auftrag an Wemalo übergeben.

Übermittlung von Paketen/Trackingnummern

  • Trackingnummer wird zusammen mit Versanddienstleister an Shopify zurück übertragen.
  • Dadurch ändert sich der fulfillment_status automatisch.

Übermittlung von Beständen

  • Damit ein Bestand von Wemalo übermittelt werden kann, muss die Inventory Policy aktiviert worden sein.
  • Wemalo übermittelt keine negativen Bestand, wenn unvollständige Aufträge vorliegen, die nicht bedient werden können. Ansonsten können die Varianten in Shopify nicht mehr aufgerufen werden.
  • Es werden nur kommissionierbare Bestände zurückgemeldet. D.h. Ware auf Sperrlager oder bereits gepickte Ware wird nicht als verfügbarer Bestand an Shopify übertragen.

Location-ID herausfinden

  • Im Shop auf Settings/Einstellungen (unten links) gehen, dann auf den Bereich Locations klicken.
  • Anschließend die Standard-Location auswählen.
  • Die Location-ID ist anschließend in der Adresszeile im Browser zu sehen (z.B. 1112222122).

Sollte die Location-ID nicht korrekt sein, kann seitens wemalo eine versteckte Location-ID ermittelt werden. Dies geschieht über den REST-Call.

wemalo-connect Release

Version 1.2.3

Date: 13.11.2017

Version 1.2.2

Date: 14.09.2017

  • Shopware configuration simplified
  • Activating/deactivating of wemalo instances implemented
  • new rest call for creating inventories implemented

Version 1.2.1

Date: 17.08.2017

  • Loading return orders from Shopware and pushing back booked returns integrated

Version 1.2.0

Date: 16.08.2017

  • Integration of Shopify api
  • Enhancements to shopware api

Version 1.1.0

Date: 07.07.2017

Version 1.0.1

Date: 28.06.2017

  • new call for creating multiple products at once added to connect api
  • possibility to set a product as activated/deactivated added to connect api
  • new rest calls need wemalo-backend 1.5.2.1 or later

Version 1.0.0

Date: 09.06.2017

  • connect-api has finally been implemented
  • wemalo-connect now allows using a wemalo rest api to transmit product data and goods orders and to load information about stock changes and sent packages
  • the api needs wemalo-backend 1.4.4 or higher

Version 0.2

Date: 07.06.2017

  • additional rest calls implemented
  • rest calls are now being validated before sending them to wemalo
  • preparation for managing shop systems in wemalo-connect

Version 0.1

Date: 31.05.2017

  • first beta version of wemalo-connect has been released
  • in this version it’s possible to manage users, wemalo instances and to communicate with wemalo via a rest api

wemalo-connect

wemalo-connect verbindet Wemalo mit Shops, ERPs und sonstigen externen Systemen. Die Software kann unabhängig von Wemalo eingesetzt werden, um z.B. den WordPress-Shop mit dem Plentymarkets-Shop zu synchronisieren. wemalo-connect kommt allerdings voll zur Geltung, wird auch Wemalo als Software für das Lagermanagement eingesetzt. Darüber hinaus stellt wemalo-connect eine REST-API zu Wemalo bereit, über den Produktstammdaten ausgetauscht, Bestellungen übermittelt und Bestände abgefragt werden. Der volle Funktionsumfang ist in der Schnittstellen-Dokumentation zu sehen: connect-api

Einrichtung von WordPress WooCommerce

Dieser Beitrag bezieht sich auf die Plugin Version 1.x. Zur Version 2.x gibt es einen separaten Beitrag.

Nachdem das Wemalo-Plugin in WordPress installiert worden ist, kann es mit Wemalo gekoppelt werden. Dazu muss unter Datenaustausch die API WordPress gewählt und die URL zum Shop hinterlegt werden.

Einrichten der WordPress-Umgebung

Datenabos

Über die Abos können einzelne Datencalls aktiviert/deaktiviert werden:

  • Hole WA-Aufträge: Bestellungen, die in WooCommerce eingehen, werden an Wemalo übermittelt und können dort als Warenausgangsaufträge weiterverarbeitet werden. Es werden nur Bestellungen an Wemalo übermittelt, die sich im Status „In Bearbeitung“ befinden, also bereits bezahlt worden sind.
  • Hole Produktstammdaten: um mit den Daten aus WordPress arbeiten zu können, muss diese Option gewählt werden. Dadurch werden die „einfachen Produkte“ und „variablen Produkte“ aus WooCommerce an Wemalo übertragen. Bei Varianten entsteht als Produktname eine Kombination aus dem Titel des Vaterproduktes und den einzelnen Attributen.
  • WE-Buchungen übermitteln: alle Wareneingänge im Lager (Wareneingang, Retoureneingang, Inventur-Einbuchung) werden an WooCommerce übermittelt und der Bestand der jeweiligen Artikel wird entsprechend erhöht.
  • WA-Buchungen übermitteln: Wemalo meldet an WooCommerce zurück, wenn ein Auftrag versendet worden ist und setzt den Status auf „completed“. Außerdem werden Inventur-Ausbuchungen und Warenausgänge ohne WooCommerce-Bezug als Bestandsänderung zurück übermittelt.

Authentifizierungsschlüssel

Nachdem die Datenabos gewählt worden sind und auf Speichern gedrückt wurde, generiert das System ein Token, dass zur Authentifizierung verwendet werden muss:

Wordpress-Token

Dieser Schlüssel muss im Wemalo-Plugin eingetragen werden:

Authkey im Wemalo-Plugin bei WordPress eintragen

 

In WooCommerce zu beachten

Auch bei Varianten sollte eine Artikelnummer hinterlegt werden. Diese wird an Wemalo als SKU übermittelt. Standardmäßig gibt es bei WooCommerce nicht die Möglichkeit, eine EAN für Artikel zu hinterlegen. Daher bleibt dieses Feld in Wemalo leer. Um Ware scannen zu können, kann daher nur der von Wemalo generierte interne Barcode oder die SKU verwendet werden. Eine Alternative wäre, wenn die EAN als SKU hinterlegt werden würde.

In Wemalo zu beachten

Bei Bestellungen kann der Kunde (sofern aktiviert) zwischen nationalem Versand, kostenlosem Versand etc. wählen. Die ID der jeweiligen Versandoption muss als Ext. Profil-ID in Wemalo bei den Versandprofilen hinterlegt werden, damit das System das richtige Profil beim Anlegen eines WA-Auftrages wählt. Die ID des Profils befindet sich in WordPress unter WooCommerce->Einstellungen->Versand:
Versnadprofile in WooCommerce

Download-Seite: WemaloAPI.zip