VibeFox iMile for WooCommerce — Hilfe

Anforderungen

WordPress: 5.8 oder neuer.

WooCommerce: 5.0 oder neuer, installiert und aktiv. Das Plugin lässt sich ohne WooCommerce nicht aktivieren.

PHP: 8.0 oder neuer.

iMile-Tarif: die Preise, die Sie mit dem Vertrieb von iMile vereinbart haben. Sie tragen sie in der Preistabelle in Ihrer Shopwährung ein.

iMile-API-Konto (nur für die Live-Schätzung): Die Live-Schätzung nutzt die iMile-OpenAPI „Estimated order delivery costs“. Sie benötigen eine Customer ID und einen Secret key (den API-Schlüssel, den iMile zusammen mit Ihrer Customer ID ausstellt). Für einen Testclient registrieren Sie sich im iMile-Entwicklerportal (developer.imile.com). Produktionsschlüssel erhalten Sie von Ihrem iMile-Kundenbetreuer. Wenn Sie nur die Preistabelle nutzen, benötigen Sie keine API-Schlüssel.

VibeFox-Lizenzschlüssel: erhältlich auf vibefox.net. Ein Schlüssel funktioniert auf einer Domain.

Installation

1. Gehen Sie in WordPress zu Plugins > Add New > Upload Plugin, wählen Sie die ZIP-Datei des Plugins und klicken Sie auf Install Now. Sie können auch den Ordner vfd_imile per FTP nach /wp-content/plugins/ hochladen.

2. Klicken Sie auf Activate.

3. Öffnen Sie die Einstellungen: WooCommerce > Settings > Shipping > VibeFox iMile, oder klicken Sie auf der Seite Plugins unter dem Plugin-Namen auf Settings.

4. Geben Sie Ihren VibeFox-Lizenzschlüssel im Lizenzblock oben auf der Seite ein und klicken Sie auf Activate.

5. Tragen Sie Ihre iMile-Preise in der Price table ein. Optional füllen Sie den Abschnitt Live rates (API) aus und aktivieren Live estimate (siehe Konfiguration).

6. Fügen Sie VibeFox iMile unter WooCommerce > Settings > Shipping > Shipping zones einer Versandzone hinzu (zum Beispiel „United Arab Emirates“), oder aktivieren Sie Ignore shipping zones und wählen Sie Länder aus.

Konfiguration

Alle Einstellungen befinden sich auf einer Seite: WooCommerce > Settings > Shipping > VibeFox iMile. Sie gelten für alle Versandzonen. Wenn Sie die Methode einer Zone hinzufügen, hat das Zonenfenster nur ein Feld:

Title (zone): der Name, den Kunden für diese Zone sehen. Lassen Sie das Feld leer, um den globalen Method title zu verwenden.

Jedes Mal, wenn Sie die Einstellungen speichern, werden die zwischengespeicherten iMile-Schätzungen und Zugriffstoken gelöscht. Ist die Live-Schätzung aktiviert, kann aber nicht funktionieren (keine Schlüssel, keine Versandstadt oder kein Versandland, keine Wechselkurse, leere Preistabelle), erscheinen Warnungen über den Einstellungen.

Allgemein

Enable/Disable: schaltet die Methode in allen Zonen gleichzeitig ein oder aus.

Method title: der Name der Versandmethode, der im Warenkorb und auf der Kassenseite angezeigt wird. Eine Zone kann ihn überschreiben. Standard: iMile.

Live-Tarife (API) (optional)

Liefert iMile keine Schätzung (keine Schlüssel, noch keine Stadt eingegeben, Fehler, Timeout, kein Wechselkurs), wird die Preistabelle verwendet.

Live estimate: aktivieren Sie die Option, um die Versandkosten von iMile zu erhalten. Standard: aus. Bei ausgeschalteter Live-Schätzung wird während des Checkouts nichts an iMile gesendet.

Environment: Production (openapi.imile.com) (Standard) oder Test (test-openapi.52imile.cn). Testschlüssel funktionieren nur mit dem Testserver und liefern Testpreise.

Customer ID: der von iMile vergebene Kundencode (customerId), zum Beispiel C2102192601.

Secret key: der geheime Schlüssel (API-Schlüssel), den iMile zusammen mit der Customer ID ausstellt. Damit werden die Anfragen signiert.

Signature: so werden die Anfragen signiert.

Ship-from country: das Land, aus dem Sie versenden. Standardmäßig ist es das Land Ihres Shops. Die Liste enthält die Länder, für die das Plugin iMile-Ländercodes hat.

Ship-from city: die Stadt, aus der Ihre Pakete versendet werden, geschrieben wie in der iMile-Städteliste (zum Beispiel Dubai, Riyadh). Lassen Sie das Feld leer, um die Shopstadt aus WooCommerce > Settings > General zu verwenden.

Ship-from province: optional, zum Beispiel Dubai oder Riyadh Province.

iMile service: der an iMile gesendete Auftragstyp: Delivery order (100) (Standard) oder Express order (1100). Express muss für Ihr Konto und Ihr Land freigeschaltet sein.

Goods category: die Warenart, die an iMile gesendet wird: Normal goods (Standard), Sensitive (cosmetics, liquids...), With battery, Batteries / power banks, Documents oder Parcel.

Exchange rates: iMile schätzt in der Währung des Ziellandes. Geben Sie eine Zeile je Währung mit dem Preis von 1 Einheit in Ihrer Shopwährung ein, zum Beispiel „AED = 0.25“ oder „SAR = 0.24“. Als Dezimaltrennzeichen sind Punkt und Komma erlaubt. Für die Shopwährung selbst ist kein Kurs nötig. Ohne Kurs werden Schätzungen in dieser Währung nicht verwendet, stattdessen gilt die Preistabelle. Derselbe Kurs rechnet den an iMile gemeldeten Warenwert um. Ungültige Zeilen werden beim Speichern entfernt.

Preise (wird verwendet, wenn die Live-Schätzung aus ist, und als Ersatz, wenn iMile keine Schätzung liefert)

Geben Sie Ihren iMile-Tarif in der Shopwährung ein. Ist er in AED, SAR oder einer anderen Währung, rechnen Sie ihn zuerst um.

Price table: eine Zeile pro Zielland. Klicken Sie auf + Add country, um eine Zeile hinzuzufügen, und auf das Kreuz, um eine zu entfernen. Wählen Sie * All other countries für eine Zeile, die alle Länder ohne eigene Zeile abdeckt. Jede Zeile hat einen Base price und optionale Gewichtsspalten: XS ≤1 kg, S ≤2 kg, M ≤3 kg, L ≤5 kg und XL >5 kg. Eine leere (oder 0) Gewichtsspalte verwendet den Grundpreis. Ein Grundpreis von 0 bedeutet kostenlosen Versand in dieses Land. Sowohl „9.99“ als auch „9,99“ werden akzeptiert. Zeilen ohne Preis, ungültige Ländercodes und negative Preise werden beim Speichern entfernt. Je Land bleibt nur eine Zeile erhalten.

Price for countries not in the table: ein Preis in der Shopwährung. Er wird verwendet, wenn die Tabelle keine Zeile für das Zielland hat (und keine *-Zeile), oder die Zeile für dieses Gewicht keinen Preis hat. Lassen Sie das Feld leer, um die Methode in diesem Fall auszublenden.

Price applies: wie der Tabellenpreis berechnet wird.

Dieselbe Wahl gilt für die Live-Schätzung: Pro Bestellung wird ein Paket mit dem gesamten Warenkorb gesendet; pro Artikel wird für jedes unterschiedliche Paket angefragt und mit der Anzahl der Einheiten multipliziert. Hat der Warenkorb mehr als 5 unterschiedliche Pakete, wird die Preistabelle verwendet.

Produktgewichte werden von Ihrer Gewichtseinheit im Shop in Kilogramm umgerechnet.

Bedingungen

Minimum weight (kg): blendet die Methode aus, wenn der Warenkorb weniger wiegt. 0 bedeutet keine Grenze.

Maximum weight (kg): blendet die Methode aus, wenn der Warenkorb mehr wiegt. Standard: 30. 0 bedeutet keine Grenze.

Minimum order amount: zeigt die Methode nur, wenn die Zwischensumme des Warenkorbs (nach Rabatten, vor Steuern) diesen Betrag erreicht. Leer lassen, um sie immer anzuzeigen.

Free shipping from: die Zwischensumme des Warenkorbs (nach Rabatten, vor Steuern), ab der die Lieferung mit iMile kostenlos ist. Leer lassen, um nie kostenlosen Versand anzubieten.

Excluded shipping classes: blendet die Methode aus, wenn der Warenkorb ein Produkt aus einer dieser WooCommerce-Versandklassen enthält.

Tax status: Taxable rechnet die WooCommerce-Steuer zu den Versandkosten hinzu, None tut dies nicht. Wählen Sie None, wenn die Preise der Tabelle und die iMile-Schätzungen die MwSt. bereits enthalten.

Verfügbarkeit ohne Versandzonen

Ignore shipping zones: bietet iMile für die unten angegebenen Länder an, auch wenn die Methode keiner Versandzone hinzugefügt ist.

Countries: die Zielländer für diesen Modus. Leer lassen, um alle Länder zu verwenden, in die Sie liefern. Dieses Feld wird nur verwendet, wenn Ignore shipping zones aktiviert ist.

Erweitert

Debug log: schreibt die Tarifberechnungen in WooCommerce > Status > Logs (Quelle „vfd_imile“). Es werden keine Schlüssel und keine Kundenadressen protokolliert. Fehlgeschlagene iMile-Anfragen werden immer protokolliert, auch wenn das Debug-Protokoll ausgeschaltet ist. Schalten Sie das Protokoll nach Abschluss wieder aus.

Remove data on uninstall: ist die Option aktiviert, entfernt das Löschen des Plugins alle iMile-Einstellungen, Zonenmethoden und zwischengespeicherten Schätzungen. Das Deaktivieren des Plugins löscht nie etwas.

So funktioniert es auf der Kassenseite

Gibt der Kunde eine Lieferadresse ein, fragt WooCommerce das Plugin nach einem Tarif. Das Plugin prüft zuerst die Bedingungen: Lieferland, Warenkorbgewicht, Mindestbestellwert und ausgeschlossene Versandklassen. Gilt kostenloser Versand, sieht der Kunde die Methode ohne Kosten, und es wird keine Anfrage an iMile gesendet.

Bei aktiver Live-Schätzung sendet das Plugin an iMile das Versandland, die Provinz und die Stadt, das Zielland, Bundesland, Stadt und Postleitzahl, das Warenkorbgewicht in kg, die Größe in cm³ (aus den Produktmaßen), den Warenkorbwert, den iMile-Service und die Warenart. Die Schätzung wird immer als Vorauszahlung angefragt, sodass Nachnahmegebühren nicht enthalten sind. Eine Live-Schätzung wird nur angefragt, nachdem der Kunde eine Stadt eingegeben hat, und nur wenn jedes Paket ein Gewicht hat. Jede Antwort wird 1 Stunde zwischengespeichert. Eine fehlgeschlagene Anfrage wird 5 Minuten zwischengespeichert. Nach einem Timeout oder einem Serverfehler wird iMile 2 Minuten lang nicht angefragt, nach abgelehnten Schlüsseln 5 Minuten lang, damit die Kassenseite bei jeder Aktualisierung nicht auf iMile wartet. Das API-Timeout beträgt 12 Sekunden. Ein abgelaufenes Zugriffstoken wird automatisch erneuert.

Die Schätzung wird mit Ihren Wechselkursen in die Shopwährung umgerechnet. Liefert iMile keine brauchbare Schätzung (Schlüssel nicht gesetzt, Stadt noch nicht eingegeben, unbekannte Stadt, Fehler, Timeout, kein Wechselkurs), sieht der Kunde keinen Fehler, und der Preis aus der Tabelle wird verwendet. Hat auch die Tabelle keinen Preis, wird die Methode ausgeblendet. Der Grund wird im Protokoll festgehalten.

Die Methode funktioniert in der klassischen Kassenseite sowie im Warenkorb- und Kassen-Block. Sie ist mit dem High-Performance-Bestellspeicher (HPOS) von WooCommerce kompatibel.

Das Plugin berechnet nur Tarife. Es erstellt keine iMile-Sendungen, druckt keine AWB-Etiketten, beantragt keine Abholungen, verfolgt keine Pakete, gleicht keine Nachnahmebeträge ab und bietet keine Abholstellen oder Paketboxen an. Nutzen Sie für Sendungen das iMile-Portal.

Lizenzschlüssel

Das Plugin funktioniert mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock befindet sich oben unter WooCommerce > Settings > Shipping > VibeFox iMile. Fügen Sie den Schlüssel in License key ein und klicken Sie auf Activate. Der Block zeigt den Status, zum Beispiel das Datum, bis zu dem die Lizenz aktiv ist, und Ihre Domain. Mit Check now prüfen Sie den Status erneut, mit Change key geben Sie einen anderen Schlüssel ein, und mit Remove key entfernen Sie ihn von dieser Website. Der Link Manage licenses and domains in your account öffnet Ihr vibefox.net-Konto.

Ein Schlüssel funktioniert auf einer Domain. Das Entfernen des Schlüssels von einer Website gibt deren Domain-Platz nicht frei. Geben Sie den Platz in Ihrem vibefox.net-Konto frei.

Ohne aktiven Schlüssel wird iMile Kunden auf der Kassenseite nicht angezeigt. Angemeldete Shopverwalter sehen es weiterhin, markiert mit (unlicensed — visible to admins only), damit Sie das Plugin vor dem Kauf eines Schlüssels einrichten und testen können. Auf der Seite Plugins und auf WooCommerce-Seiten erscheint ein Hinweis. Bestehende Bestellungen sind nicht betroffen.

Läuft eine Lizenz ab, funktioniert das Plugin weiter, aber Updates und Support erfordern eine Verlängerung. Der Status wird im Hintergrund automatisch erneut geprüft.

Fehlerbehebung

iMile erscheint nicht auf der Kassenseite: prüfen Sie, ob die Lizenz aktiv ist, Enable/Disable eingeschaltet ist und die Methode der Zone des Kundenlandes hinzugefügt ist (oder Ignore shipping zones aktiviert ist und das Land erlaubt ist). Prüfen Sie die Gewichtsgrenzen, Minimum order amount und Excluded shipping classes. Prüfen Sie, ob das Land oder * eine Zeile in der Price table hat oder ob Price for countries not in the table gesetzt ist.

Der Tabellenpreis wird anstelle der iMile-Schätzung angezeigt: Öffnen Sie WooCommerce > Status > Logs, Quelle „vfd_imile“, und aktivieren Sie Debug log für Details. Häufige Gründe: Live estimate ist aus, die Schlüssel fehlen, der Kunde hat noch keine Stadt eingegeben, iMile kennt die Schreibweise der Stadt nicht, die Produkte haben kein Gewicht, es gibt keinen Wechselkurs für die Zielwährung oder es liegt ein API-Fehler vor. Prüfen Sie auch die Warnungen über den Einstellungen.

„sign is invalid“ im Protokoll: prüfen Sie den Secret key und probieren Sie dann Signature = SimpleKey.

Schlüssel werden abgelehnt: prüfen Sie Customer ID, Secret key und Environment. Testschlüssel funktionieren nur mit dem Testserver.

Stadtnamen stimmen nicht überein: Stadtnamen müssen mit der iMile-Städteliste übereinstimmen. Entwickler können sie mit dem Filter vfd_imile_live_request zuordnen und Ländercodes mit dem Filter vfd_imile_live_country_code.

Preise in der falschen Währung: die Preistabelle ist in der Shopwährung (WooCommerce > Settings > General). Rechnen Sie einen Tarif in AED, SAR oder MXN beim Eingeben um. Live-Schätzungen werden mit Exchange rates umgerechnet.

Steuer auf den Versand doppelt berechnet: Wenn Ihre Preise die MwSt. bereits enthalten, setzen Sie Tax status auf None.

Schätzungen wirken nach einer Änderung veraltet: speichern Sie die Einstellungsseite. Dadurch werden die zwischengespeicherten iMile-Schätzungen gelöscht.

Der Lizenzblock zeigt einen Fehler: folgen Sie der Meldung im Block. Ist der Schlüssel etwa bereits auf einer anderen Domain verwendet, geben Sie in Ihrem vibefox.net-Konto einen Platz frei und klicken Sie auf Check now. Hat sich die Adresse der Website geändert, klicken Sie auf Check now, um den Schlüssel für die neue Domain zu aktivieren. Ist der Lizenzserver nicht erreichbar, arbeitet das Plugin mit dem zuletzt bekannten Status weiter.

Deinstallation

Das Deaktivieren des Plugins behält alle Daten. Zum Entfernen deaktivieren und löschen Sie es auf der Seite Plugins. Der Lizenzschlüssel und der Lizenzstatus dieses Plugins werden immer entfernt. Einstellungen, Zonenmethoden und zwischengespeicherte Schätzungen werden nur entfernt, wenn Remove data on uninstall aktiviert war. Andernfalls bleiben sie für eine spätere Neuinstallation erhalten. Bestehende Bestellungen behalten ihre Versandpositionen.

iMile ist eine Marke ihres jeweiligen Inhabers. Dieses Plugin ist nicht mit iMile verbunden und wird von iMile weder unterstützt noch empfohlen.