VibeFox Aramex 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.

Aramex-Konto (nur für Live-Tarife): Live-Tarife nutzen die Aramex Rate Calculator API. Aramex gewährt seinen Kontoinhabern API-Zugang. Fragen Sie Ihren Aramex-Kundenbetreuer oder sehen Sie im Aramex Developers Solution Center auf der Aramex-Website nach. Sie benötigen sechs Werte: API-Benutzername (meist eine E-Mail-Adresse), Passwort, Kontonummer, Konto-PIN, Niederlassungscode des Kontos (Entity, zum Beispiel DXB) und Ländercode des Kontos (zum Beispiel AE). Wenn Sie nur feste Preise pro Land nutzen, benötigen Sie kein Aramex-Konto.

VibeFox-Lizenzschlüssel: erhältlich auf vibefox.net. Ein Schlüssel gilt für eine 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 den Ordner vfd_aramex auch per FTP nach /wp-content/plugins/ hochladen.

2. Klicken Sie auf Activate.

3. Öffnen Sie die Einstellungen: WooCommerce > Settings > Shipping > VibeFox Aramex, oder klicken Sie auf der Plugins-Seite 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. Wählen Sie, wie die Versandkosten berechnet werden, und füllen Sie die passenden Abschnitte aus (siehe Konfiguration).

6. Fügen Sie VibeFox Aramex unter WooCommerce > Settings > Shipping > Shipping zones einer Versandzone hinzu, 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 Aramex. 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 Aramex-Tarife gelöscht.

Allgemein

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

Method title: der Name der Versandart, der im Warenkorb und an der Kasse angezeigt wird. Standard: Aramex.

Shipping cost: wie der Preis berechnet wird.

Der Grund für einen fehlenden Live-Tarif wird im Debug-Protokoll gespeichert. Er wird dem Kunden nie angezeigt.

Aramex-API-Konto (nur für Live-Tarife erforderlich; alle sechs Felder sind Pflicht)

Username: Ihr API-Benutzername bei Aramex, meist eine E-Mail-Adresse.

Password: Ihr API-Passwort bei Aramex.

Account number: Ihre Kundenkontonummer bei Aramex.

Account PIN: die PIN Ihres Aramex-Kontos.

Account entity: der Niederlassungscode (Entity) Ihres Aramex-Kontos, zum Beispiel DXB, AMM oder RUH.

Account country code: der zweistellige Ländercode Ihres Aramex-Kontos, zum Beispiel AE.

Aramex-Dienst (für Live-Tarife verwendet)

Liegt die Lieferadresse im Herkunftsland, wird die Sendung als Domestic angeboten. Alle anderen Sendungen werden als International Express angeboten.

International service: das Aramex-Produkt für Sendungen ins Ausland: PPX Priority Parcel Express (Standard), PDX Priority Document Express, PLX Priority Letter Express, DPX Value Express Parcels, EPX Economy Parcel Express, EDX Economy Document Express, GPX Ground Parcel Express oder GDX Ground Document Express.

Domestic service: das Aramex-Produkt für Sendungen innerhalb des Herkunftslandes: ONP Overnight Parcel (Standard), OND Overnight Document, SMP Same Day Parcel, SMD Same Day Document, SDD Same Day Delivery, EMD Early Morning Delivery, PEC Economy Delivery, PEX Road Express oder HVY Heavy (20 kg und mehr).

Payment type: wer Aramex für die Sendung bezahlt: Prepaid (Absender zahlt), Collect (Empfänger zahlt) oder Third party (Dritter). In der Regel Prepaid.

API weight unit: die an Aramex gesendete Einheit, KG oder LB. Produktgewichte werden von der Gewichtseinheit Ihres Shops umgerechnet. Das abrechenbare Gewicht ist der höhere Wert aus tatsächlichem Gewicht und Volumengewicht (Länge × Breite × Höhe in cm / 5000). Das Minimum beträgt 0,5 kg, was auch Produkte ohne Gewicht abdeckt.

Currency conversion rate: Aramex wird gebeten, Tarife in der Währung Ihres Shops anzugeben. Antwortet Aramex dennoch in einer anderen Währung, wird der Tarif mit dieser Zahl multipliziert (1 Einheit der Aramex-Währung = X Einheiten Ihrer Shopwährung). Lassen Sie das Feld leer, um solche Tarife abzulehnen, damit ein Kunde nie in der falschen Währung belastet wird. Sowohl Punkt als auch Komma werden als Dezimaltrennzeichen akzeptiert.

Versand ab (Absenderadresse) (für Live-Tarife verwendet)

Origin country: das Land, aus dem Sie versenden. Standardmäßig das Land Ihres Shops.

Origin city: die Stadt, aus der Sie versenden. Aramex verlangt sie.

Origin state / emirate: optional.

Origin postcode: optional.

Ist das Herkunftsland das Land Ihres Shops, werden leere Felder aus der Shop-Adresse unter WooCommerce > Settings > General übernommen.

Festpreise (im Festpreismodus und als Ersatz für Live-Tarife verwendet)

Price per country: eine Tabelle mit zweistelligen Ländercodes und Preisen in der Währung Ihres Shops. Klicken Sie auf Add row, um ein Land hinzuzufügen, und auf das Kreuz, um eines zu entfernen. Verwenden Sie * als Ländercode für alle übrigen Länder. Länder ohne Preis (wenn keine *-Zeile vorhanden ist) erhalten keinen Festpreis, daher wird die Methode für sie ausgeblendet.

Fixed price applies: Per order berechnet den Preis einmal. Per item multipliziert ihn mit der Anzahl der Artikel im Warenkorb. Live-Tarife von Aramex werden immer pro Sendung berechnet.

Bedingungen

Minimum weight (kg): blendet die Methode aus, wenn der Warenkorb leichter ist. 0 bedeutet keine Begrenzung.

Maximum weight (kg): blendet die Methode aus, wenn der Warenkorb schwerer ist. Standard: 100. 0 bedeutet keine Begrenzung.

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.

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

Free shipping: aktiviert kostenlosen Aramex-Versand ab dem unten stehenden Betrag.

Free shipping from: die Zwischensumme des Warenkorbs (nach Rabatten, vor Steuern), ab der der Versand kostenlos ist. Wird nur verwendet, wenn Free shipping aktiviert ist.

Tax status: Taxable fügt der Versandgebühr die WooCommerce-Steuer hinzu, None nicht. Aramex-Live-Tarife können die MwSt. bereits enthalten. Wählen Sie in diesem Fall None, damit die Steuer nicht doppelt berechnet wird.

Verfügbarkeit ohne Versandzonen

Ignore shipping zones: bietet Aramex für die unten genannten Länder an, auch wenn die Methode keiner Versandzone hinzugefügt wurde.

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

Erweitert

Debug log: schreibt Tarifberechnungen und API-Fehler in logs/vfd_armx_debug.log.php im Plugin-Ordner. Die Datei kann nicht über das Web geöffnet werden. Passwörter, PIN, Kontonummer und Kundenadressen werden maskiert. Schalten Sie das Protokoll aus, wenn Sie fertig sind.

Remove data on uninstall: ist die Option aktiviert, entfernt das Löschen des Plugins alle seine Einstellungen, Zonenmethoden, zwischengespeicherten Tarife und Protokolle. Das Deaktivieren des Plugins löscht nie etwas.

So funktioniert es an der Kasse

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 als Aramex (free), und es wird keine Anfrage an Aramex gesendet.

Im Festpreismodus wird der Preis aus der Tabelle übernommen. In den Live-Modi sendet das Plugin an Aramex die Herkunfts- und Lieferadresse, das abrechenbare Gewicht, den Dienst und die Währung Ihres Shops und zeigt die zurückgegebene Gesamtsumme an. Ein Live-Tarif wird erst angefragt, nachdem der Kunde eine Stadt oder Postleitzahl eingegeben hat. Jede Antwort wird 1 Stunde lang zwischengespeichert, sodass derselbe Warenkorb keine neue Anfrage auslöst. Eine fehlgeschlagene Anfrage wird 10 Minuten lang zwischengespeichert, damit die Kasse bei jeder Aktualisierung nicht auf Aramex warten muss. Das API-Timeout beträgt 10 Sekunden.

Gibt Aramex einen Fehler, einen Betrag von null oder einen Tarif in einer anderen Währung ohne Umrechnungskurs zurück, sieht der Kunde keine Fehlermeldung. Die Methode wird ausgeblendet, oder im Ersatzmodus wird der Festpreis verwendet. Der Grund wird im Debug-Protokoll gespeichert.

Die Methode funktioniert in der klassischen Kasse sowie in den Warenkorb- und Kassen-Blöcken. Sie ist mit WooCommerce High-Performance Order Storage (HPOS) kompatibel.

Das Plugin berechnet nur Tarife. Es erstellt keine Aramex-Sendungen, druckt keine Etiketten, bucht keine Abholungen, verfolgt keine Pakete und lässt Kunden keine Aramex-Filiale wählen. Das Paket wird an Aramex immer als ein Stück gesendet.

Lizenzschlüssel

Das Plugin funktioniert mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock befindet sich oben unter WooCommerce > Settings > Shipping > VibeFox Aramex. 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 gilt für eine 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 Aramex Kunden an der Kasse nicht angezeigt. Angemeldete Shop-Manager sehen es weiterhin, markiert mit (unlicensed — visible to admins only), damit Sie das Plugin einrichten und testen können, bevor Sie einen Schlüssel kaufen. Auf der Plugins-Seite und auf WooCommerce-Seiten erscheint ein Hinweis. Bestehende Bestellungen bleiben unberührt.

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

Fehlerbehebung

Aramex erscheint nicht an der Kasse: prüfen Sie, ob die Lizenz aktiv ist, Enable/Disable eingeschaltet ist und die Methode der Zone des Landes des Kunden hinzugefügt wurde (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 im Festpreismodus, ob das Land oder * einen Preis hat.

Live-Tarife erscheinen nicht: aktivieren Sie Debug log, laden Sie die Kasse neu und öffnen Sie logs/vfd_armx_debug.log.php im Plugin-Ordner. Dort steht der Grund: fehlende API-Zugangsdaten, der Aramex-Fehlercode, keine Herkunftsstadt, noch keine Lieferstadt oder Postleitzahl, eine Gewichts- oder Betragsgrenze oder ein Tarif in einer anderen Währung. Mit Aramex live rates, fixed prices if the API fails erhalten Kunden weiterhin den Festpreis, während Sie das Problem beheben.

Fehler ERR75 im Protokoll: Aramex hat die Anmeldung abgelehnt. Klären Sie Benutzername, Passwort, Kontonummer, PIN, Entity und Ländercode mit Ihrem Aramex-Kundenbetreuer ab.

Tarif in einer anderen Währung wird abgelehnt: Aramex hat in einer anderen Währung als der Ihres Shops geantwortet. Geben Sie einen Currency conversion rate ein oder bitten Sie Aramex, Tarife in Ihrer Währung anzugeben.

Steuer auf den Versand wird doppelt berechnet: Aramex-Summen enthalten die MwSt. möglicherweise bereits. Setzen Sie Tax status auf None.

Tarife wirken nach einer Änderung veraltet: speichern Sie die Einstellungsseite. Dadurch werden die zwischengespeicherten Aramex-Tarife gelöscht.

Aramex-Sandbox: das Plugin nutzt die Produktivumgebung des Aramex Rate Calculator. Entwickler können den Endpunkt mit dem Filter vfd_armx_api_url ändern. Die Filter vfd_armx_rate_request, vfd_armx_number_of_pieces und vfd_armx_volumetric_divisor passen die Anfrage, die Anzahl der Stücke und den Volumendivisor an.

Der Lizenzblock zeigt einen Fehler: folgen Sie der Meldung im Block. Ist der Schlüssel beispielsweise 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

Beim Deaktivieren des Plugins bleiben alle Daten erhalten. 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, zwischengespeicherte Tarife und Protokolle 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.

Aramex ist eine Marke ihres jeweiligen Inhabers. Dieses Plugin ist weder mit Aramex verbunden noch von Aramex empfohlen.