VibeFox Aramex for PrestaShop — Hilfe

Anforderungen

PrestaShop: 8.0 bis 9.x.

PHP: 8.0 oder neuer. Das Modul lässt sich auf älteren PHP-Versionen nicht installieren.

Aramex-Konto (nur für Live-Tarife): Live-Tarife nutzen die Aramex Rate Calculator API. Aramex gewährt 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, Konto-Entität (zum Beispiel DXB) und Ländercode des Kontos (zum Beispiel AE). Wenn Sie nur feste Preise pro Land nutzen, brauchen Sie kein Aramex-Konto.

VibeFox-Lizenzschlüssel: wird auf vibefox.net gekauft. Ein Schlüssel funktioniert für eine Domain.

Installation

1. Gehen Sie im Back-Office zu Modules > Module Manager und klicken Sie auf Upload a module. Wählen Sie die ZIP-Datei des Moduls.

2. Wenn der Upload abgeschlossen ist, klicken Sie auf Configure, oder suchen Sie später VibeFox Aramex in der Modulliste und klicken Sie auf Configure.

3. Fügen Sie Ihren VibeFox-Lizenzschlüssel in das Feld License key im Lizenzblock oben auf der Configure-Seite ein und klicken Sie auf Activate (siehe Lizenzschlüssel).

4. Wählen Sie, wie die Versandkosten berechnet werden, füllen Sie die passenden Abschnitte aus (siehe Konfiguration) und klicken Sie auf Save.

Bei der Installation legt das Modul den Versanddienstleister Aramex mit dem Lieferzeittext Courier delivery an. Der Versanddienstleister wird allen Zonen und allen Kundengruppen zugewiesen. Zonen, Kundengruppen, Lieferzeit, Logo und Größenbeschränkungen können Sie unter Shipping > Carriers ändern. Legen Sie dort keine Preise fest: Der Preis kommt immer aus dem Modul.

Konfiguration

Alle Einstellungen befinden sich auf der Modulseite: Modules > Module Manager > VibeFox Aramex > Configure. Jeder Abschnitt hat eine eigene Schaltfläche Save, die die gesamte Seite speichert. Bei jedem Speichern werden auch die zwischengespeicherten Aramex-Tarife gelöscht.

Allgemein

Enable Aramex: schaltet den Versanddienstleister ein oder aus. Das ist derselbe Schalter wie der Status des Versanddienstleisters unter Shipping > Carriers.

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

Shipping cost: wie der Preis berechnet wird.

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

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

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

Password: Ihr Aramex-API-Passwort. Nach dem Speichern bleibt das Feld leer und zeigt Saved — leave empty to keep it. Geben Sie nur dann einen neuen Wert ein, wenn Sie ihn ändern möchten.

Account number: Ihre Aramex-Kundennummer.

Account PIN: die PIN Ihres Aramex-Kontos. Wie das Passwort wird sie nach dem Speichern nicht mehr angezeigt.

Account entity: der Entitäts- (Niederlassungs-) Code Ihres Aramex-Kontos, zum Beispiel DXB, AMM oder RUH.

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

Aramex-Service (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 den Versand bezahlt: Prepaid (Absender zahlt), Collect (Empfänger zahlt) oder Third party (Dritter). Normalerweise Prepaid.

API weight unit: die Einheit, die an Aramex gesendet wird, KG oder LB. Produktgewichte und -maße werden aus den Einheiten Ihres Shops umgerechnet. Das Abrechnungsgewicht 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; das gilt auch für Produkte ohne Gewicht.

Currency conversion rate: Aramex wird gebeten, Tarife in der Standardwährung Ihres Shops anzugeben. Antwortet Aramex trotzdem in einer anderen Währung, wird der Tarif mit dieser Zahl multipliziert (1 Einheit der Aramex-Währung = X Einheiten Ihrer Standardwährung). Lassen Sie das Feld leer, um solche Angebote abzulehnen, damit ein Kunde nie in der falschen Währung belastet wird.

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

Origin country: das Land, von dem Sie versenden. Standardmäßig ist es Ihr Shop-Land.

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

Origin state / emirate: optional.

Origin postcode: optional.

Ist das Herkunftsland Ihr Shop-Land, werden leere Felder aus der Shop-Adresse unter Shop Parameters > Contact > Stores übernommen.

Feste Preise (im festen Modus und als Ausweichlösung für Live-Tarife verwendet)

Price per country: eine Tabelle mit zweistelligen Ländercodes und Preisen in der Standardwährung Ihres Shops, ohne Steuer. Klicken Sie auf Add row, um ein Land hinzuzufügen, und auf das Papierkorbsymbol, 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 festen Tarif, sodass der Versanddienstleister für sie ausgeblendet wird.

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

Bedingungen

Minimum weight: blendet den Versanddienstleister aus, wenn der Warenkorb weniger wiegt, in kg. 0 bedeutet keine Grenze.

Maximum weight: blendet den Versanddienstleister aus, wenn der Warenkorb mehr wiegt, in kg. Standard: 100. 0 bedeutet keine Grenze.

Minimum order amount: zeigt den Versanddienstleister nur an, wenn die Zwischensumme des Warenkorbs (nach Rabatten, vor Steuern) diesen Betrag erreicht. Lassen Sie das Feld leer, um ihn immer anzuzeigen.

Free shipping: aktiviert kostenlosen Aramex-Versand ab dem unten angegebenen 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: die Steuerregel des Versanddienstleisters oder No tax. Aramex-Live-Tarife können bereits MwSt. enthalten. Wählen Sie in diesem Fall No tax, damit die Steuer nicht doppelt berechnet wird.

Countries: bietet Aramex nur für diese Zielländer an. Lassen Sie das Feld leer, um alle Länder der Versandzonen zuzulassen.

Erweitert

Debug log: schreibt Tarifberechnungen und API-Fehler in logs/vfd_armx_debug.log.php im Modulordner. Die Datei lässt sich nicht über das Web öffnen. Passwörter, PIN, Kontonummer und Kundenadressen werden maskiert. Schalten Sie das Protokoll aus, wenn Sie fertig sind.

Log: zeigt die Größe und die neuesten Einträge des Debug-Protokolls. Klicken Sie auf Clear log, um es zu leeren.

Remove data on uninstall: wenn aktiviert, löscht die Deinstallation des Moduls die Aramex-Einstellungen, den Versanddienstleister, die zwischengespeicherten Tarife und die Protokolle. Wenn deaktiviert, bleibt alles für eine erneute Installation erhalten.

So funktioniert es an der Kasse

Im Versandschritt fragt PrestaShop das Modul nach dem Aramex-Preis. Nur physische Produkte zählen: Virtuelle Produkte erhöhen weder das Gewicht noch den Bestellwert. Das Modul prüft zuerst die Bedingungen: erlaubte Länder, Warenkorbgewicht und Mindestbestellwert. Gilt kostenloser Versand, beträgt der Preis 0 und es wird keine Anfrage an Aramex gesendet.

Im festen Modus wird der Preis aus der Tabelle übernommen. In den Live-Modi sendet das Modul an Aramex die Herkunfts- und Lieferadresse, das Abrechnungsgewicht, den Service und Ihre Standardwährung und verwendet die zurückgegebene Summe. Ein Live-Tarif wird nur abgefragt, wenn die Lieferadresse eine Stadt oder Postleitzahl hat. Der Preis wird in Ihrer Standardwährung berechnet und danach in der Warenkorbwährung des Kunden angezeigt.

Jede Antwort wird 1 Stunde lang zwischengespeichert, damit 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-Zeitlimit 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. Der Versanddienstleister wird ausgeblendet oder im Ausweichmodus wird der feste Preis verwendet. Der Grund wird im Debug-Protokoll festgehalten.

Wenn Sie den Versanddienstleister unter Shipping > Carriers bearbeiten, nachdem er Bestellungen hat, speichert PrestaShop ihn als neue Version des Versanddienstleisters. Das Modul übernimmt die neue Version automatisch.

Das Modul 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 Modul funktioniert mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock License — VibeFox Aramex ist der erste Block unter Modules > Module Manager > VibeFox Aramex > Configure, oberhalb der Einstellungen. Fügen Sie den Schlüssel in License key ein und klicken Sie auf Activate. Danach zeigt der Block den Schlüssel maskiert, den Status (zum Beispiel das Datum, bis zu dem die Lizenz gültig ist, und Ihre Domain) sowie die Schaltflächen Check now, um den Status erneut zu prüfen, Change key, um einen anderen Schlüssel einzugeben, und Remove key, um den Schlüssel aus diesem Shop zu entfernen. Darunter stehen die Zeile Product: presta-shipping-aramex und der Link Manage licenses and domains in your account, der Ihr vibefox.net-Konto öffnet. Nur Mitarbeiter mit der Berechtigung Configure für das Modul können den Schlüssel ändern. Die Texte des Blocks folgen der Sprache des Back-Office (Englisch und Russisch sind enthalten).

Wird der Schlüssel nicht akzeptiert, nennt der Block den Grund, zum Beispiel Key not found, This key belongs to another product, Domain limit reached oder License expired on mit einem Datum. Nach einer Änderung der Shop-Adresse oder nachdem Sie in Ihrem Konto einen Domain-Platz freigegeben haben, klicken Sie auf Check now. Ist der Lizenzserver nicht erreichbar, arbeitet das Modul mit dem zuletzt bekannten Status weiter.

Ein Schlüssel funktioniert für eine Domain: die Domain des Hauptshops, auch bei einer Multistore-Einrichtung. Das Entfernen des Schlüssels aus dem Shop gibt seinen Domain-Platz nicht frei. Geben Sie den Platz in Ihrem vibefox.net-Konto frei.

Ohne einen aktiven Schlüssel wird der Aramex-Versanddienstleister Kunden an der Kasse nicht angezeigt und es wird kein Tarif berechnet. Der PrestaShop-Storefront weiß nicht, dass Sie im Back-Office angemeldet sind, daher wird der Versanddienstleister auch für Sie ausgeblendet: Sie können das Modul vor dem Kauf eines Schlüssels einrichten, aber an der Kasse nicht testen. Eine Erinnerung erscheint unter Modules > Module Manager auf dem Reiter Alerts. Bestehende Bestellungen sind nicht betroffen.

Läuft eine Lizenz ab, arbeitet das Modul weiter, Updates und Support erfordern jedoch eine Verlängerung. Der Status wird während Ihrer Arbeit im Back-Office automatisch erneut geprüft: einmal täglich in den ersten 14 Tagen nach Eingabe des Schlüssels, danach einmal pro Woche. Ein Cron-Job ist nicht nötig. Deinstallieren oder Zurücksetzen des Moduls entfernt immer den Lizenzschlüssel und den Lizenzstatus.

Fehlerbehebung

Aramex erscheint nicht an der Kasse: prüfen Sie, ob die Lizenz aktiv und Enable Aramex eingeschaltet ist. Prüfen Sie unter Shipping > Carriers, ob der Versanddienstleister die Zone des Ziellandes des Kunden und die Kundengruppe abdeckt. Prüfen Sie Countries, die Gewichtsgrenzen und Minimum order amount. Prüfen Sie im festen Modus, ob das Land oder * einen Preis hat. Produkte können auf der Produktseite auch auf bestimmte Versanddienstleister beschränkt sein.

Live-Tarife erscheinen nicht: aktivieren Sie Debug log, laden Sie die Kasse neu und sehen Sie sich das Feld Log auf der Modulseite an. Es zeigt den Grund: fehlende API-Zugangsdaten, den Aramex-Fehlercode, fehlende Herkunftsstadt, fehlende Lieferstadt oder Postleitzahl, eine Gewichts- oder Betragsgrenze oder einen Tarif in einer anderen Währung. Mit Aramex live rates, fixed prices if the API fails erhalten Kunden weiterhin den festen Preis, während Sie das Problem beheben.

Fehler ERR75 im Protokoll: Aramex hat die Anmeldung abgelehnt. Prüfen Sie Benutzername, Passwort, Kontonummer, PIN, Entität und Ländercode mit Ihrem Aramex-Kundenbetreuer.

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

Steuer auf den Versand wird doppelt berechnet: Aramex-Summen können bereits MwSt. enthalten. Stellen Sie Tax auf No tax.

Tarife wirken nach einer Änderung veraltet: klicken Sie auf der Modulseite auf Save. Dadurch werden die zwischengespeicherten Aramex-Tarife gelöscht.

Die Seite meldet, dass der Aramex-Versanddienstleister nicht gefunden wurde: der Versanddienstleister wurde unter Shipping > Carriers gelöscht. Setzen Sie das Modul unter Modules > Module Manager zurück, um ihn neu anzulegen.

Deinstallation

Gehen Sie zu Modules > Module Manager, öffnen Sie das Menü neben VibeFox Aramex und wählen Sie Uninstall. Der Lizenzschlüssel, der Lizenzstatus und die zwischengespeicherten Tarife werden immer entfernt. Ist Remove data on uninstall aktiviert, wird der Versanddienstleister gelöscht (Bestellungen behalten ihren Verlauf), und die Einstellungen und das Protokoll werden entfernt. Ist es deaktiviert, wird der Versanddienstleister nur deaktiviert und alle Einstellungen bleiben erhalten. Eine erneute Installation des Moduls aktiviert den gespeicherten Versanddienstleister wieder.

Aramex ist eine Marke ihres jeweiligen Inhabers. Dieses Modul ist nicht mit Aramex verbunden und wird nicht von Aramex unterstützt.