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

Budbee-API-Zugangsdaten (nur für die Auswahl der Paketbox): ein API-Schlüssel und ein API-Secret. Instabee stellt sie Händlern mit einer Liefervereinbarung aus. Fragen Sie Ihren Instabee-Ansprechpartner oder nutzen Sie das Händlerportal von Instabee. Die API-Dokumentation finden Sie auf developer.budbee.com. Ohne Zugangsdaten funktioniert der Versanddienstleister weiterhin mit festen Preisen, Kunden können jedoch keine Paketbox wählen.

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 aus.

2. Klicken Sie nach Abschluss des Uploads auf Configure oder suchen Sie VibeFox Instabee später in der Modulliste und klicken Sie auf Configure.

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

4. Füllen Sie den Bereich Prices aus und tragen Sie für den Paketbox-Auswahldialog Ihren Budbee-API key und Ihr API secret ein (siehe Konfiguration). Klicken Sie auf Save.

Bei der Installation legt das Modul den Versanddienstleister Instabee parcel box mit dem Liefertext Delivery to an Instabee parcel box an. Der Versanddienstleister wird allen Kundengruppen sowie den Zonen für Schweden, Finnland, Dänemark, die Niederlande und Belgien zugewiesen. Zonen, Kundengruppen, Lieferzeit und Logo 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 Instabee > Configure. Jeder Bereich hat eine eigene Schaltfläche Save, die die gesamte Seite speichert.

Warnungen über den Einstellungen zeigen an, wenn nur eine der beiden API-Zugangsdaten eingetragen ist, wenn keine Zugangsdaten vorhanden sind, wenn keine Länderpreise und kein Ausweichpreis hinterlegt sind, wenn die letzte Budbee-API-Anfrage fehlgeschlagen ist (mit Datum, Uhrzeit und Grund), wenn der Instabee-Versanddienstleister nicht gefunden wurde und wenn die Gewichtseinheit des Shops nicht erkannt wird (stellen Sie kg, g, lb oder oz unter International > Localization, Local units ein). Bei jedem Speichern der Einstellungen werden die zwischengespeicherten Paketbox-Listen und der letzte API-Fehler gelöscht. Ist der Methodenname oder der Steuerstatus ungültig oder ist Min weight (kg) größer als Max weight (kg), wird nichts gespeichert und ein Fehler angezeigt.

General

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

Method name: der Name des Versanddienstleisters, den der Kunde an der Kasse sieht. Standard: Instabee parcel box. Pflichtfeld, höchstens 64 Zeichen.

Tax status: None bedeutet, dass die unten stehenden Preise endgültig sind. Taxable mit einer Steuerregel bedeutet, dass PrestaShop die Versandsteuer dieser Regel auf die unten stehenden Preise aufschlägt.

Paketbox-Auswahl (Budbee-API)

Mit Zugangsdaten wählt der Kunde an der Kasse eine Paketbox in der Nähe seiner Postleitzahl, und die Box wird in der Bestellung gespeichert. Beide Felder werden benötigt. Die Auswahl bleibt ausgeschaltet, bis beide ausgefüllt sind.

API key: Ihr Budbee-API-Schlüssel (der HTTP-Basic-Benutzername).

API secret: Ihr Budbee-API-Secret (das HTTP-Basic-Passwort). Es wird nie im Protokoll gespeichert.

Nach dem Speichern bleiben beide Felder leer und zeigen Saved - leave empty to keep it. Geben Sie nur dann einen neuen Wert ein, wenn Sie ihn ändern möchten. Um die gespeicherten Zugangsdaten zu löschen, setzen Sie den Haken bei Remove the saved API key and secret und speichern Sie. Ist nichts gespeichert, zeigt die Seite No credentials saved.

Test environment: nutzt die Budbee-Staging-API (api.staging.budbee.com). Aktivieren Sie sie nur mit Staging-Zugangsdaten von Instabee. Live-Shops lassen sie deaktiviert (api.budbee.com). Standard: deaktiviert.

Preise (der Abschnittstitel zeigt die Standardwährung Ihres Shops)

Alle Preise gelten in der Standardwährung des Shops, ohne Steuern. Ein Dezimalkomma und ein Dezimalpunkt werden beide akzeptiert (49,90 = 49.90). Dem Kunden wird der Preis in der Warenkorbwährung angezeigt.

Calculation type: wie der Preis angewendet wird.

Country prices: eine Tabelle mit den Spalten Country, Price, XS ≤1 kg, S ≤2 kg, M ≤3 kg, L ≤5 kg und XL >5 kg. Klicken Sie auf Add country, um eine Zeile hinzuzufügen, und auf das Papierkorb-Symbol, um eine zu entfernen. Wählen Sie * Any other country für eine Zeile, die für alle Länder ohne eigene Zeile gilt. Eine leere oder 0-Stufe verwendet die Spalte Price. Ein Price von 0 bedeutet kostenlose Lieferung. Hat die Zeile des Landes für das Warenkorbgewicht keinen Preis, wird die Zeile * verwendet, danach der Fallback cost. Ein Preis, der keine Zahl ist, wird geleert, und eine Warnung listet ihn auf. Gewichte werden von Ihrer Gewichtseinheit im Shop in kg umgerechnet.

Fallback cost: wird verwendet, wenn weder die Zeile des Ziellandes noch die Zeile * einen Preis liefert. Lassen Sie das Feld leer, um den Versanddienstleister für solche Länder auszublenden.

Bedingungen

Min weight (kg): blendet den Versanddienstleister unterhalb dieses Warenkorbgewichts aus. Standard: 0 (keine Grenze).

Max weight (kg): blendet den Versanddienstleister oberhalb dieses Warenkorbgewichts aus. Paketboxen nehmen bis zu etwa 20 kg auf. Standard: 20. 0 bedeutet keine Grenze. Der Wert darf nicht niedriger sein als Min weight (kg).

Minimum order amount: zeigt den Versanddienstleister nur an, wenn die Zwischensumme des Warenkorbs (versandpflichtige Produkte, nach Rabatten, vor Steuern) diesen Betrag erreicht. Leer lassen, um ihn immer anzuzeigen.

Free shipping from: die Zwischensumme des Warenkorbs (nach Rabatten, vor Steuern), ab der der Versanddienstleister kostenlos ist. Leer lassen, damit er nie kostenlos ist.

Ist ein Wert in diesen Feldern oder im Feld Fallback cost keine Zahl, wird er nicht gespeichert, der bisherige Wert bleibt erhalten und eine Warnung nennt das Feld.

Verfügbarkeit ohne Versandzonen

Normalerweise wird der Versanddienstleister in den Versandzonen angeboten, mit denen er unter Shipping > Carriers verknüpft ist. Alternativ können Sie ihn hier für eine Länderliste aktivieren.

Ignore shipping zones: bietet den Versanddienstleister in den unten genannten Ländern an, auch wenn seine Zonen diese nicht enthalten. Der Versanddienstleister wird mit jeder aktiven Zone verknüpft, auch mit später angelegten Zonen. Wenn Sie die Option wieder ausschalten, erhält der Versanddienstleister die Zonen zurück, die er vorher hatte.

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

Erweitert

Debug log: schreibt Debug-Meldungen in logs/vfd_ibee_debug.log.php im Modulordner. Die Datei kann nicht über das Web geöffnet werden. API-Fehler werden immer protokolliert, auch wenn diese Option ausgeschaltet ist. API-Schlüssel und Kundendaten werden nie protokolliert.

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: ist die Option aktiv, löscht die Deinstallation des Moduls die Einstellungen und den Versanddienstleister. Ist sie inaktiv, wird bei der Deinstallation nur der Versanddienstleister ausgeschaltet. In Bestellungen gespeicherte Paketboxen bleiben immer erhalten.

So funktioniert es an der Kasse

Im Versandschritt fragt PrestaShop das Modul nach dem Instabee-Preis. Nur physische Produkte zählen: Virtuelle Produkte erhöhen das Gewicht nicht und sind nicht im Bestellwert enthalten. Das Modul prüft die Bedingungen: Warenkorbgewicht und Mindestbestellwert sowie bei Ignore shipping zones die erlaubten Länder. Erreicht die Zwischensumme des Warenkorbs Free shipping from, beträgt der Preis 0. Andernfalls wird der Preis aus der Zeile Country prices des Ziellandes, aus der Zeile * oder aus dem Fallback cost übernommen. Gibt es keinen Preis, wird der Versanddienstleister ausgeblendet.

Wählt der Kunde den Instabee-Versanddienstleister aus und sind die API-Zugangsdaten gesetzt, erscheint unter dem Versanddienstleister für Schweden, Finnland, Dänemark, die Niederlande und Belgien ein Block Parcel box. Er listet die Boxen in der Nähe der Postleitzahl der Lieferadresse auf, sortiert nach Entfernung, mit Name, Adresse und Entfernung. Der Kunde kann eine andere Postleitzahl eingeben und auf Search klicken (oder die Eingabetaste drücken). Solange keine Postleitzahl eingegeben ist, fordert der Block dazu auf. Werden keine Boxen gefunden, wird der Kunde gebeten, eine andere Postleitzahl zu versuchen oder eine andere Versandart zu wählen. Für andere Länder wird der Versanddienstleister ohne Box angeboten.

Eine Paketbox ist Pflicht. Die gewählte Box wird nur dann im Warenkorb gespeichert, wenn sie in der Budbee-Liste für diese Postleitzahl enthalten ist. Klickt der Kunde im Lieferschritt auf Continue, prüft das Modul die Box erneut auf dem Server. Andernfalls sieht der Kunde Please choose an Instabee parcel box. Der Name der Box stammt aus der Budbee-Liste, nicht aus dem Browser. Ändert der Kunde das Lieferland oder die Postleitzahl der Adresse, wird die frühere Auswahl verworfen.

Das Modul sendet an Budbee nur das Zielland und die Postleitzahl, niemals Namen, Adressen, E-Mail-Adressen oder Bestelldaten. Paketbox-Listen werden 12 Stunden je Postleitzahl zwischengespeichert, eine Postleitzahl ohne Boxen 1 Stunde und eine fehlgeschlagene Anfrage 5 Minuten, damit eine langsame oder ausgefallene API nicht jede Aktualisierung der Kasse verlangsamt. Die Kassenseite selbst wartet nie auf Budbee: Die Liste wird im Hintergrund geladen, sobald der Versanddienstleister ausgewählt ist. Das Zeitlimit der API beträgt 10 Sekunden.

Ist die Budbee-API nicht erreichbar, sieht der Kunde Parcel boxes cannot be loaded right now. You can place the order without choosing a box - the shop will assign one. Die Bestellung wird dann markiert, und Sie wählen die Box bei der Buchung der Sendung aus. Eine zuvor gewählte Box, die in diesem Moment nicht geprüft werden kann, bleibt erhalten und wird als nicht verifiziert markiert.

Der Auswahldialog funktioniert mit den Themes Classic und Hummingbird. Wenn Sie den Versanddienstleister unter Shipping > Carriers bearbeiten, nachdem er Bestellungen hat, speichert PrestaShop ihn als neue Version des Versanddienstleisters. Das Modul folgt der neuen Version automatisch.

Das Modul berechnet keine Live-Tarife, bucht keine Sendungen, druckt keine Etiketten, vergibt keine Sendungsnummern oder Tracking-E-Mails, bietet keine Budbee-Home-Lieferzeitfenster an und zeigt keine Karte. Buchen Sie das Paket für die gewählte Box in Ihren Händlerwerkzeugen von Instabee / Budbee.

Abholpunkte

Bei der Erstellung der Bestellung wird die Box noch einmal geprüft und in der Bestellung gespeichert. Ab dann kann der Storefront sie nicht mehr ändern. Die Box wird an diesen Stellen angezeigt:

Bestellseite im Back-Office: ein Block Instabee parcel box mit Boxname, Adresse und Box ID. Konnte die Box an der Kasse nicht geprüft werden, ist sie als not verified (Budbee API was unavailable at checkout) markiert. Wurde keine Box gewählt, weil die API nicht verfügbar war, lautet der Block Not chosen - the Budbee API was unavailable at checkout. Choose the box when you book the shipment.

Bestellbestätigungsseite und Bestelldetails im Kundenkonto: Instabee parcel box: mit Boxname und Adresse.

Bestell-E-Mails: Die Box wird in der Bestellbestätigungs-E-Mail an den Kunden dem Versanddienstleister-Namen hinzugefügt. Die E-Mail über neue Bestellungen an den Shop (aus dem PrestaShop-Modul Mail alerts) zeigt ebenfalls die Box-ID. Wurde keine Box gewählt, weil die API nicht verfügbar war, erwähnt nur die E-Mail an den Shop dies.

Lizenzschlüssel

Das Modul funktioniert mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock License — VibeFox Instabee ist der erste Block auf Modules > Module Manager > VibeFox Instabee > 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 zum erneuten Prüfen des Status, Change key zum Eingeben eines anderen Schlüssels und Remove key zum Entfernen des Schlüssels aus diesem Shop. Darunter stehen die Zeile Product: presta-shipping-instabee 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. Nachdem sich die Shop-Adresse geändert hat 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 aktiven Schlüssel wird der Instabee-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 einrichten, bevor Sie einen Schlüssel kaufen, aber nicht an der Kasse testen. Ein Hinweis erscheint unter Modules > Module Manager auf dem Tab Alerts. Bestehende Bestellungen sind nicht betroffen.

Läuft eine Lizenz ab, arbeitet das Modul weiter, aber Updates und Support erfordern eine Verlängerung. Der Status wird automatisch erneut geprüft, während Sie im Back-Office arbeiten: einmal täglich in den ersten 14 Tagen nach der 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

Instabee erscheint nicht an der Kasse: Prüfen Sie, ob die Lizenz aktiv ist und Enable/Disable eingeschaltet ist. Prüfen Sie unter Shipping > Carriers, ob der Versanddienstleister die Zone des Kundenlandes und die Kundengruppe abdeckt, oder ob Ignore shipping zones eingeschaltet und das Land erlaubt ist. Prüfen Sie, ob für das Land ein Preis hinterlegt ist, oder ob es eine Zeile * oder einen Fallback cost gibt. Prüfen Sie die Gewichtsgrenzen und den Minimum order amount. Eine Warnung über den Einstellungen zeigt an, wenn kein Preis konfiguriert ist. Produkte können auf der Produktseite auch auf bestimmte Versanddienstleister beschränkt sein. Aktivieren Sie das Debug log, um den Grund im Feld Log zu sehen.

Kunden sehen die Liste der Paketboxen nicht: Die Liste erscheint nur, wenn API key und API secret gesetzt sind, für Schweden, Finnland, Dänemark, die Niederlande und Belgien, und sobald eine Postleitzahl eingegeben wurde. Der letzte API-Fehler wird über den Einstellungen angezeigt. Details stehen im Feld Log auf der Modulseite. Aktivieren Sie das Debug log für mehr Details.

HTTP 401 oder 403 im Protokoll: Budbee hat den API-Schlüssel oder das Secret abgelehnt. Prüfen Sie sie und stellen Sie sicher, dass Test environment zu Ihren Zugangsdaten passt (Staging-Zugangsdaten nur mit eingeschalteter Testumgebung).

Keine Boxen für eine Postleitzahl: Budbee bedient diese Postleitzahl nicht. Der Kunde kann eine andere Postleitzahl suchen oder eine andere Versandart wählen.

Der Kunde kann im Lieferschritt nicht weitergehen: Eine Paketbox muss aus der Liste gewählt werden, es sei denn, die Budbee-API ist nicht erreichbar. Eine Box, die nicht in der Liste der gesuchten Postleitzahl steht, wird nicht gespeichert, und der Kunde sieht This parcel box is not in the Budbee list for the postal code. Please choose the parcel box again.

Alte Boxlisten nach einer Änderung: Klicken Sie auf der Modulseite auf Save. Dies löscht die zwischengespeicherten Boxlisten.

Die Seite meldet, dass der Instabee-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. Dasselbe gilt für die Meldung The settings were saved, but the carrier could not be updated. Das Zurücksetzen behält den Status des Versanddienstleisters bei: Ein ausgeschalteter Versanddienstleister bleibt ausgeschaltet.

Deinstallation

Gehen Sie zu Modules > Module Manager, öffnen Sie das Menü neben VibeFox Instabee und wählen Sie Uninstall. Der Lizenzschlüssel und der Lizenzstatus werden immer entfernt. Die zwischengespeicherten Boxlisten werden immer entfernt. Ist Remove data on uninstall aktiv, wird der Versanddienstleister gelöscht (Bestellungen behalten ihren Verlauf), und die Einstellungen, das Protokoll sowie die in Warenkörben gewählten Boxen, aus denen nie Bestellungen wurden, werden entfernt. Ist die Option aus, wird der Versanddienstleister nur ausgeschaltet und alle Einstellungen bleiben erhalten. Wird das Modul erneut installiert, erhält der gespeicherte Versanddienstleister seinen vorherigen Status zurück. In Bestellungen gespeicherte Paketboxen bleiben immer erhalten.

Instabee und Budbee sind Marken ihrer jeweiligen Inhaber. Dieses Modul ist nicht mit Instabee oder Budbee verbunden und wird von ihnen nicht unterstützt.