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

Delhivery-API-Token (nur für Live-Tarife): melden Sie sich bei Delhivery One an und öffnen Sie Settings > API setup. Der Delhivery-Hilfeartikel "API token generation" erklärt die Schritte. Beide Links befinden sich auf der Erweiterungsseite. Test-Token funktionieren mit der Staging-Umgebung. Außerdem benötigen Sie die sechsstellige Pincode Ihres Abholorts. Wenn Sie nur Festpreise verwenden, brauchen Sie kein Token.

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

Installation

Der Download ist eine 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_delhivery-oc3-(version).ocmod.zip und das Paket für OpenCart 4 vfd_delhivery.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 zu Extensions > Installer, klicken Sie auf Upload und wählen Sie die Datei vfd_delhivery-oc3-(version).ocmod.zip. Die Erweiterung fügt keine OCMOD-Modifikationen hinzu, daher müssen Sie Extensions > Modifications nicht aktualisieren. Statt des Installers können Sie den Inhalt des Ordners upload dieses Pakets in das Stammverzeichnis Ihres Shops kopieren.

2. Gehen Sie zu Extensions > Extensions und wählen Sie den Erweiterungstyp Shipping. Suchen Sie VibeFox Delhivery 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. Fügen 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 das API-Token und Ihre Absender-Pincode ein, wählen Sie Express oder Surface sowie Pre-paid oder COD. Wenn die Standardwährung Ihres Shops nicht INR ist, geben Sie den Umrechnungskurs ein. Optional tragen Sie Festpreise ein (siehe Konfiguration). Schalten Sie Enable Delhivery ein und klicken Sie auf Save.

OpenCart 4

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

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

3. Gehen Sie zu Extensions > Extensions, wählen Sie den Erweiterungstyp Shipping. Suchen Sie VibeFox Delhivery, 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 Schritt 4 und 5 für OpenCart 3 ein. Die Einstellungsseite und ihre Felder sind in beiden Versionen gleich.

Nach der Installation ist die Versandart ausgeschaltet, bis Sie Enable Delhivery einschalten und speichern. Wenn Sie die Erweiterung nach einer Deinstallation erneut installieren, werden die aufbewahrten Delhivery-Einstellungen wieder verwendet.

Konfiguration

Alle Einstellungen befinden sich auf der Erweiterungsseite: Extensions > Extensions > Shipping > VibeFox Delhivery > Edit. Die Abschnitte stehen links. Eine Save-Schaltfläche speichert die gesamte Seite ohne Neuladen. Jedes Speichern löscht außerdem die zwischengespeicherten Delhivery-Tarife. Beträge akzeptieren "9.99" und "9,99". Ist ein Wert fehlerhaft, wird nichts gespeichert, und die Seite zeigt den Grund an, zum Beispiel Enter a valid method title (without < > ; = # { })., eine Meldung, dass ein Feld eine nicht negative Zahl sein muss, oder Sort order must be a whole number. Nur Admin-Benutzer mit der Berechtigung zum Ändern dieser Erweiterung können die Einstellungen speichern.

Wenn die Standardwährung Ihres Shops nicht INR ist, ein API-Token gespeichert ist und kein Umrechnungskurs festgelegt wurde, erinnert eine Warnung oben auf der Seite daran, dass Live-Tarife erst verwendet werden, wenn Sie den Kurs eingeben. Hat der Shop keine Gewichtsklasse in Kilogramm und ist seine Gewichtseinheit keine Standardeinheit (kg, g, lb oder oz), weist eine Warnung darauf hin, dass Produktgewichte als Kilogramm gelesen werden. Legen Sie unter System > Localisation > Weight Classes eine Standardeinheit fest.

Allgemein

Die Einstellungen gelten für jede Geozone. Sie können die Versandart unter Availability einschränken.

Enable Delhivery: bietet Delhivery an der Kasse an. Standard: aus.

Method title: der Name der Versandart, den der Kunde im Warenkorb und an der Kasse sieht. Standard: Delhivery. Pflichtfeld, höchstens 64 Zeichen, ohne die Zeichen < > ; = # { }.

Tax class: die Steuerklasse der Versandkosten oder No tax (Standard). Mit einer Klasse fügt OpenCart die Steuer auf die Versandkosten auf.

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

Delhivery-API-Konto (nur für Live-Tarife erforderlich)

Environment: Production (track.delhivery.com) (Standard) oder Staging / test account (staging-express.delhivery.com). Verwenden Sie Staging nur mit einem Delhivery-Test-Token.

API token: Ihr Delhivery-API-Token. Es wird nur im Autorisierungs-Header gesendet und nie in Protokollen gespeichert. Nach dem Speichern bleibt das Feld leer und zeigt Saved — leave empty to keep it. Geben Sie einen neuen Wert nur dann ein, wenn Sie ihn ändern möchten.

Remove saved token: aktivieren und speichern, um das gespeicherte Token zu löschen. Danach werden nur noch die Festpreise verwendet.

Origin pincode: die sechsstellige Pincode Ihres Abholorts oder Lagers, zum Beispiel 110001. Hat sie nicht sechs Stellen, werden die Einstellungen mit der Warnung The origin pincode must have 6 digits — live rates are not requested until it is fixed. gespeichert.

Live-Tarife

Ein Live-Tarif wird für indische Ziele mit einer gültigen sechsstelligen Pincode angefragt, und zwar für eine Hinsendung (zugestellt).

Shipping mode: der Delhivery-Abrechnungsmodus für den Tarif: Express (Standard) oder Surface.

Payment type: die an Delhivery gesendete Zahlungsart: Pre-paid (Standard) oder COD (cash on delivery — Delhivery adds its COD charge). Die Erweiterung schaltet sie nicht abhängig von der vom Kunden gewählten Zahlungsmethode um.

Rate amount: Delhivery gibt den Betrag mit und ohne GST zurück.

INR to (store currency) conversion rate: das Feld zeigt die Standardwährung Ihres Shops. Delhivery-Tarife sind in indischen Rupien. Wenn Ihre Standardwährung nicht INR ist, geben Sie an, wie viele Einheiten Ihrer Währung einer Rupie entsprechen, zum Beispiel 0.011. Der Kurs muss größer als 0 sein. Lassen Sie das Feld leer, werden Live-Tarife nicht verwendet und die Festpreise gelten. Bei INR als Standardwährung ist er nicht nötig.

Festpreise (werden verwendet, wenn kein Live-Tarif verfügbar ist)

Festpreise werden verwendet, wenn noch kein Token oder keine Pincode vorliegt, das Ziel außerhalb Indiens liegt, die Pincode nicht bedient wird oder die API einen Fehler zurückgibt. Sie sind in der Standardwährung Ihres Shops, ohne Steuer.

Prices per country: einer pro Zeile im Format COUNTRY_CODE:Preis, zum Beispiel IN:120. Wird vor dem Ersatzpreis geprüft. Zeilen in einem anderen Format werden beim Speichern entfernt, und eine Warnung listet sie auf.

Fallback price: wird verwendet, wenn weder ein Live-Tarif noch ein Länderpreis gilt. Leer lassen, um die Versandart auszublenden (Standard). 0 bedeutet kostenlos.

Fixed price is charged: Per order (Standard) berechnet den Preis einmal. Per item (price × quantity) multipliziert ihn mit der Anzahl der Artikel im Warenkorb. Ein Live-Tarif von Delhivery gilt immer für das gesamte Paketgewicht.

Bedingungen

Free shipping from: die Lieferung ist kostenlos, wenn die Zwischensumme der versandpflichtigen Produkte (nach dem Gutschein, vor Steuern) mindestens diesen Betrag erreicht. Es wird keine Anfrage an Delhivery gesendet. Leer lassen, um es auszuschalten.

Show from subtotal: die Versandart nur anzeigen, wenn diese Zwischensumme mindestens diesen Betrag erreicht. Leer lassen, um sie immer anzuzeigen.

Min weight (kg): das minimale Warenkorbgewicht, ab dem die Versandart angezeigt wird. 0 bedeutet keine Grenze (Standard).

Max weight (kg): die Versandart ausblenden, wenn der Warenkorb schwerer ist. Standard: 30. 0 bedeutet keine Grenze; ein leeres Feld bedeutet 30 kg. Min weight darf nicht größer sein als Max weight: Die Seite zeigt einen Fehler, und nichts wird gespeichert.

Produktgewichte werden anhand ihrer OpenCart-Gewichtsklasse in kg umgerechnet. Der Tarif verwendet das tatsächliche Warenkorbgewicht (die Summe der Produktgewichte) ohne Volumen- oder Kartongewicht.

Verfügbarkeit

Geo zone: Delhivery nur für Adressen in dieser Geozone anbieten. All zones (Standard) bedeutet keine Einschränkung. Geozonen werden unter System > Localisation > Geo Zones verwaltet. Wird nicht geprüft, wenn Ignore zones eingeschaltet ist.

Ignore zones: ist es eingeschaltet, wird die Geozone nicht geprüft, und die Versandart wird für die unten genannten Länder angeboten (alle Länder, wenn die Liste leer ist).

Countries: die Zielländer für diesen Modus. Wird nur verwendet, wenn Ignore zones eingeschaltet ist.

Erweitert

Debug log: schreibt die Tarifberechnungen in storage/logs/vfd_dlv_debug.log.php (unter OpenCart 4 system/storage/logs/vfd_dlv_debug.log.php). Die Datei kann nicht über das Web gelesen werden. API-Fehler werden immer protokolliert, auch wenn dies ausgeschaltet ist. Token und vollständige Kunden-Pincodes werden nie protokolliert. Erreicht die Datei 5 MB, wird sie nach vfd_dlv_debug.old.log.php verschoben und ein neues Protokoll begonnen.

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

Remove data on uninstall: wenn eingeschaltet, löscht die Deinstallation der Erweiterung die Delhivery-Einstellungen, die zwischengespeicherten Tarife und das Protokoll. Wenn ausgeschaltet (Standard), bleiben sie für eine erneute Installation erhalten. Bestelldaten (Modus, Preisquelle, AWB-Nummern) werden nie gelöscht.

Import / Export

Export: klicken Sie auf Download JSON, um die Einstellungen als JSON-Datei zu speichern. Das API-Token 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. Das gespeicherte API-Token wird nicht verändert.

So funktioniert es an der Kasse

Wenn OpenCart die Versandarten anzeigt, fragt es die Erweiterung nach dem Delhivery-Preis. Ist eine Geo zone festgelegt (und Ignore zones ist ausgeschaltet) und liegt die Adresse außerhalb, wird Delhivery nicht angeboten. Nur Produkte mit Requires Shipping auf Yes zählen: andere Produkte erhöhen das Gewicht nicht und sind nicht in der Zwischensumme enthalten. Danach prüft die Erweiterung die Länder (wenn Ignore zones eingeschaltet ist), das Warenkorbgewicht und Show from subtotal. Die Zwischensumme ist der Preis der versandpflichtigen Produkte nach dem Rabatt des Gutscheins und vor Steuern. Geschenkgutscheine, Bonuspunkte und Store-Guthaben werden nicht berücksichtigt. Gilt kostenloser Versand, beträgt der Preis 0, und es wird keine Anfrage an Delhivery gesendet.

Für eine indische Adresse mit einer gültigen sechsstelligen Pincode (die Postleitzahl der Adresse) sendet die Erweiterung an Delhivery die Absender- und Ziel-Pincode, das Warenkorbgewicht in Gramm, den Versandmodus und die Zahlungsart. Der zurückgegebene Betrag wird von INR in Ihre Standardwährung umgerechnet, auf deren Dezimalstellen gerundet und dem Kunden in seiner Währung mit der Steuer der gewählten Tax class angezeigt. Jede Antwort wird 1 Stunde zwischengespeichert. Eine fehlgeschlagene Anfrage wird 10 Minuten zwischengespeichert, damit die Kasse bei jeder Aktualisierung nicht auf Delhivery wartet. Das API-Zeitlimit beträgt 10 Sekunden.

Ohne Live-Tarif wird der Länderpreis oder der Ersatzpreis verwendet. Ist keiner von beiden festgelegt, wird die Versandart ausgeblendet. Der Kunde sieht nie einen API-Fehler. Der Grund wird im Protokoll festgehalten.

Die Erweiterung berechnet Tarife und gibt Kunden einen Sendungsverfolgungslink. Sie erstellt keine Sendungen oder Frachtbriefe, druckt keine Etiketten, beantragt keine Abholungen oder Manifeste, prüft keine Pincode-Bedienbarkeit, schätzt keine Lieferdaten, synchronisiert keine Tracking-Status und kalkuliert keine internationalen Delhivery-Tarife. Außerhalb Indiens werden nur die Festpreise verwendet.

Bei OpenCart 4 klickt der Kunde im Versandart-Block der Kasse auf Choose und wählt im Fenster Shipping method options Delhivery aus. Die Versandart funktioniert genauso wie bei OpenCart 3.

Bestellungen und Sendungsverfolgung

Wenn eine Bestellung mit Delhivery aufgegeben wird, speichert die Erweiterung den Versandmodus und die Preisquelle zusammen mit der Bestellung. Öffnen Sie die Bestellung unter Sales > Orders: Das Feld Delhivery über dem Bestellverlauf zeigt Mode: (Express oder Surface), Price: (Live-Tarif von Delhivery, Festpreis oder Schwelle für kostenlosen Versand) und die Delhivery AWB / tracking number oder Not entered yet.

Bei OpenCart 4 führt die Kasse eine einzige Bestellung und aktualisiert sie jedes Mal, wenn der Kunde erneut bestätigt. Modus und Preisquelle werden mit ihr aktualisiert. Wechselt der Kunde vor der Eingabe einer AWB zu einer anderen Versandart, wird das Feld Delhivery für diese Bestellung nicht mehr angezeigt.

Erstellen Sie die Sendung in Delhivery One und tragen Sie dann ihre AWB im Feld ein und klicken Sie auf Save. Die Seite wird nicht neu geladen. Buchstaben, Ziffern und Bindestriche bleiben erhalten (bis zu 64 Zeichen). Speichern Sie ein leeres Feld, um die AWB zu entfernen. Mit einer AWB zeigt das Feld einen Link Track on delhivery.com. Zum Speichern der AWB benötigen Sie die Berechtigung, Bestellungen zu ändern. Ohne sie ist das Feld nur lesbar.

Ein registrierter Kunde sieht auf der Bestellseite seines Kontos Delhivery tracking: mit der AWB als Link zur Delhivery-Sendungsverfolgungsseite. Wenn Sie einen Bestellverlaufseintrag hinzufügen und den Kunden benachrichtigen, enthält die E-Mail zum Bestellstatus dieselbe Zeile mit dem Link. Die E-Mail zur neuen Bestellung enthält keinen Sendungsverfolgungslink, weil die AWB später eingetragen wird. Das Feld und der Sendungsverfolgungslink funktionieren auch bei älteren Bestellungen, wenn die Erweiterung ausgeschaltet ist.

Lizenzschlüssel

Die Erweiterung arbeitet mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock License — VibeFox Delhivery ist der erste Block auf Extensions > Extensions > Shipping > VibeFox Delhivery > Edit, 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 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-delhivery und der Link Manage licenses and domains in your account, der Ihr vibefox.net-Konto öffnet. Nur Admin-Benutzer mit der Berechtigung zum Ändern dieser 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. 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 die Erweiterung mit dem zuletzt bekannten Status weiter.

Ein Schlüssel funktioniert für eine Domain: die 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 einen aktiven Schlüssel wird Delhivery 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), damit Sie die Erweiterung einrichten und testen können, bevor Sie einen Schlüssel kaufen. Bei OpenCart 4 ist diese Vorschau nicht verfügbar: Der Shop sieht die Admin-Anmeldung nicht, daher wird 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 Admins. Schließen Sie ihn mit ×, um ihn 7 Tage lang 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 Admins 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. Die Deinstallation der Erweiterung entfernt immer den Lizenzschlüssel und den Lizenzstatus.

Fehlerbehebung

Delhivery erscheint nicht an der Kasse: prüfen Sie, ob die Lizenz aktiv ist und Enable Delhivery eingeschaltet ist. Prüfen Sie Geo zone oder Ignore zones und Countries, die Gewichtsgrenzen und Show from subtotal. Ohne Live-Tarif ist ein Länderpreis oder ein Fallback price nötig. Prüfen Sie, ob die Produkte Requires Shipping auf Yes haben.

Live-Tarife erscheinen nicht: prüfen Sie das API-Token, eine gültige Origin pincode und, falls Ihre Standardwährung nicht INR ist, den Umrechnungskurs. Der Kunde muss als Postleitzahl eine gültige sechsstellige indische Pincode eingeben. Schalten Sie das Debug log ein, laden Sie die Kasse neu und sehen Sie im Feld Log auf der Erweiterungsseite nach. Dort steht der Grund, zum Beispiel eine nicht bediente Pincode oder ein HTTP-Fehler von Delhivery.

GST wird doppelt berechnet: der Gesamtbetrag von Delhivery enthält GST bereits. Setzen Sie Rate amount auf Gross amount (excluding GST) oder Tax class auf No tax.

Testen: stellen Sie Environment auf Staging und verwenden Sie ein Delhivery-Test-Token.

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

Die AWB kann nicht gespeichert werden: die Meldung You do not have permission to modify orders. bedeutet, dass Ihre Admin-Benutzergruppe die Berechtigung zum Ändern von sale/order unter System > Users > User Groups benötigt.

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

Für Entwickler: die Erweiterung löst die OpenCart-Ereignisse catalog/vfd_delhivery/api_url und catalog/vfd_delhivery/api_timeout aus, mit denen die API-Adresse und das Zeitlimit geändert werden können.

Deinstallation

Gehen Sie zu Extensions > Extensions, wählen Sie den Typ Shipping und klicken Sie neben VibeFox Delhivery auf Uninstall (die rote −-Schaltfläche). Der Lizenzschlüssel und der Lizenzstatus dieser Erweiterung werden immer entfernt. OpenCart setzt immer Enable Delhivery, Sort order, Tax class und Geo zone zurück. Die zwischengespeicherten Tarife und die Ereignisse der Erweiterung werden immer entfernt. Ist Remove data on uninstall eingeschaltet, werden außerdem die Delhivery-Einstellungen und das Debug-Protokoll gelöscht. Ist es ausgeschaltet, bleiben die übrigen Einstellungen erhalten und werden bei einer erneuten Installation wieder verwendet. Die Delhivery-Daten der Bestellungen (Modus, Preisquelle und AWB-Nummern) werden nie gelöscht. Bestehende Bestellungen behalten ihre Versandart und Kosten.

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

Delhivery ist eine Marke ihres jeweiligen Inhabers. Diese Erweiterung ist nicht mit Delhivery verbunden und wird nicht von Delhivery unterstützt.