VibeFox Estafeta for OpenCart — Hilfe

Anforderungen

OpenCart: 3.0.x (getestet mit 3.0.5.0) oder 4.0.2 und neuer (getestet mit 4.1.0.3).

PHP: 8.0 oder neuer mit der cURL-Erweiterung.

DrEnvio-Konto (nur für Live-Tarife): Live-Tarife von Estafeta kommen von DrEnvio, einem Estafeta-Partner in Mexiko. Erstellen Sie ein Konto auf drenvio.com, aktivieren Sie Estafeta, hinterlegen Sie dort Ihre Abholadresse und kopieren Sie den API-Schlüssel aus Ihrem DrEnvio-Panel. Es ist derselbe Schlüssel, den das offizielle DrEnvio-Plugin verwendet. Wenn Sie nur Ihre eigenen Preise nutzen, brauchen Sie kein DrEnvio-Konto.

Produkte: Produkte benötigen ein Gewicht für Live-Tarife.

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

Installation

Der Download ist eine einzige ZIP-Datei mit den Paketen für beide OpenCart-Versionen. Entpacken Sie sie auf Ihrem Computer. Sie enthält README.txt, das Paket für OpenCart 3 vfd_estafeta-oc3-(version).ocmod.zip und das Paket für OpenCart 4 vfd_estafeta.ocmod.zip. Installieren Sie nur das Paket für Ihre OpenCart-Version. Der Lizenzschlüssel ist für beide Versionen gleich.

OpenCart 3

1.Gehen Sie im Admin-Bereich zu Extensions > Installer, klicken Sie auf Upload und wählen Sie die Datei vfd_estafeta-oc3-(version).ocmod.zip. Die Erweiterung fügt keine OCMOD-Modifikationen hinzu, Sie müssen also Extensions > Modifications nicht aktualisieren. Statt des Installers können Sie auch den Inhalt des Ordners upload aus dem Paket in das Stammverzeichnis Ihres Shops kopieren.

2. Gehen Sie zu Extensions > Extensions, wählen Sie den Erweiterungstyp Shipping. Suchen Sie VibeFox Estafeta und klicken Sie auf Install (die grüne +-Schaltfläche).

3. Klicken Sie auf Edit (die Stift-Schaltfläche), um die Einstellungsseite zu öffnen.

4. Geben Sie Ihren VibeFox-Lizenzschlüssel in License key im Lizenzblock oben auf der Seite Edit ein und klicken Sie auf Activate (siehe Lizenzschlüssel).

5. Geben Sie den DrEnvio API key und optional die Origin postcode ein. Wenn Ihre Standardwährung nicht MXN ist, geben Sie den MXN exchange rate ein. Legen Sie einen Länderpreis für MX oder eine Fallback cost fest, wenn die Versandart sichtbar bleiben soll, falls DrEnvio keinen Tarif liefert. Aktivieren Sie Enable/Disable und klicken Sie auf Save.

OpenCart 4

1. Gehen Sie im Admin-Bereich zu Extensions > Installer, klicken Sie auf Upload und wählen Sie die Datei vfd_estafeta.ocmod.zip. Benennen Sie die Datei nicht um: OpenCart 4 entnimmt den Code der Erweiterung dem Dateinamen, und ein umbenanntes Paket funktioniert nicht.

2. Das Paket erscheint auf derselben Seite in der Liste der installierten Erweiterungen. Klicken Sie daneben auf Install (die grüne +-Schaltfläche).

3. Gehen Sie zu Extensions > Extensions und wählen Sie den Erweiterungstyp Shipping. Suchen Sie VibeFox Estafeta, klicken Sie auf Install (die grüne +-Schaltfläche) und dann auf Edit (die Stift-Schaltfläche).

4. Geben Sie den Lizenzschlüssel und die Einstellungen wie in den Schritten 4 und 5 für OpenCart 3 ein. Die Einstellungsseite und ihre Felder sind in beiden Versionen gleich.

Nach der Installation ist die Versandart deaktiviert, bis Sie Enable/Disable aktivieren und speichern. Wenn Sie die Erweiterung nach einer Deinstallation erneut installieren, werden die gespeicherten Estafeta-Einstellungen wieder verwendet.

Konfiguration

Alle Einstellungen befinden sich auf der Seite der Erweiterung: Extensions > Extensions > Shipping > VibeFox Estafeta > Edit. Die Abschnitte stehen links. Eine Schaltfläche Save unten speichert die gesamte Seite, ohne sie neu zu laden. Jedes Speichern leert außerdem die zwischengespeicherten DrEnvio-Tarife. Nur Admin-Benutzer mit der Berechtigung zum Ändern dieser Erweiterung können die Einstellungen speichern.

Oben auf der Seite zeigt die Erweiterung Warnungen an: kein DrEnvio-API-Schlüssel, eine Standardwährung außer MXN ohne Wechselkurs, kein Länderpreis für MX und keine Ersatzgebühr (die Versandart wird dann ausgeblendet, wenn kein Live-Tarif vorliegt, oder ist ohne API-Schlüssel nie sichtbar), oder keine Gewichtsklasse mit der Einheit kg (Produktgewichte werden dann anhand des Einheitennamens ihrer Gewichtsklasse umgerechnet, unbekannte Einheiten werden als kg behandelt; legen Sie eine kg-Klasse unter System > Localisation > Weight Classes an). Zahlenfelder akzeptieren einen Dezimalpunkt oder ein Komma. Beim Speichern wird ein falscher Wert gemeldet und wie bei jedem Feld beschrieben gelöscht oder zurückgesetzt, das Formular zeigt den gespeicherten Wert an, und die übrigen Einstellungen werden trotzdem gespeichert (The other settings were saved.).

Allgemein

Die Versandart wird für die unten genannte Geozone (oder für jede Adresse) angeboten oder für die Länder von Availability without shipping zones.

Enable/Disable: schaltet den Versand mit Estafeta ein oder aus. Standard: aus.

Name: der Name der Versandart, den der Kunde an der Kasse sieht. Standard: Estafeta. Pflichtfeld: 1 bis 64 Zeichen, ohne < > ; = # { }. Ein ungültiger Name wird gemeldet, und der bisherige Name bleibt erhalten.

Tax class: die Steuerklasse, die auf die Versandkosten aufgeschlagen wird, oder No tax (Standard). Ob DrEnvio-Preise die MwSt. (IVA) enthalten, hängt von Ihrem DrEnvio-Konto ab. Wenn sie die IVA bereits enthalten, wählen Sie No tax.

Geo zone: bietet Estafeta nur für Adressen in dieser Geozone an, zum Beispiel eine Geozone „Mexiko“. All zones (Standard) bedeutet keine Einschränkung. Geozonen werden unter System > Localisation > Geo Zones verwaltet. Wird nicht verwendet, wenn Ignore shipping zones aktiviert ist.

Sort order: die Position von Estafeta unter den Versandarten an der Kasse. Eine ganze Zahl.

Live-Tarife (DrEnvio-API)

Der Abschnitt erklärt, wo Sie den Schlüssel finden. Angeboten wird der günstigste Estafeta-Service für die Adresse. Ohne Schlüssel werden die Preise aus Prices without a live rate verwendet.

DrEnvio API key: der API-Schlüssel aus Ihrem DrEnvio-Panel. Nach dem Speichern bleibt das Feld leer und zeigt Saved — leave empty to keep it. an. Geben Sie nur dann einen neuen Wert ein, wenn Sie ihn ändern möchten.

Remove the saved API key: wird nur angezeigt, solange ein Schlüssel gespeichert ist. Aktivieren Sie es und speichern Sie, um den Schlüssel zu löschen. Danach werden nur noch Country prices und die Fallback cost verwendet. Ein im Feld darüber eingegebener Schlüssel ersetzt stattdessen den gespeicherten.

Origin country: der zweistellige Ländercode der Abholadresse. Standard: MX. Wird nur zusammen mit der Origin postcode gesendet. Ein ungültiger Code wird gemeldet und auf MX zurückgesetzt.

Origin postcode: die 5-stellige Postleitzahl der Abholadresse. Leer lassen, um die in Ihrem DrEnvio-Konto gespeicherte Ursprungsadresse zu verwenden. Eine Postleitzahl, die nicht 5 Stellen hat, wird beim Speichern gelöscht und gemeldet.

MXN exchange rate: DrEnvio rechnet in mexikanischen Pesos. Nur nötig, wenn Ihre Standardwährung nicht MXN ist: der Wert von 1 MXN in Ihrer Standardwährung, zum Beispiel 0.05. Ohne ihn werden keine Live-Tarife verwendet. Er muss größer als 0 sein. Wenn die Shopwährung MXN ist, lassen Sie das Feld leer.

Preise ohne Live-Tarif

Werden verwendet, wenn kein API-Schlüssel vorhanden ist oder DrEnvio keinen Estafeta-Tarif liefert (API nicht erreichbar, unbekannte Postleitzahl, noch keine Postleitzahl eingegeben). Die Preise gelten in der Standardwährung Ihres Shops, ohne Steuern.

Country prices: ein Zielland pro Zeile im Format CC:PREIS, zum Beispiel MX:150. Verwenden Sie einen Dezimalpunkt oder ein Komma, ohne Tausendertrennzeichen. Teile in einem anderen Format werden ignoriert und beim Speichern gemeldet.

Fallback cost: der Preis, wenn weder ein Live-Tarif noch ein Länderpreis vorliegt. Leer lassen, um die Versandart auszublenden; 0 bedeutet kostenloser Versand.

Calculation type: Per order (Standard) berechnet den Preis einmal. Per item (price x number of items) multipliziert ihn mit der Anzahl der Artikel im Warenkorb. Das gilt für Country prices und die Fallback cost. Ein Live-Tarif von DrEnvio ist immer der Preis für das gesamte Paket.

Bedingungen

Free shipping from: der Versand ist kostenlos, wenn die Zwischensumme der versandpflichtigen Produkte (nach dem Gutschein, vor Steuern) diesen Betrag erreicht. Dann wird keine Anfrage an DrEnvio gestellt. Leer lassen, um nie kostenlosen Versand zu gewähren.

Minimum subtotal: zeigt die Versandart nur, wenn die Zwischensumme mindestens diesen Betrag erreicht. Leer lassen, um sie immer anzuzeigen.

Min weight (kg): das minimale Warenkorbgewicht, damit die Versandart erscheint. 0 bedeutet keine Begrenzung (Standard).

Max weight (kg): das maximale Warenkorbgewicht. Wird es überschritten, wird die Versandart ausgeblendet. Standard: 30. 0 bedeutet keine Begrenzung.

Ist Min weight größer als Max weight, erscheint beim Speichern ein Fehler und beide Gewichte bleiben unverändert. Produktgewichte werden anhand der Gewichtsklasse jedes Produkts in kg umgerechnet.

Verfügbarkeit ohne Versandzonen

Ignore shipping zones: bietet die Versandart für die unten genannten Länder an, ohne die Geozone zu prüfen. Standard: aus.

Countries: die Zielländer für diesen Modus. Leer lassen für alle Länder. Wird nur verwendet, wenn Ignore shipping zones aktiviert ist.

Erweitert

Debug log: schreibt API-Anfragen und Tarifberechnungen in storage/logs/vfd_est_debug.log.php (bei OpenCart 4 system/storage/logs/vfd_est_debug.log.php). Die Datei ist aus dem Web nicht lesbar. API-Fehler werden immer protokolliert, auch wenn das Protokoll aus ist. Der API-Schlüssel und Kundenadressen werden nie protokolliert. Schalten Sie das Protokoll nach Abschluss der Arbeit aus. Erreicht die Datei 5 MB, wird sie nach vfd_est_debug.old.log.php verschoben und ein neues Protokoll begonnen.

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

Remove data on uninstall: ist die Option eingeschaltet, löscht die Deinstallation der Erweiterung alle ihre Einstellungen und das Protokoll. Ist sie aus (Standard), bleibt alles für eine erneute Installation erhalten. Die gespeicherten Estafeta-Services von Bestellungen bleiben immer erhalten.

Import / Export

Export: Klicken Sie auf Download JSON, um die Einstellungen als JSON-Datei zu speichern. Der API-Schlüssel wird nicht exportiert.

Import: Fügen Sie zuvor exportiertes JSON ein und klicken Sie auf Import, um die Einstellungen wiederherzustellen, zum Beispiel in einem anderen Shop. Die Werte werden wie bei einem normalen Speichern geprüft. Der gespeicherte API-Schlüssel bleibt erhalten.

So funktioniert es an der Kasse

Wenn OpenCart die Versandarten anzeigt, fragt es die Erweiterung nach dem Estafeta-Preis. Ist eine Geo zone gesetzt (und Ignore shipping zones ist aus) und die Adresse liegt außerhalb, wird Estafeta nicht angeboten. Nur Produkte mit Requires Shipping auf Yes zählen: andere Produkte erhöhen das Gewicht nicht und gehen nicht in die Zwischensumme ein. Die Zwischensumme ist der Preis dieser Produkte nach dem Gutscheinabzug und vor Steuern; Geschenkgutscheine, Bonuspunkte und Guthaben im Shop werden nicht berücksichtigt. Danach prüft die Erweiterung die Bedingungen: die Liste Countries (wenn Ignore shipping zones aktiviert ist), das Warenkorbgewicht und die Mindestzwischensumme. Gilt kostenloser Versand, beträgt der Preis 0 und es wird keine Anfrage an DrEnvio gestellt.

Andernfalls sendet die Erweiterung an DrEnvio das Zielland und die Postleitzahl, das Warenkorbgewicht, die Anzahl der Artikel und die Zwischensumme in MXN sowie die Ursprungs-Postleitzahl, falls Sie eine festgelegt haben. Mexikanische Postleitzahlen müssen 5 Stellen haben; bis der Kunde eine Lieferadresse mit einer solchen eingibt, wird keine Anfrage gestellt. DrEnvio liefert Angebote aller Transportunternehmen Ihres Kontos. Die Erweiterung verwendet nur die Angebote von Estafeta, ignoriert Preise von null, wählt das günstigste und rechnet es in Ihre Standardwährung um. Der Preis wird auf die Dezimalstellen dieser Währung gerundet und dem Kunden in seiner Währung mit der Steuer der gewählten Tax class angezeigt.

Jede Antwort wird 1 Stunde lang zwischengespeichert. Eine fehlgeschlagene Anfrage oder eine Strecke ohne Estafeta-Tarif wird 5 Minuten lang gemerkt, damit eine langsame oder defekte API nie jede Aktualisierung des Checkouts ausbremst. Das Zeitlimit der API beträgt 12 Sekunden. In diesen Fällen sieht der Kunde keine Fehlermeldung: Es wird der Länderpreis oder die Ersatzgebühr verwendet, oder die Versandart wird ausgeblendet, wenn keines von beiden gesetzt ist. Der Grund wird im Protokoll festgehalten.

Der Kunde sieht nur den Namen der Versandart und den Preis. Die Erweiterung berechnet nur Tarife. Sie erstellt keine Sendungen, druckt keine Versandetiketten (guías) und verfolgt keine Pakete; erstellen Sie die Sendung in Ihrem DrEnvio- oder Estafeta-Konto. Der Kunde kann keinen bestimmten Estafeta-Service und keine Estafeta-Filiale wählen, und Wechselkurse werden nicht automatisch aktualisiert.

In OpenCart 4 klickt der Kunde im Block der Versandarten auf der Kasse auf Choose und wählt Estafeta im Fenster Shipping method options. Die Versandart funktioniert genauso wie in OpenCart 3.

Bestellungen

Wenn eine Bestellung mit Estafeta aufgegeben wird, speichert die Erweiterung den Tarif, der dem Kunden angezeigt wurde, ohne eine neue Anfrage an DrEnvio. Spätere Änderungen der Bestellung im Admin-Bereich ändern ihn nicht. In OpenCart 4 behält die Kasse eine einzige Bestellung und aktualisiert sie jedes Mal, wenn der Kunde erneut bestätigt, daher wird der gespeicherte Tarif durch den neuesten Tarif der Kasse ersetzt. Wechselt der Kunde zu einer anderen Versandart, wird das Panel für diese Bestellung nicht mehr angezeigt.

Die Bestellseite unter Sales > Orders zeigt einen Bereich Estafeta:

Estafeta service: der Estafeta-Service des DrEnvio-Angebots und seine Lieferzeit. Nur bei Live-Tarifen angezeigt.

Price source: Live DrEnvio rate, Country price (no live rate), Fallback cost (no live rate) oder Free shipping threshold.

Shipping cost: der an der Kasse berechnete Versandpreis in Ihrer Standardwährung, ohne Steuern.

Lizenzschlüssel

Die Erweiterung funktioniert mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock License — VibeFox Estafeta ist der erste Block auf Extensions > Extensions > Shipping > VibeFox Estafeta > Edit, über den 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 zum erneuten Prüfen des Status, Change key zur Eingabe eines anderen Schlüssels und Remove key zum Entfernen des Schlüssels aus diesem Shop. Darunter stehen die Zeile Product: opencart-shipping-estafeta und der Link Manage licenses and domains in your account, der Ihr vibefox.net-Konto öffnet. Nur Admin-Benutzer mit der Berechtigung Modify für die Erweiterung können den Schlüssel ändern. Die Texte des Blocks folgen der Admin-Sprache (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. Nachdem sich die Shop-Adresse geändert hat oder Sie in Ihrem Konto einen Domain-Platz freigegeben haben, klicken Sie auf Check now. Ist der Lizenzserver nicht erreichbar, arbeitet die Erweiterung mit dem zuletzt bekannten Status weiter.

Ein Schlüssel funktioniert auf einer Domain: der Shop-Adresse aus der OpenCart-Konfiguration. 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 aktiven Schlüssel wird Estafeta Kunden an der Kasse nicht angezeigt, und es wird kein Tarif berechnet. Ein Admin-Benutzer, der im Admin-Bereich im selben Browser angemeldet ist, sieht die Versandart im Shop weiterhin, markiert mit (unlicensed — visible to admins only), sodass Sie die Erweiterung einrichten und testen können, bevor Sie einen Schlüssel kaufen. In OpenCart 4 ist diese Vorschau nicht verfügbar: Der Shop erkennt die Admin-Anmeldung nicht, daher ist die Versandart ohne aktiven Schlüssel für alle ausgeblendet. Nachdem Sie die Seite Edit einmal geöffnet haben, erscheint ein Hinweis auf dem Dashboard des Admin-Bereichs. Schließen Sie ihn mit ×, um ihn für 7 Tage auszublenden. Bestehende Bestellungen sind nicht betroffen.

Läuft eine Lizenz ab, arbeitet die Erweiterung weiter, aber Updates und Support erfordern eine Verlängerung. Der Status wird automatisch erneut geprüft, wenn Sie das Dashboard des Admin-Bereichs oder die Seite Edit öffnen: einmal täglich in den ersten 14 Tagen nach Eingabe des Schlüssels, danach einmal pro Woche. Ein Cron-Job ist nicht nötig. Das Deinstallieren der Erweiterung entfernt immer den Lizenzschlüssel und den Lizenzstatus.

Fehlerbehebung

Estafeta erscheint nicht an der Kasse: Prüfen Sie, ob die Lizenz aktiv ist und Enable/Disable eingeschaltet ist. Prüfen Sie Geo zone oder Ignore shipping zones und Countries. Prüfen Sie die Warnungen oben auf der Seite der Erweiterung, die Gewichtsgrenzen und Minimum subtotal. Ohne API-Schlüssel oder wenn DrEnvio keinen Estafeta-Tarif liefert, benötigt die Versandart einen Länderpreis für das Ziel oder eine Ersatzgebühr. Prüfen Sie, ob die Produkte Requires Shipping auf Yes haben.

Live-Tarife erscheinen nicht: Schalten Sie Debug log ein, laden Sie die Kasse neu und sehen Sie sich das Feld Log auf der Seite der Erweiterung an. Es zeigt den Grund: kein API-Schlüssel, kein Wechselkurs für einen Shop, dessen Standardwährung nicht MXN ist, eine fehlende oder ungültige Postleitzahl, ein abgelehnter API-Schlüssel (DrEnvio HTTP 401 oder 403, prüfen Sie den API-Schlüssel), kein Estafeta-Tarif für die Strecke (das Protokoll listet die von DrEnvio gelieferten Transportunternehmen auf) oder ein Tarif in einer anderen Währung als MXN.

Enthält der Preis die IVA? Das hängt von Ihrem DrEnvio-Konto ab. Wenn die DrEnvio-Preise die IVA bereits enthalten, setzen Sie die Tax class auf No tax.

Tarife wirken nach einer Änderung veraltet: Klicken Sie auf der Seite der Erweiterung auf Save. Das leert die zwischengespeicherten DrEnvio-Tarife.

Auf der Bestellseite fehlt der Estafeta-Bereich: Der Bereich wird nur für Bestellungen angezeigt, die mit Estafeta aufgegeben wurden, während die Erweiterung installiert und aktiviert war.

Die Seite meldet „Warning: You do not have permission to modify VibeFox Estafeta!“: Ihre Admin-Benutzergruppe darf die Einstellungen nur ansehen. Geben Sie der Gruppe die Berechtigung zum Ändern für extension/shipping/vfd_estafeta (OpenCart 3) oder extension/vfd_estafeta/shipping/vfd_estafeta (OpenCart 4) unter System > Users > User Groups.

Für Entwickler: Die DrEnvio-API-Adresse kann mit der Einstellung vfd_est_api_url ersetzt werden (für Tests); sie hat kein Feld auf der Einstellungsseite.

Deinstallation

Gehen Sie zu Extensions > Extensions, wählen Sie den Typ Shipping und klicken Sie neben VibeFox Estafeta auf Uninstall (die rote −-Schaltfläche). Lizenzschlüssel und Lizenzstatus dieser Erweiterung werden immer entfernt. OpenCart setzt Enable/Disable, Sort order, Tax class und Geo zone immer zurück. Die zwischengespeicherten Tarife werden immer entfernt. Ist Remove data on uninstall aktiv, werden auch die Estafeta-Einstellungen und das Debug-Protokoll gelöscht. Ist es aus, bleiben die übrigen Einstellungen erhalten und werden bei einer erneuten Installation wieder verwendet. Die gespeicherten Estafeta-Services von Bestellungen bleiben in beiden Fällen erhalten, und Bestellungen behalten ihre Versandart und Kosten.

Um bei OpenCart 4 auch die Dateien der Erweiterung zu entfernen, gehen Sie nach der Deinstallation zu Extensions > Installer, klicken Sie in der Liste der installierten Erweiterungen neben VibeFox Estafeta auf Uninstall (die orangefarbene −-Schaltfläche) und dann auf Delete (die rote Papierkorb-Schaltfläche), um das hochgeladene Paket zu entfernen.

Estafeta und DrEnvio sind Marken ihrer jeweiligen Inhaber. Diese Erweiterung ist nicht mit Estafeta oder DrEnvio verbunden und wird von ihnen nicht unterstützt.