VibeFox The Courier Guy 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.

ShipLogic-API-Schlüssel (für Echtzeittarife und Locker): The Courier Guy läuft auf der ShipLogic-Plattform. Erstellen Sie einen API-Schlüssel in Ihrem Kurierportal von The Courier Guy unter Settings > API Keys (Geschäftskonto). Ohne den Schlüssel wird nur die Preistabelle verwendet, und der Locker-Versanddienstleister wird nicht angeboten.

Versand nach Südafrika: Echtzeittarife und Locker gibt es nur für südafrikanische Adressen. Südafrika muss ein aktives Land des Shops sein (International > Locations > Countries).

VibeFox-Lizenzschlüssel: Er 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 VibeFox The Courier Guy später 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 Seite Configure ein und klicken Sie auf Activate (siehe Lizenzschlüssel).

4. Geben Sie den ShipLogic-API key ein. Für Echtzeittarife füllen Sie die Absenderadresse aus (Straße, Ort, Provinz, Postleitzahl) und, falls Ihre Shopwährung nicht ZAR ist, den ZAR conversion rate.

5. Füllen Sie die Preistabelle und/oder die Ausweichkosten aus und klicken Sie auf Save.

6. Für Echtzeit-Kurierpreise klicken Sie im Abschnitt Advanced auf Add South African provinces, wenn die Seite meldet, dass südafrikanische Adressen keine Provinz haben.

Bei der Installation legt das Modul zwei Versanddienstleister an: The Courier Guy (Lieferzeittext The Courier Guy courier delivery to your door) und The Courier Guy locker (Delivery to a TCG locker of your choice). Beide sind aktiv, mit der Zone Südafrika und allen Kundengruppen verknüpft. Zonen, Kundengruppen, Lieferzeit, Logo und Größenlimits können Sie unter Shipping > Carriers ändern. Legen Sie dort keine Preise fest: Der Preis kommt immer vom Modul.

Konfiguration

Alle Einstellungen befinden sich auf der Modulseite: Modules > Module Manager > VibeFox The Courier Guy > Configure. Jeder Abschnitt hat seine eigene Schaltfläche Save, die die gesamte Seite speichert. Jedes Speichern leert die zwischengespeicherten Tarife, Locker und den letzten ShipLogic-Fehler. Warnungen oben auf der Seite zeigen an, wenn Südafrika kein aktives Land ist, der API-Schlüssel fehlt, der ZAR-Umrechnungskurs oder die Absenderadresse fehlt, weder Preistabelle noch Ausweichkosten vorhanden sind, südafrikanische Adressen keine Provinz haben, die Gewichts- oder Maßeinheit des Shops dem Modul unbekannt ist oder die letzte ShipLogic-Anfrage fehlgeschlagen ist (mit Datum und Fehler). Eine ungültige Zahl (zum Beispiel eine negative) wird nicht gespeichert: Die Seite nennt das Feld und behält den vorherigen Wert.

Allgemein

Courier to the door: schaltet den Kurier-Versanddienstleister ein oder aus. Das ist derselbe Schalter wie der Status des Versanddienstleisters unter Shipping > Carriers.

Courier carrier name: der Name des Kurier-Versanddienstleisters im Checkout. Standard: The Courier Guy. Pflichtfeld.

TCG locker: schaltet den Locker-Versanddienstleister ein oder aus. Der Kunde wählt im Checkout einen Locker. Er wird nur für südafrikanische Adressen und nur mit dem ShipLogic-API-Schlüssel angeboten.

Locker carrier name: der Name des Locker-Versanddienstleisters im Checkout. Standard: The Courier Guy locker. Pflichtfeld.

Tax status: die Steuerregel beider Versanddienstleister. Taxable: <tax rule>: Echtzeittarife werden ohne MwSt. übernommen, und PrestaShop fügt die Versandsteuer der gewählten Regel hinzu. None: Echtzeittarife werden inklusive MwSt. übernommen.

ShipLogic-API (Echtzeittarife und Locker)

API key: Ihr ShipLogic-API-Schlüssel aus dem Portal von The Courier Guy. Er wird Kunden nie angezeigt und nie ins Protokoll geschrieben. 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. Setzen Sie den Haken bei Remove the saved API key und speichern Sie, um ihn zu entfernen.

Account ID: optional. Die numerische ShipLogic-Konto-ID, nur wenn Ihr Schlüssel Zugriff auf mehrere Konten hat. Ein Wert, der keine Zahl ist, wird nicht gespeichert.

Echtzeittarife (für südafrikanische Adressen; wenn kein Echtzeittarif verfügbar ist, wird die Preistabelle verwendet)

Price source: Herkunft des Preises.

ZAR conversion rate: ShipLogic rechnet in südafrikanischen Rand (ZAR). Wenn die Standardwährung Ihres Shops nicht ZAR ist, geben Sie an, wie viel 1 ZAR in Ihrer Währung ist, zum Beispiel 0.05. Ohne diesen Wert werden keine Echtzeittarife verwendet und die Preistabelle gilt. Wenn die Währung Ihres Shops ZAR ist, lassen Sie das Feld leer. Der Kurs wird nicht automatisch aktualisiert.

Absenderadresse (für Echtzeittarife) (wo The Courier Guy die Pakete in Südafrika abholt; für Echtzeittarife werden Straße, Ort, Provinz und Postleitzahl benötigt)

Sender company: Ihr Firmenname.

Sender street address: zum Beispiel 12 My Road.

Sender suburb: der Stadtteil der Absenderadresse.

Sender city: der Ort der Absenderadresse.

Sender province: wählen Sie die südafrikanische Provinz aus der Liste.

Sender postal code: die Postleitzahl der Absenderadresse.

Preistabelle (Ihre eigenen Preise in der Standardwährung des Shops, ohne Steuern: wird mit Price table only verwendet, außerhalb Südafrikas und immer wenn kein Echtzeittarif verfügbar ist; Dezimalkomma oder -punkt werden akzeptiert)

Calculation type: gilt nur für die Preistabelle. Ein Echtzeittarif gilt immer für die gesamte Bestellung.

Prices by weight: eine Tabelle mit Ländern, einer Spalte Price und den Gewichtsstufen XS (bis 1 kg), S (bis 2 kg), M (bis 3 kg), L (bis 5 kg) und XL (über 5 kg). Klicken Sie auf Add row, um eine Zeile hinzuzufügen (eine neue Zeile beginnt mit Südafrika), und auf das Papierkorb-Symbol, um eine zu entfernen. Eine leere oder 0er-Stufe verwendet die Spalte Price. Ein Preis von 0 bedeutet kostenloser Versand. Die Zeile * Any country gilt für Länder ohne eigene Zeile und für eine Länderzeile ohne Preis. Ein Preis, der keine Zahl ist, wird geleert, und die Seite listet ihn auf.

Fallback cost: wird verwendet, wenn weder ein Echtzeittarif noch ein Tabellenpreis vorliegt. Lassen Sie das Feld leer, um die Versanddienstleister in diesem Fall auszublenden.

Bedingungen (beide Versanddienstleister)

Min weight (kg): blendet die Versanddienstleister aus, wenn das Warenkorbgewicht darunter liegt. 0 bedeutet kein Limit.

Max weight (kg): blendet die Versanddienstleister aus, wenn das Warenkorbgewicht darüber liegt. Standard: 30. 0 bedeutet kein Limit, leer bedeutet 30 kg. Ist Min weight (kg) größer als Max weight (kg), zeigt die Seite eine Warnung, und beide Limits behalten ihre vorherigen Werte.

Minimum order amount: zeigt die Versanddienstleister erst ab dieser Warenkorb-Zwischensumme an (versandpflichtige Produkte, ohne Steuern, nach Rabatten). Lassen Sie das Feld leer, um sie immer anzuzeigen.

Free shipping from: die Warenkorb-Zwischensumme, ab der der Versand kostenlos ist. Lassen Sie das Feld leer, um nie kostenlosen Versand anzubieten. Wenn die Zwischensumme diesen Wert erreicht, werden die Versanddienstleister mit einem Preis von 0 angezeigt, und es geht keine Anfrage an ShipLogic für den Tarif.

Verfügbarkeit ohne Versandzonen

Normalerweise werden die Versanddienstleister in den Versandzonen angeboten, mit denen sie unter Shipping > Carriers verknüpft sind.

Ignore shipping zones: bietet den Versanddienstleister des unten gewählten Liefertyps für die unten genannten Länder an, auch wenn seine Zonen diese nicht enthalten. Der Versanddienstleister ist mit jeder aktiven Zone verknüpft, auch mit später erstellten Zonen. Wenn Sie die Option wieder ausschalten, erhält er die Zonen zurück, die er vorher hatte.

Delivery type without zones: Courier to the door oder TCG locker (customer chooses a locker). Wird nur mit Ignore shipping zones verwendet.

Countries: die Zielländer für diesen Modus. Leer lassen, um alle Länder zu erlauben. Locker werden nur in Südafrika angeboten.

Erweitert

South African provinces: PrestaShop hat keine südafrikanischen Provinzen, der Echtzeit-Kurierpreis benötigt aber die Provinz der Adresse. Add South African provinces fügt die 9 Provinzen (EC, FS, GP, KZN, LP, MP, NC, NW, WC) als Bundesländer Südafrikas hinzu und zeigt das Feld für das Bundesland bei südafrikanischen Adressen an. Bereits vorhandene Provinzen werden nicht erneut hinzugefügt. Bis dahin wird die Preistabelle verwendet.

Debug log: schreibt Debug-Meldungen in logs/vfd_tcgr_debug.log.php im Modulordner. Die Datei lässt sich nicht über das Web öffnen. API-Fehler werden immer protokolliert, auch wenn diese Option aus ist. Der 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: wenn aktiv, löscht die Deinstallation des Moduls seine Einstellungen und Versanddienstleister. Wenn aus, schaltet die Deinstallation nur die Versanddienstleister aus. Auf Bestellungen gespeicherte Locker bleiben immer erhalten.

So funktioniert es im Checkout

Im Versandschritt fragt PrestaShop das Modul nach dem Preis jedes Versanddienstleisters. Nur physische Produkte zählen: virtuelle Produkte erhöhen weder das Gewicht noch den Bestellbetrag. Das Modul prüft zuerst die Bedingungen: Warenkorbgewicht und Mindestbestellwert. Gilt kostenloser Versand, beträgt der Preis 0.

Courier to the door: das Modul fragt ShipLogic nach dem günstigsten Service von Ihrer Absenderadresse bis zur Adresse des Kunden. Die Adresse braucht Straße, Ort, Provinz und Postleitzahl. Bis dahin wird die Preistabelle verwendet.

TCG locker: der Echtzeittarif ist der günstigste Service von Haus zu Locker zu dem Locker, der dem Ort des Kunden am nächsten liegt. Er wird nicht für den vom Kunden gewählten Locker neu berechnet. Der Locker-Versanddienstleister erscheint nur für südafrikanische Adressen und nur mit dem API-Schlüssel.

Die gesamte Bestellung wird als ein Paket berechnet: das Gesamtgewicht, die größte Länge und Breite sowie die gestapelten Höhen. Produkte ohne Maße zählen als 10-cm-Würfel. Gewichte und Maße werden aus den Einheiten Ihres Shops umgerechnet. Der Randbetrag wird in Ihre Standardwährung umgerechnet und dann in der Warenkorbwährung des Kunden angezeigt.

ShipLogic-Anfragen laufen nach 12 Sekunden ab. Tarife werden 1 Stunde, Locker 6 Stunden und Fehler 10 Minuten zwischengespeichert, damit eine langsame API nicht jede Aktualisierung des Checkouts verlangsamt. Gibt es keinen Echtzeittarif, kommt der Preis aus der Tabelle, danach aus Fallback cost. Trifft keines davon zu, wird der Versanddienstleister ausgeblendet. API-Fehler werden dem Kunden nie angezeigt.

Die Versanddienstleister funktionieren mit den Themes Classic und Hummingbird. Wenn Sie einen 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 bucht keine Sendungen, erstellt keine Frachtbriefe oder Etiketten und aktualisiert die Sendungsverfolgung nicht automatisch. Es gibt keine Locker-Karte: Locker werden aus einer Liste gewählt. Echtzeittarife und Locker gelten nur für Südafrika. Andere Länder erhalten die Preistabelle. Pro Versanddienstleister wird nur ein Tarif angezeigt (die günstigste Servicestufe), ohne Auswahl von Servicestufen, Versicherung oder Extras im Checkout.

Abholstellen

Wenn der Kunde den Locker-Versanddienstleister wählt, erscheint darunter eine Locker-Auswahl. Sie listet die Locker auf, die ShipLogic für den Ort der Lieferadresse liefert, den nächsten zuerst. Der Kunde kann eine andere Stadt, einen Stadtteil oder eine Postleitzahl eingeben und auf Search klicken. Ein Locker muss gewählt werden, bevor der Kunde weitermachen kann: Andernfalls zeigt der Versandschritt Please choose a The Courier Guy locker. an.

Der Locker wird auf dem Server erneut gegen die Liste von ShipLogic geprüft, auch bei der Bestellung. Name und Anbieter stammen von ShipLogic, nie aus dem Browser. Die Auswahl wird für den Warenkorb gespeichert und zurückgesetzt, wenn sich die Lieferadresse ändert.

Ist ShipLogic nicht erreichbar, zeigt die Auswahl an, dass die Locker nicht geladen werden können und der Shop sich wegen des Lockers beim Kunden meldet. Die Bestellung kann dann ohne Locker aufgegeben werden. Sie wird auf der Bestellseite im Admin-Bereich markiert: Not chosen - ShipLogic was unavailable at checkout. Agree the locker with the customer.

Bestellungen

Der gewählte Locker (Name, ID und Anbieter) wird mit der Bestellung gespeichert. Er wird im Block The Courier Guy der Bestellseite im Admin-Bereich, auf der Bestätigungsseite, in den Bestelldetails des Kunden und in der Bestellbestätigungs-E-Mail angezeigt. Die E-Mail über neue Bestellungen des Shops (Modul Mail alerts) zeigt ebenfalls die Locker-ID oder dass kein Locker gewählt wurde, weil ShipLogic nicht verfügbar war.

Tracking-Referenz von The Courier Guy: Buchen Sie das Paket in Ihrem Portal von The Courier Guy und tragen Sie die Referenz als Sendungsnummer im Block Shipping der Bestellung ein (Edit). Der Block The Courier Guy zeigt sie an. Der Kunde sieht sie in den Bestelldetails und erhält die E-Mail „unterwegs“ von PrestaShop.

Lizenzschlüssel

Das Modul arbeitet mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock License — VibeFox The Courier Guy ist der erste Block auf Modules > Module Manager > VibeFox The Courier Guy > Configure, oberhalb der Einstellungen. Fügen Sie den Schlüssel in das Feld 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 aktiv 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-the-courier-guy 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 letzten 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 keiner der beiden Versanddienstleister von The Courier Guy (courier to the door oder TCG locker) Kunden im Checkout angezeigt, und es wird kein Tarif berechnet. Der PrestaShop-Storefront weiß nicht, dass Sie im Back-Office angemeldet sind, daher werden die Versanddienstleister auch für Sie ausgeblendet: Sie können das Modul vor dem Kauf eines Schlüssels einrichten, aber nicht im Checkout 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 für Updates und Support ist eine Verlängerung nötig. Der Status wird während Ihrer Arbeit im Back-Office automatisch erneut geprüft: einmal täglich in den ersten 14 Tagen nach der Eingabe des Schlüssels, danach einmal pro Woche. Ein Cron-Job wird nicht benötigt. Die Deinstallation des Moduls entfernt immer den Lizenzschlüssel und den Lizenzstatus. Reset dieses Moduls löscht keine Daten, daher bleiben der Schlüssel und der Status erhalten.

Fehlerbehebung

The Courier Guy erscheint nicht im Checkout: prüfen Sie, ob die Lizenz aktiv ist und der Versanddienstleister eingeschaltet ist (Courier to the door oder TCG locker). Prüfen Sie unter Shipping > Carriers, ob der Versanddienstleister die Zone des Landes des Kunden und dessen Kundengruppe abdeckt (oder ob Ignore shipping zones aktiviert und das Land erlaubt ist). Prüfen Sie die Gewichtslimits und den Minimum order amount. Prüfen Sie, dass die Tabelle oder die Fallback cost einen Preis hat. Der Locker-Versanddienstleister erscheint nur für südafrikanische Adressen und mit dem API-Schlüssel. Außerdem können Produkte auf der Produktseite auf bestimmte Versanddienstleister beschränkt sein.

Kunden sehen keine Locker-Liste: Locker benötigen den API-Schlüssel, den eingeschalteten Versanddienstleister TCG locker und eine südafrikanische Lieferadresse. Die Einstellungsseite zeigt den letzten ShipLogic-Fehler an, falls vorhanden, zum Beispiel einen abgelehnten Schlüssel.

Der Preis ist immer der Tabellenpreis: prüfen Sie die Warnungen auf der Einstellungsseite. Ein Echtzeittarif benötigt den API-Schlüssel, die vollständige Absenderadresse und bei Shops mit einer anderen Währung als Rand den ZAR-Umrechnungskurs. Für die Lieferung an die Haustür braucht die Kundenadresse Straße, Ort, Provinz und Postleitzahl: Fügen Sie die südafrikanischen Provinzen im Abschnitt Advanced hinzu. Für Locker muss ShipLogic einen Locker nahe dem Ort des Kunden finden. Aktivieren Sie das Debug log, laden Sie den Checkout neu und sehen Sie im Feld Log auf der Modulseite nach.

ShipLogic ist nicht erreichbar: Es wird der Tabellen- oder Ausweichpreis angezeigt. Bestellungen mit Locker können ohne Locker aufgegeben werden und werden an der Bestellung markiert.

Tarife wirken nach einer Änderung veraltet: Klicken Sie auf der Modulseite auf Save. Dadurch werden die zwischengespeicherten Tarife und Locker geleert.

Die Seite meldet, dass ein Versanddienstleister von The Courier Guy 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. Das Zurücksetzen behält Ihre Einstellungen und den Ein-/Aus-Status der vorhandenen Versanddienstleister.

Deinstallation

Gehen Sie zu Modules > Module Manager, öffnen Sie das Menü neben VibeFox The Courier Guy und wählen Sie Uninstall. Der Lizenzschlüssel und der Lizenzstatus werden immer entfernt. Die zwischengespeicherten Tarife und Locker sowie der letzte ShipLogic-Fehler werden immer entfernt. Ist Remove data on uninstall aktiv, werden die Versanddienstleister gelöscht (Bestellungen behalten ihren Verlauf), und die Einstellungen, das Protokoll und die Locker von Warenkörben ohne Bestellung werden entfernt. Ist es aus, werden die Versanddienstleister nur ausgeschaltet und alle Einstellungen bleiben erhalten. Wenn Sie das Modul erneut installieren, erhalten die Versanddienstleister den Status zurück, den sie hatten. Auf Bestellungen gespeicherte Locker werden nie entfernt.

The Courier Guy und ShipLogic sind Marken ihrer jeweiligen Eigentümer. Dieses Modul ist weder mit The Courier Guy noch mit ShipLogic verbunden und wird von keinem der beiden unterstützt.