VibeFox Purolator 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. Die PHP-SOAP-Erweiterung ist nicht erforderlich.

Purolator E-Ship Web Services (nur für Live-Tarife): Registrieren Sie sich für E-Ship Web Services im Purolator E-Ship Resource Centre auf der Website von Purolator. Purolator stellt getrennte Schlüssel und Passwörter für die Entwicklungs- und die Produktivumgebung bereit. Außerdem benötigen Sie Ihre Purolator-Abrechnungskontonummer und die kanadische Postleitzahl, von der Sie versenden. Wenn Sie nur feste Preise verwenden, brauchen Sie keine API-Schlüssel.

VibeFox-Lizenzschlüssel: Kauf auf vibefox.net. 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. Klicken Sie nach Abschluss des Uploads auf Configure, oder suchen Sie VibeFox Purolator später in der Modulliste und klicken Sie dort 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. Für Live-Tarife füllen Sie den Abschnitt Purolator API (live rates) aus. Zum Testen aktivieren Sie Development environment mit dem Entwicklungsschlüssel. Füllen Sie Country prices oder Fallback price aus, wenn Sie feste Preise oder einen Ausweichpreis möchten (siehe Konfiguration). Klicken Sie auf Save.

Bei der Installation legt das Modul den Versanddienstleister Purolator mit dem Lieferzeittext Purolator courier 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 Purolator > Configure. Jeder Abschnitt hat seine eigene Schaltfläche Save, die die gesamte Seite speichert. Jedes Speichern leert außerdem die zwischengespeicherten Purolator-Tarife.

Wenn Live-Tarife mit den gespeicherten Werten nicht funktionieren können (fehlender Schlüssel, Passwort oder Abrechnungskonto, keine kanadische Versand-Postleitzahl, kein CAD-Kurs) oder weder API-Zugangsdaten noch feste Preise vorhanden sind, erscheint oberhalb der Einstellungen eine Warnung. Eine Warnung erscheint auch, wenn die Gewichtseinheit des Shops nicht eine ist, die das Modul kennt (kg, g, lb, oz und ähnliche). Dann werden Produktgewichte als kg behandelt. Legen Sie die Gewichtseinheit unter International > Localization (Local units) fest.

Ein Zahlenfeld, das keine Zahl von 0 oder mehr enthält, wird nicht gespeichert. Eine Warnung nennt das Feld und den Wert. Das Feld bleibt leer oder erhält bei den Gewichtsfeldern seinen Standardwert. Ein falscher Wert in Country prices wird als 0 gespeichert, und die Warnung nennt das Land und die Spalte. Ist Min cart weight größer als Max cart weight, wird nichts gespeichert und ein Fehler angezeigt.

Allgemein

Enable Purolator: 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 auf der Kasse angezeigt wird. Standard: Purolator. Pflichtfeld, höchstens 64 Zeichen.

Tax: die Steuerregel des Versanddienstleisters oder No tax. Sie legt fest, ob der Shop Steuern auf die Versandkosten aufschlägt. Bei kanadischen Adressen enthält die Purolator-Summe bereits GST/HST/PST/QST. Siehe unten Canadian sales taxes.

Purolator-API (Live-Tarife)

Sind API-Schlüssel, Passwort und Abrechnungskonto ausgefüllt, kommt der Preis aus dem Web-Service Purolator E-Ship Estimating. Liefert Purolator keinen Tarif, wird der feste Preis verwendet, oder der Versanddienstleister wird ausgeblendet, wenn es keinen gibt. Der Abschnitt enthält einen Link zum Purolator E-Ship Resource Centre, wo Sie sich registrieren und die Schlüssel erhalten.

API key: Ihr E-Ship-Web-Services-Schlüssel für die gewählte Umgebung. 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 den Schlüssel ändern möchten.

API password: das Passwort zum Schlüssel. Wie der Schlüssel wird es nach dem Speichern nicht erneut angezeigt.

Billing account number: Ihre Purolator-Kontonummer. Die Schätzungen verwenden die Tarife dieses Kontos. Die Entwicklungsumgebung akzeptiert das Testkonto aus der Purolator-Dokumentation. Wenn Sie dieses Feld leeren, werden auch der gespeicherte API-Schlüssel und das Passwort entfernt.

Development environment: nutzt die Entwicklungsumgebung von Purolator (devwebservices.purolator.com) mit dem Entwicklungsschlüssel. Die Preise sind Testdaten. Schalten Sie sie in einem Live-Shop aus.

Ship-from postal code: die kanadische Postleitzahl, von der aus die Pakete versendet werden, zum Beispiel L4W 5M8.

Service in Canada: Cheapest available (Standard), Purolator Ground, Purolator Ground 9AM, Purolator Ground 10:30AM, Purolator Ground Evening, Purolator Express, Purolator Express 9AM, Purolator Express 10:30AM, Purolator Express 12PM oder Purolator Express Evening.

Service to the USA: Cheapest available (Standard), Purolator Ground U.S., Purolator Express U.S., Purolator Express U.S. 9AM, Purolator Express U.S. 10:30AM oder Purolator Express U.S. 12:00.

International service: Cheapest available (Standard), Purolator Express International, Purolator Express International 9AM, Purolator Express International 10:30AM oder Purolator Express International 12:00.

Wird der gewählte Service für die Adresse nicht angeboten, wird der günstigste verfügbare verwendet.

Canadian sales taxes: verwendet Purolator-Preise ohne GST/HST/PST/QST. Bei kanadischen Adressen enthält die Purolator-Summe diese Steuern. Aktivieren Sie die Option, wenn der Versanddienstleister unter Tax eine Steuerregel hat, damit die Steuer nicht doppelt berechnet wird.

CAD → (shop currency) rate: Purolator-Preise sind in CAD. Wenn die Standardwährung Ihres Shops nicht CAD ist, geben Sie ein, wie viele Einheiten Ihrer Währung einem CAD entsprechen, zum Beispiel 0.68. Ohne diesen Wert werden keine Live-Tarife verwendet. Wenn Ihre Standardwährung CAD ist, lassen Sie das Feld leer.

Default product weight: in kg, für jedes Produkt ohne Gewicht. Standard: 0.5. Gewichte werden aus der Gewichtseinheit des Shops umgerechnet und als Gesamtgewicht in ganzen, aufgerundeten Pfund an Purolator gesendet.

Feste Preise (ohne API-Zugangsdaten und als Ausweichlösung, wenn die API keinen Tarif liefert)

Country prices: ein Preis je Land und Warenkorbgewicht in der Standardwährung Ihres Shops, ohne Steuern. Klicken Sie auf Add country, um eine Zeile hinzuzufügen, und auf das Papierkorbsymbol, um eine zu entfernen. Wählen Sie * Default (all other countries) für eine Zeile, die alle Länder ohne eigene Zeile abdeckt. Jede Zeile hat einen Base-Preis und Größenspalten: XS bis 1 kg, S 1–2 kg, M 2–3 kg, L 3–5 kg und XL über 5 kg. Ein leerer oder auf null stehender Größenpreis verwendet Base. Ein Base von 0 oder ein leeres Base bedeutet kostenlosen Versand für die Gewichte ohne eigenen Größenpreis. Sowohl 9.99 als auch 9,99 werden akzeptiert. Zeilen ohne Preis werden nicht gespeichert, und je Land bleibt nur eine Zeile erhalten.

Fallback price: der Preis für ein Land, das keine Zeile in Country prices und keine *-Zeile hat. Lassen Sie das Feld leer, um den Versanddienstleister für solche Länder auszublenden.

Fixed price per: Order berechnet den Preis einmal. Item (price × quantity) multipliziert ihn mit der Anzahl der Artikel im Warenkorb. Das gilt nur für feste Preise. Live-Tarife werden immer für die gesamte Sendung berechnet.

Bedingungen

Min cart weight: in kg; blendet den Versanddienstleister aus, wenn der Warenkorb weniger wiegt. 0 bedeutet keine Begrenzung.

Max cart weight: in kg; blendet den Versanddienstleister aus, wenn der Warenkorb mehr wiegt. Standard: 30. 0 bedeutet keine Begrenzung.

Minimum order amount: zeigt den Versanddienstleister nur an, wenn die Zwischensumme des Warenkorbs (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 die Lieferung kostenlos ist. Dann wird keine Anfrage an Purolator gesendet. Leer lassen, um nie kostenlosen Versand anzubieten.

Für diese Bedingungen zählen Produkte ohne Gewicht als 0.

Verfügbarkeit ohne Versandzonen

Normalerweise wird der Versanddienstleister in den Versandzonen angeboten, denen er unter Shipping > Carriers zugewiesen ist.

Ignore shipping zones: bietet Purolator für die unten genannten Länder an, unabhängig davon, welche Zone passt. Beim Speichern wird der Versanddienstleister allen Zonen hinzugefügt, und später angelegte Zonen werden ebenfalls hinzugefügt. Wird die Option ausgeschaltet, werden diese Zonen wieder entfernt.

Countries: die Zielländer für diesen Modus. Leer lassen, um alle aktiven Länder des Shops zu verwenden. Dieses Feld wird nur verwendet, wenn Ignore shipping zones eingeschaltet ist.

Erweitert

Debug log: schreibt Tarifberechnungen in logs/vfd_prlr_debug.log.php im Modulordner. Die Datei lässt sich nicht über den Webbrowser öffnen. API-Fehler werden immer protokolliert, auch bei ausgeschaltetem Debug-Protokoll. API-Schlüssel, das Abrechnungskonto und die Postleitzahlen der Kunden werden nicht protokolliert. Schalten Sie das Protokoll nach Abschluss wieder aus.

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 eingeschaltet, löscht die Deinstallation des Moduls die Einstellungen, den Versanddienstleister, die zwischengespeicherten Tarife und die Protokolle. Ist sie ausgeschaltet, bleibt alles für eine erneute Installation erhalten.

So funktioniert es an der Kasse

Im Versandschritt fragt PrestaShop das Modul nach dem Purolator-Preis. Nur physische Produkte zählen: Virtuelle Produkte erhöhen das Gewicht nicht und sind nicht im Bestellwert enthalten. Bevor der Kunde eine Adresse eingibt, wird der Preis für das Land geschätzt, das der Shop für Schätzungen verwendet. Das Modul prüft zuerst die Bedingungen: erlaubte Länder (bei Ignore shipping zones), Warenkorbgewicht und Mindestbestellwert. Gilt kostenloser Versand, beträgt der Preis 0 und es wird keine Anfrage an Purolator gesendet. Dann sucht es einen Preis: zuerst den Live-Tarif von Purolator, dann die Länder-Tabelle, dann den Ausweichpreis. Gibt es keinen Preis, wird der Versanddienstleister ausgeblendet.

Mit API-Zugangsdaten sendet das Modul an Purolator eine Quick-Estimate-Anfrage: Ihr Abrechnungskonto, die Versand-Postleitzahl, Ort, Provinz oder Bundesstaat des Kunden, Land und Postleitzahl sowie das Gesamtgewicht des Warenkorbs in ganzen Pfund. Für Kanada ist eine gültige Postleitzahl nötig, für die USA eine gültige US-Postleitzahl (ZIP-Code); andere Länder werden mit der eingegebenen Postleitzahl gesendet. Die Abmessungen (Volumengewicht) werden nicht übermittelt. Purolator antwortet auf Französisch oder Englisch, je nach Sprache des Kunden. Purolator liefert die Preise aller Services; das Modul nimmt den gewählten oder den günstigsten Service, entfernt die kanadischen Verkaufssteuern, falls eingestellt, und rechnet den Preis aus CAD um. Der Preis wird in der Standardwährung Ihres Shops berechnet und dann in der Warenkorbwährung des Kunden angezeigt.

Jede Antwort wird 1 Stunde lang zwischengespeichert. Eine fehlgeschlagene Anfrage wird 10 Minuten lang zwischengespeichert, damit ein Purolator-Ausfall nicht jede Aktualisierung der Kasse verlangsamt. Das API-Timeout beträgt 10 Sekunden.

Liefert Purolator keinen Tarif (API nicht erreichbar, falsche Zugangsdaten oder Postleitzahl, Service nicht verfügbar, kein CAD-Kurs), sieht der Kunde keine Fehlermeldung. Es wird der feste Preis verwendet, oder der Versanddienstleister wird ausgeblendet, wenn kein fester Preis vorhanden ist. Der Grund wird im 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 Purolator-Sendungen, druckt keine Etiketten, bucht keine Abholungen, bearbeitet keine Rücksendungen und verfolgt keine Pakete. Es verwendet nicht die Full Estimate (Abmessungen, mehrere Teile, Optionen wie Unterschrift oder Gefahrgut), zeigt keine Lieferdaten an, zeigt nicht mehrere Services als getrennte Versanddienstleister und ruft keine Wechselkurse automatisch ab.

Bestellungen

Wird eine Bestellung mit einem Live-Tarif von Purolator aufgegeben, wird der Service mit der Bestellung gespeichert. Spätere Neuberechnungen des Warenkorbs ändern ihn nicht. Auf der Bestellseite im Back Office (Orders > Orders, Bestellung öffnen) zeigt ein Block Purolator den Purolator service (Name und Code) und den Live rate (excl. tax). Bestellungen mit festen Preisen oder kostenlosem Versand haben keinen solchen Block.

Lizenzschlüssel

Das Modul arbeitet mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock License — VibeFox Purolator ist der erste Block auf Modules > Module Manager > VibeFox Purolator > 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-purolator 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 Adresse des Shops 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-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 der Purolator-Versanddienstleister Kunden an der Kasse nicht angezeigt, und es werden keine Tarife angefragt oder berechnet. Der PrestaShop-Shop 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 nicht an der Kasse 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, aber Updates und Support erfordern eine Verlängerung. Der Status wird während der 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 ist nicht nötig. Das Deinstallieren oder Zurücksetzen des Moduls entfernt immer den Lizenzschlüssel und den Lizenzstatus.

Fehlerbehebung

Purolator erscheint nicht auf der Kasse: Prüfen Sie, dass die Lizenz aktiv ist und Enable Purolator eingeschaltet ist. Prüfen Sie unter Shipping > Carriers, dass der Versanddienstleister die Zone des Kundenlandes und die Kundengruppe abdeckt (oder dass Ignore shipping zones eingeschaltet ist und das Land erlaubt ist). Prüfen Sie die Gewichtsgrenzen und Minimum order amount. Liefert Purolator keinen Tarif, wird der Versanddienstleister nur mit einem Länderpreis, einer *-Zeile oder einem Fallback price angezeigt. Produkte können auf der Produktseite auch auf bestimmte Versanddienstleister beschränkt werden.

Live-Tarife erscheinen nicht: Sehen Sie im Feld Log auf der Modulseite nach. API-Fehler stehen dort immer. Schalten Sie das Debug log ein und laden Sie die Kasse neu, um Details zu erhalten. Mit API-Schlüsseln muss die Adresse eine gültige Postleitzahl (Kanada) oder ZIP-Code (USA) haben. Prüfen Sie auch die Warnungen über den Einstellungen.

HTTP 401 im Protokoll: der API-Schlüssel oder das Passwort passt nicht zur gewählten Umgebung. Entwicklungsschlüssel funktionieren nur bei eingeschalteter Development environment, Produktionsschlüssel nur bei ausgeschalteter.

Der Tarif weicht von der Purolator-Website ab: Quick Estimate nutzt die Tarife Ihres Abrechnungskontos und das auf ganze Pfund aufgerundete Gesamtgewicht, ohne Volumengewicht. Bei kanadischen Adressen enthält die Summe Verkaufssteuern; verwenden Sie Canadian sales taxes, wenn der Versanddienstleister eine Steuerregel hat. Preise werden mit Ihrem CAD → (shop currency) rate umgerechnet.

Ein Wert ist nach dem Speichern verschwunden: Lesen Sie die Warnung, die nach Save erscheint. Der Wert war keine Zahl von 0 oder mehr und wurde daher nicht gespeichert. Geben Sie ihn als einfache Zahl erneut ein.

Tarife wirken nach einer Änderung veraltet: Klicken Sie auf der Modulseite auf Save. Das leert die zwischengespeicherten Purolator-Tarife.

Die Seite meldet, dass der Purolator-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 Purolator und wählen Sie Uninstall. Der Lizenzschlüssel und der Lizenzstatus werden immer entfernt. Die zwischengespeicherten Tarife werden immer entfernt. Ist Remove data on uninstall eingeschaltet, wird der Versanddienstleister gelöscht (Bestellungen behalten ihren Verlauf), und die Einstellungen, die gespeicherten Purolator-Services der Bestellungen und das Protokoll werden entfernt. Ist die Option ausgeschaltet, wird der Versanddienstleister nur deaktiviert und alle Einstellungen bleiben erhalten; bereits aufgegebene Bestellungen behalten ihren Purolator-Service. Bei erneuter Installation des Moduls oder einem Reset erhält der Versanddienstleister den Status zurück, den er vorher hatte.

Purolator ist eine Marke ihres jeweiligen Inhabers. Dieses Modul steht in keiner Verbindung zu Purolator und wird nicht von Purolator unterstützt.