VibeFox Canada Post for WooCommerce — Hilfe

Anforderungen

WordPress: 5.8 oder neuer.

WooCommerce: 5.0 oder neuer, installiert und aktiv. Das Plugin lässt sich ohne WooCommerce nicht aktivieren.

PHP: 8.0 oder neuer.

Canada Post Developer Program (nur für Live-Tarife): Live-Tarife nutzen die Canada Post Rating API. Melden Sie sich auf der Website von Canada Post im Canada Post Developer Program an und kopieren Sie Ihren API-Schlüssel und Ihre Kundennummer. Der API-Schlüssel hat die Form Benutzername:Passwort, und Canada Post vergibt getrennte Schlüssel für die Entwicklungsumgebung (Sandbox) und die Produktivumgebung. Außerdem benötigen Sie die kanadische Postleitzahl, von der aus Sie versenden. Wenn Sie nur Festpreise verwenden, brauchen Sie keine API-Schlüssel.

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

Installation

1. Gehen Sie in WordPress zu Plugins > Add New > Upload Plugin, wählen Sie die ZIP-Datei des Plugins und klicken Sie auf Install Now. Sie können auch den Ordner vfd_canada_post per FTP nach /wp-content/plugins/ hochladen.

2. Klicken Sie auf Activate.

3. Öffnen Sie die Einstellungen: WooCommerce > Settings > Shipping > VibeFox Canada Post, oder klicken Sie auf der Seite Plugins unter dem Plugin-Namen auf Settings.

4. Geben Sie Ihren VibeFox-Lizenzschlüssel im Lizenzblock oben auf der Seite ein und klicken Sie auf Activate.

5. Für Live-Tarife geben Sie Benutzername und Passwort der API, Ihre Kundennummer und die Versand-Postleitzahl ein. Wenn die Währung Ihres Shops nicht CAD ist, geben Sie den CAD-Kurs ein. Füllen Sie Country prices aus, wenn Sie Festpreise oder einen Ausweichpreis wünschen (siehe Konfiguration).

6. Fügen Sie VibeFox Canada Post in Ihren Versandzonen unter WooCommerce > Settings > Shipping > Shipping zones hinzu, oder aktivieren Sie Ignore shipping zones und wählen Sie Länder aus.

Konfiguration

Alle Einstellungen befinden sich auf einer Seite: WooCommerce > Settings > Shipping > VibeFox Canada Post. Sie gelten für alle Versandzonen. Wenn Sie die Versandart einer Zone hinzufügen, hat das Zonenfenster nur ein Feld:

Title (zone): der Name, den der Kunde für diese Zone sieht. Leer lassen, um die globale Method title zu verwenden.

Bei jedem Speichern der Einstellungen werden die zwischengespeicherten Canada-Post-Tarife gelöscht. Die Seite zeigt außerdem einen Fehler, wenn die Einstellungen nicht funktionieren können: Nur eines der Felder API-Benutzername und API-Passwort ist ausgefüllt, die Versand-Postleitzahl ist keine kanadische Postleitzahl, der CAD-Kurs fehlt bei einem Shop mit anderer Währung oder es sind weder API-Schlüssel noch Festpreise vorhanden.

Allgemein

Enable/Disable: schaltet die Versandart in allen Zonen gleichzeitig ein oder aus.

Method title: der Name der Versandart, der im Warenkorb und an der Kasse angezeigt wird. Standard: Canada Post. Eine Zone kann einen eigenen Titel verwenden.

Tax status: Taxable fügt die WooCommerce-Steuer auf die Versandkosten hinzu, None nicht.

Canada-Post-API (Live-Tarife)

Mit ausgefülltem API-Benutzernamen und -Passwort stammt der Preis aus der Canada Post Rating API. Liefert die API keinen Tarif (API nicht erreichbar, falsche Postleitzahl, Service nicht verfügbar), wird der Festpreis aus Country prices verwendet, oder die Versandart wird ausgeblendet, wenn es keinen gibt.

API username: der Teil des API-Schlüssels vor dem Doppelpunkt. Verwenden Sie den Entwicklungsschlüssel mit Sandbox und den Produktivschlüssel in einem Live-Shop.

API password: der Teil des API-Schlüssels nach dem Doppelpunkt. Er wird nie ins Protokoll geschrieben.

Customer number: Mit einer Kundennummer liefert Canada Post die kommerziellen (ermäßigten) Tarife Ihres Kontos. Leer lassen für Schalter-Tarife.

Contract number: optional, für Vertragskunden. Wird nur zusammen mit der Kundennummer verwendet.

Sandbox: nutzt die Entwicklungsumgebung von Canada Post zum Testen 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 die Pakete versendet werden, zum Beispiel K1A 0B1. Live-Tarife benötigen sie.

Service in Canada: der Service für kanadische Adressen: Cheapest available, Regular Parcel (Standard), Expedited Parcel, Xpresspost oder Priority.

Service to the USA: Cheapest available (Standard), Expedited Parcel USA, Tracked Packet USA, Small Packet USA Air, Xpresspost USA oder Priority Worldwide parcel USA.

International service: Cheapest available (Standard), International Parcel Surface, International Parcel Air, Tracked Packet International, Small Packet International Surface, Small Packet International Air, Xpresspost International oder Priority Worldwide parcel International.

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

Canadian sales taxes: verwendet die Preise von Canada Post ohne GST/HST/PST. Bei kanadischen Adressen enthält der Preis von Canada Post diese Steuern. Aktivieren Sie dies, wenn WooCommerce die Steuer selbst auf den Versand aufschlägt (Tax status = Taxable), damit die Steuer nicht doppelt berechnet wird.

CAD → store currency rate: der Feldname zeigt Ihre Shop-Währung. Preise von Canada Post sind in CAD. Ist die Währung Ihres Shops nicht CAD, geben Sie ein, wie viele Einheiten Ihrer Währung einem CAD entsprechen, zum Beispiel 0.68. Ohne diesen Wert werden keine Live-Tarife verwendet. Ist die Shop-Währung CAD, lassen Sie das Feld leer. Sowohl Punkt als auch Komma werden als Dezimaltrennzeichen akzeptiert.

Default product weight (kg): wird für jedes Produkt ohne Gewicht an Canada Post übermittelt. Standard: 0.5. Produktgewichte und -abmessungen werden aus den Einheiten Ihres Shops umgerechnet, und der Warenkorb wird als ein einziges Paket berechnet.

Festpreise (werden ohne API-Zugangsdaten und als Ausweichpreis verwendet, wenn die API keinen Tarif liefert)

Country prices: eine Tabelle mit Ländern, einem Preis Base und Preisen nach Warenkorbgewicht in Ihrer Shop-Währung: XS bis 1 kg, S 1–2 kg, M 2–3 kg, L 3–5 kg, XL über 5 kg. Ein leerer oder Nullpreis für eine Größe verwendet den Preis Base. Klicken Sie auf Add country, um eine Zeile hinzuzufügen, und auf das ×, um eine zu entfernen. Die Zeile * Default (all other countries) legt Preise für alle Länder ohne eigene Zeile fest. Ein Land ohne Zeile (und ohne *) hat keinen Festpreis. Ein Basispreis von 0 bedeutet kostenlosen Versand für dieses Land.

Fixed price per: Order berechnet den Preis einmal. Item (price × quantity) multipliziert ihn mit der Anzahl der Artikel im Warenkorb. Dies gilt nur für Festpreise. Live-Tarife werden immer für das gesamte Paket berechnet.

Bedingungen

Min cart weight (kg): blendet die Versandart unterhalb dieses Warenkorbgewichts aus. 0 bedeutet keine Grenze.

Max cart weight (kg): blendet die Versandart oberhalb dieses Warenkorbgewichts aus. Standard: 25. 0 bedeutet keine Grenze. Pakete von Canada Post können bis zu 30 kg wiegen.

Minimum order amount: zeigt die Versandart nur, wenn die Zwischensumme des Warenkorbs diesen Betrag erreicht. Leer lassen, um sie immer anzuzeigen.

Excluded shipping classes: blendet die Versandart aus, wenn ein Artikel im Warenkorb eine dieser WooCommerce-Versandklassen hat.

Free shipping: aktiviert kostenlosen Versand ab dem unten angegebenen Betrag.

Free shipping from: die Zwischensumme des Warenkorbs, ab der der Versand kostenlos ist. In diesem Fall wird keine API-Anfrage gestellt.

Verfügbarkeit ohne Versandzonen

Ignore shipping zones: bietet die Versandart für die unten genannten Länder an, unabhängig davon, welche Zone passt.

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

Erweitert

Debug log: protokolliert Tarifberechnungen unter WooCommerce > Status > Logs, Quelle vfd-canada-post. API-Fehler werden immer protokolliert, auch wenn diese Option ausgeschaltet ist. API-Schlüssel, Kundennummern und Postleitzahlen der Kunden werden nicht protokolliert.

Remove data on uninstall: ist die Option aktiv, entfernt das Löschen des Plugins seine Einstellungen, Zonen-Versandarten und zwischengespeicherte Tarife. Das Deaktivieren des Plugins löscht nie etwas.

So funktioniert es an der Kasse

Wenn der Kunde eine Lieferadresse eingibt, fragt WooCommerce das Plugin nach einem Tarif. Das Plugin prüft zuerst die Bedingungen: Warenkorbgewicht, Mindestbestellwert und ausgeschlossene Versandklassen. Gilt kostenloser Versand, erhält der Kunde einen kostenlosen Tarif, und es wird keine Anfrage an Canada Post gesendet.

Mit API-Schlüsseln übermittelt das Plugin an Canada Post die Versand-Postleitzahl, das Ziel, das Paketgewicht und, wenn alle Produkte Abmessungen haben, die geschätzte Paketgröße. Für Kanada ist das Ziel die Postleitzahl, für die USA der ZIP-Code, für alle übrigen Länder nur das Land. Ein Live-Tarif wird nur angefragt, wenn eine kanadische oder US-Adresse eine gültige Postleitzahl bzw. ZIP-Code hat. Canada Post liefert alle Services für das Paket; das Plugin wählt den gewählten Service der Zielgruppe oder den günstigsten, entfernt die kanadischen Verkaufssteuern, wenn Canadian sales taxes aktiv ist, und rechnet den CAD-Preis mit Ihrem Kurs um. Der Servicename wird mit der Bestellung gespeichert und auf der Bestellseite im Admin als Canada Post service angezeigt.

Jede Antwort wird 1 Stunde zwischengespeichert, damit derselbe Warenkorb und dieselbe Adresse keine neue Anfrage auslösen. Eine fehlgeschlagene Anfrage wird 10 Minuten zwischengespeichert, damit ein Ausfall von Canada Post nicht jede Aktualisierung der Kasse verlangsamt. Das API-Timeout beträgt 10 Sekunden. Pakete über 30 kg werden nicht an die API gesendet.

Liefert die API keinen Tarif, wird der Festpreis verwendet, oder die Versandart wird ausgeblendet, wenn kein Festpreis existiert. Der Kunde sieht nie API-Fehlerdetails; sie landen im WooCommerce-Protokoll.

Die Versandart funktioniert an der klassischen Kasse und mit den Blöcken Warenkorb und Kasse. Sie ist mit WooCommerce High-Performance Order Storage (HPOS) kompatibel.

Das Plugin berechnet nur Tarife. Es erstellt keine Sendungen, druckt keine Etiketten, erstellt keine Manifeste oder Retouren und verfolgt keine Pakete. Kunden können keine Postfiliale oder Abholstation wählen. Es zeigt einen einzigen Canada-Post-Tarif ohne Liefertermine, Versicherung oder Unterschriftsoptionen. Der Warenkorb wird immer als ein Paket berechnet, und Währungskurse werden nicht automatisch aktualisiert.

Lizenzschlüssel

Das Plugin arbeitet mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock befindet sich oben unter WooCommerce > Settings > Shipping > VibeFox Canada Post. Fügen Sie den Schlüssel in License key ein und klicken Sie auf Activate. Der Block zeigt den Status, etwa das Datum, bis zu dem die Lizenz aktiv ist, und Ihre Domain. Mit Check now prüfen Sie den Status erneut, mit Change key geben Sie einen anderen Schlüssel ein und mit Remove key entfernen Sie ihn von dieser Website. Der Link Manage licenses and domains in your account öffnet Ihr vibefox.net-Konto.

Ein Schlüssel gilt für eine Domain. Das Entfernen des Schlüssels von einer Website gibt den Domain-Platz nicht frei. Geben Sie den Platz in Ihrem vibefox.net-Konto frei.

Ohne aktiven Schlüssel wird Canada Post Kunden an der Kasse nicht angezeigt. Angemeldete Shop-Manager sehen es weiterhin, markiert mit (unlicensed — visible to admins only), damit Sie das Plugin vor dem Kauf eines Schlüssels einrichten und testen können. Auf der Seite Plugins und auf WooCommerce-Seiten erscheint eine Erinnerung. Bestehende Bestellungen sind nicht betroffen.

Läuft eine Lizenz ab, arbeitet das Plugin weiter, aber Updates und Support erfordern eine Verlängerung. Der Status wird automatisch im Hintergrund erneut geprüft.

Fehlerbehebung

Canada Post erscheint nicht an der Kasse: Prüfen Sie, ob die Lizenz aktiv ist, Enable/Disable eingeschaltet ist und die Versandart der Zone des Landes des Kunden hinzugefügt ist (oder Ignore shipping zones aktiv ist und das Land erlaubt ist). Prüfen Sie die Gewichtsgrenzen, Minimum order amount und Excluded shipping classes. Es muss ein Tarif existieren: Mit API-Schlüsseln braucht die Adresse eine gültige Postleitzahl (Kanada) oder einen ZIP-Code (USA); andernfalls muss ein Festpreis für das Land oder für * vorhanden sein.

Live-Tarife erscheinen nicht: Aktivieren Sie Debug log, laden Sie die Kasse neu und öffnen Sie WooCommerce > Status > Logs, Quelle vfd-canada-post. Dort steht der Grund: fehlender API-Benutzername oder fehlendes Passwort, eine ungültige Versand- oder Zielpostleitzahl, ein fehlender CAD-Kurs, ein Paket über 30 kg oder die Fehlermeldung von Canada Post. Inzwischen erhalten Kunden den Festpreis, falls vorhanden.

Der Tarif weicht von der Canada-Post-Website ab: Mit einer Kundennummer erhalten Sie die kommerziellen (ermäßigten) Tarife Ihres Kontos; ohne sie die Schalter-Tarife. Bei kanadischen Adressen enthält der Preis von Canada Post GST/HST/PST. Preise werden mit Ihrem CAD-Kurs umgerechnet.

Steuer wird auf den Versand doppelt berechnet: Aktivieren Sie Canadian sales taxes oder setzen Sie Tax status auf None.

Preise auf einem Live-Shop testen: Schalten Sie Sandbox aus und verwenden Sie den Produktions-API-Schlüssel.

Tarife wirken nach einer Änderung veraltet: Speichern Sie die Einstellungsseite. Dadurch werden die zwischengespeicherten Canada-Post-Tarife gelöscht.

Der Lizenzblock zeigt einen Fehler: Folgen Sie der Meldung im Block. Ist der Schlüssel etwa bereits auf einer anderen Domain verwendet, geben Sie einen Platz in Ihrem vibefox.net-Konto frei und klicken Sie auf Check now. Hat sich die Adresse der Website geändert, klicken Sie auf Check now, um den Schlüssel für die neue Domain zu aktivieren. Kann der Lizenzserver nicht erreicht werden, arbeitet das Plugin mit dem zuletzt bekannten Status weiter.

Deinstallation

Das Deaktivieren des Plugins behält alle Daten. Zum Entfernen deaktivieren und löschen Sie es auf der Seite Plugins. Der Lizenzschlüssel und der Lizenzstatus dieses Plugins werden immer entfernt. Einstellungen, Zonen-Versandarten und zwischengespeicherte Tarife werden nur entfernt, wenn Remove data on uninstall aktiv war. Andernfalls bleiben sie für eine spätere Neuinstallation erhalten. Bestellungen werden nie angetastet.

Canada Post ist eine Marke ihres jeweiligen Inhabers. Dieses Plugin ist weder mit Canada Post verbunden noch von Canada Post unterstützt.