VibeFox Australia Post for PrestaShop — Hilfe
Voraussetzungen
PrestaShop: 8.0 bis 9.x.
PHP: 8.0 oder neuer. Das Modul lässt sich auf älteren PHP-Versionen nicht installieren.
Australia-Post-PAC-API-Schlüssel (nur für Live-Tarife): Live-Tarife nutzen die Postage Assessment Calculator (PAC) API von Australia Post. Der Schlüssel ist kostenlos: Registrieren Sie sich im Developer Centre von Australia Post (developers.auspost.com.au) für einen PAC-API-Schlüssel. Die Modulseite verlinkt auf die Registrierungsseite. Sie benötigen außerdem die vierstellige australische Postleitzahl, von der Sie versenden. Wenn Sie nur feste Preise je Land verwenden, brauchen Sie keinen API-Schlüssel.
VibeFox-Lizenzschlüssel: Erwerb auf vibefox.net. Ein Schlüssel funktioniert auf einer 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 später VibeFox Australia Post 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. Wählen Sie die Rate source. Für Live-Tarife geben Sie den PAC-API-Schlüssel, Ihre Versand-Postleitzahl und, falls die Standardwährung Ihres Shops nicht AUD ist, den Umrechnungskurs in AUD ein (siehe Konfiguration). Klicken Sie auf Save.
Bei der Installation erstellt das Modul den Versanddienst Australia Post mit dem Lieferzeittext Australia Post parcel delivery. Der Versanddienst wird allen Zonen und allen Kundengruppen zugewiesen. Zonen, Kundengruppen, Lieferzeit, Logo, Größenbeschränkungen und die Steuerregel 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 Australia Post > Configure. Sie gelten für alle Zonen. Oben auf der Seite werden Name und ID des Versanddienstes unter Shipping > Carriers angezeigt. Jeder Abschnitt hat eine eigene Schaltfläche Save, die die gesamte Seite speichert. Jedes Speichern leert außerdem die zwischengespeicherten Tarife von Australia Post.
Wenn eine Live-Tarifquelle gewählt ist, aber der API-Schlüssel, eine vierstellige Versand-Postleitzahl oder der AUD-Umrechnungskurs fehlt, wird nach dem Speichern eine Warnung angezeigt. Sie zeigt außerdem, was bis zur Behebung geschieht: Der Versanddienst wird an der Kasse ausgeblendet oder im Ausweichmodus werden die festen Länderpreise verwendet.
Zahlenfelder akzeptieren einen Punkt oder ein Komma als Dezimaltrennzeichen. Ein Wert, der keine Zahl oder negativ ist, wird nicht gespeichert: Eine Warnung nennt das Feld, und der bisherige Wert bleibt erhalten. Die Seite warnt außerdem, wenn die Gewichts- oder Abmessungseinheit des Shops (International > Localization) ein Format ist, das das Modul nicht kennt. Produktgewichte werden dann als kg und Abmessungen als cm gelesen.
Allgemein
Enable Australia Post: schaltet den Versanddienst in allen Zonen gleichzeitig aus. Dies ist derselbe Schalter wie der Status des Versanddienstes unter Shipping > Carriers.
Method title: der Name des Versanddienstes, den Kunden an der Kasse sehen. Er ist auch der Name des Versanddienstes unter Shipping > Carriers; wenn Sie den Dienst dort umbenennen, wird dieses Feld aktualisiert. Standard: Australia Post. Höchstens 64 Zeichen: Ein längerer Titel wird abgelehnt und nichts wird gespeichert. Ist das Feld leer oder enthält Zeichen, die PrestaShop in einem Versanddienstnamen nicht erlaubt, erscheint eine Warnung und es wird Australia Post verwendet.
Tax status: wie die Steuer auf die Versandkosten angewendet wird.
Rate source: wie der Preis berechnet wird.
Fehlerdetails gehen ins Protokoll, nie an den Kunden.
Australia Post API (live rates) (für feste Preise nicht nötig)
PAC API key: Ihr kostenloser PAC-API-Schlüssel von Australia Post. Er wird im Header AUTH-KEY an Australia Post gesendet. 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.
Remove the saved API key: einschalten und speichern, um den gespeicherten Schlüssel zu löschen. Danach werden keine Live-Tarife mehr abgerufen.
Ship-from postcode: die vierstellige australische Postleitzahl, von der die Pakete versendet werden, zum Beispiel 2000.
Domestic service: wird für Lieferungen innerhalb Australiens verwendet (bis 22 kg, 105 cm pro Seite): Parcel Post (Standard) oder Express Post.
International service: wird für Lieferungen außerhalb Australiens verwendet (bis 20 kg): International Standard (Standard), International Express oder International Courier.
Remove GST: teilt die inländischen API-Preise durch 1,1. Inländische Preise von Australia Post enthalten 10% GST. Schalten Sie dies ein, wenn PrestaShop die Steuer auf den Versand selbst aufschlägt (Tax status = Taxable mit einer Steuerregel am Versanddienst), damit die GST nicht doppelt berechnet wird. Die internationale Versandgebühr ist GST-frei und wird nie verändert.
AUD → (your currency) rate: Das Etikett zeigt die Standardwährung Ihres Shops. Die Preise von Australia Post sind in AUD. Ist Ihre Standardwährung nicht AUD, geben Sie ein, wie viele Einheiten Ihrer Währung einem AUD entsprechen, zum Beispiel 0.61. Der Kurs muss größer als 0 sein. Ohne ihn werden Live-Tarife nicht verwendet. Ist Ihre Standardwährung AUD, zeigt die Seite an, dass keine Umrechnung nötig ist: Lassen Sie das Feld leer. Sowohl Punkt als auch Komma werden als Dezimaltrennzeichen akzeptiert.
Paket für Live-Tarife
Der Warenkorb wird als ein einziges Paket versendet. Produktgewichte und -abmessungen werden von den Einheiten Ihres Shops in kg und cm umgerechnet. Die folgenden Werte gelten für Produkte ohne Gewicht oder Abmessungen.
Default product weight (kg): wird für jedes Produkt ohne Gewicht verwendet, in der Anfrage an Australia Post und bei der Prüfung von Min cart weight (kg) / Max cart weight (kg). Standard: 1.
Default parcel length (cm): wird verwendet, wenn kein Produkt im Warenkorb Abmessungen hat. Standard: 22.
Default parcel width (cm): wird verwendet, wenn kein Produkt im Warenkorb Abmessungen hat. Standard: 16.
Default parcel height (cm): wird verwendet, wenn kein Produkt im Warenkorb Abmessungen hat. Standard: 8.
Wenn Produkte Abmessungen haben, übernimmt das Paket die größte Länge und Breite unter ihnen, und die Höhe wächst, bis das Paket das Volumen aller Artikel aufnehmen kann.
Feste Preise (für feste Preise und als Ausweichwert für Live-Tarife)
Country prices: eine Tabelle mit zweistelligen Ländercodes (AU, NZ, US und so weiter) und Preisen in der Standardwährung Ihres Shops, ohne Steuern. Klicken Sie auf Add row, um ein Land hinzuzufügen, und auf den Link ×, um eines zu entfernen. Verwenden Sie * für alle übrigen Länder. Ein Land ohne Preis (und ohne Zeile *) erhält keinen festen Tarif, daher wird der Versanddienst dafür ausgeblendet. Zeilen mit ungültigem Ländercode oder ohne Preis werden beim Speichern entfernt. Die Tabelle ist leer, bis Sie Preise hinzufügen.
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 das ganze Paket berechnet.
Bedingungen
Min cart weight (kg): blendet den Versanddienst aus, wenn das Warenkorbgewicht darunter liegt. 0 bedeutet kein Limit.
Max cart weight (kg): blendet den Versanddienst aus, wenn das Warenkorbgewicht darüber liegt. Standard: 22. 0 bedeutet kein Limit, ein leeres Feld bedeutet 22 kg. Pakete von Australia Post: 22 kg im Inland, 20 kg international. Ist Min cart weight (kg) größer als das Maximum, würde der Versanddienst nie angezeigt: Es erscheint eine Warnung, und beide Gewichte behalten ihre bisherigen Werte.
Minimum order amount: zeigt den Versanddienst nur, wenn die Zwischensumme der Produkte (nach Rabatten, ohne Steuern) diesen Betrag in der Standardwährung Ihres Shops erreicht. Lassen Sie das Feld leer, um ihn immer anzuzeigen.
Free shipping: schaltet den kostenlosen Versand ab dem unten angegebenen Betrag ein.
Free shipping from: die Zwischensumme der Produkte (nach Rabatten, ohne Steuern), ab der der Versand kostenlos ist. In diesem Fall wird keine API-Anfrage gestellt. Wird nur verwendet, wenn Free shipping eingeschaltet ist.
Verfügbarkeit ohne Versandzonen
Normalerweise wird der Versanddienst in den Zonen angeboten, die Sie dafür unter Shipping > Carriers ausgewählt haben.
Ignore shipping zones: bietet den Versanddienst für die unten genannten Länder an, unabhängig davon, welche Zone passt. Beim Speichern wird der Versanddienst mit allen Zonen verknüpft, und später erstellte Zonen werden automatisch verknüpft. Schalten Sie die Option aus, erhält der Versanddienst wieder die Zonen, die er vorher hatte.
Countries: die Zielländer für diesen Modus. Lassen Sie das Feld leer, um alle aktiven Länder zuzulassen. Halten Sie Strg (bei einem Mac Cmd) gedrückt und klicken Sie, um mehrere auszuwählen. Wird nur mit Ignore shipping zones verwendet.
Erweitert
Debug log: protokolliert die Tarifberechnungen in modules/vfd_australia_post/logs/vfd_ap.log.php. Die Datei lässt sich nicht über das Web öffnen. API-Fehler werden immer protokolliert. Der API-Schlüssel und die Postleitzahlen der Kunden werden nicht protokolliert. Schalten Sie das Protokoll aus, wenn Sie fertig sind.
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, die zwischengespeicherten Tarife und das Protokoll. Der Versanddienst wird bei der Deinstallation immer entfernt. Bei einer erneuten Installation wird er wiederhergestellt, wenn die Daten erhalten geblieben sind.
So funktioniert es an der Kasse
Im Versandschritt fragt PrestaShop das Modul nach dem Preis von Australia Post. Nur physische Produkte zählen: Virtuelle Produkte erhöhen das Gewicht nicht und sind nicht im Bestellbetrag enthalten. Das Modul prüft zuerst die Bedingungen: die Liste Countries (mit Ignore shipping zones), das Warenkorbgewicht und den Minimum order amount. Gilt kostenloser Versand, beträgt der Preis 0 und es wird keine Anfrage an Australia Post gesendet.
Im Modus mit festen Preisen wird der Preis aus der Tabelle übernommen. In den Live-Modi sendet das Modul an Australia Post das Paketgewicht und bei Lieferungen innerhalb Australiens die Versand- und Zielpostleitzahlen sowie die Paketgröße; bei internationalen Lieferungen das Zielland. Ein inländischer Live-Tarif wird nur angefragt, wenn die Lieferadresse eine vierstellige Postleitzahl hat. Ist das Paket über den Grenzwerten von Australia Post (22 kg oder 105 cm im Inland, 20 kg international), wird keine Anfrage gesendet. Der AUD-Preis wird mit Ihrem Kurs umgerechnet, und die GST wird bei inländischen Preisen entfernt, wenn Remove GST eingeschaltet ist. Der Preis wird in der Standardwährung Ihres Shops berechnet und dann in der Warenkorbwährung des Kunden angezeigt.
Jede erfolgreiche Antwort wird 1 Stunde zwischengespeichert, damit derselbe Warenkorb keine neue Anfrage auslöst. Eine fehlgeschlagene Anfrage wird 10 Minuten zwischengespeichert, damit die Kasse bei jeder Aktualisierung nicht auf Australia Post warten muss. Das API-Timeout beträgt 10 Sekunden. API-Fehler werden dem Kunden nie angezeigt: Der Versanddienst wird ausgeblendet, oder im Ausweichmodus wird der feste Preis verwendet. Der Grund wird im Protokoll festgehalten.
Bearbeiten Sie den Versanddienst unter Shipping > Carriers, nachdem er Bestellungen hat, speichert PrestaShop ihn als neue Version des Versanddienstes. Das Modul folgt der neuen Version automatisch.
Das Modul berechnet nur Tarife. Es erstellt keine Versandetiketten, eParcel- oder MyPost-Business-Sendungen oder Manifeste, verfolgt keine Pakete und ermöglicht Kunden keine Wahl von Paketstationen oder Postfilialen. Der Warenkorb wird immer als ein einziges Paket berechnet. Briefe, Versandtaschen und Vertragstarife (eParcel) sind nicht enthalten.
Lizenzschlüssel
Das Modul arbeitet mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock License — VibeFox Australia Post ist der erste Block unter Modules > Module Manager > VibeFox Australia Post > 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-australia-post 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 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 Versanddienst Australia Post 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 Versanddienst auch für Sie ausgeblendet: Sie können das Modul vor dem Kauf eines Schlüssels einrichten, aber an der Kasse nicht 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, Updates und Support erfordern jedoch eine Verlängerung. Der Status wird während Ihrer Arbeit im Back-Office automatisch erneut geprüft: einmal täglich in den ersten 14 Tagen nach 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
Australia Post erscheint nicht an der Kasse: Prüfen Sie, ob die Lizenz aktiv ist und Enable Australia Post eingeschaltet ist (der Versanddienst ist unter Shipping > Carriers aktiv). Prüfen Sie unter Shipping > Carriers, ob der Versanddienst die Zone des Landes und die Kundengruppe abdeckt (oder ob Ignore shipping zones eingeschaltet ist und das Land unter Countries erlaubt ist). Prüfen Sie die Gewichtsgrenzen des Warenkorbs und den Minimum order amount. Im Modus mit festen Preisen prüfen Sie, ob das Land oder * einen Preis hat. Produkte können auf der Produktseite zudem auf bestimmte Versanddienste beschränkt sein.
Live-Tarife erscheinen nicht: Schalten Sie das Debug log ein, laden Sie die Kasse neu und sehen Sie im Feld Log auf der Modulseite nach. Dort steht der Grund: kein API-Schlüssel oder keine Versand-Postleitzahl, noch keine vierstellige Zielpostleitzahl, ein Paket über den Grenzwerten, kein AUD-Umrechnungskurs oder die Fehlermeldung von Australia Post. Mit Live rates, fixed price if the API gives no rate erhalten Kunden weiterhin den festen Preis, während Sie das Problem beheben.
Mein Shop nutzt nicht AUD: Geben Sie den Umrechnungskurs (wie viele Einheiten Ihrer Standardwährung einem AUD entsprechen) im Feld AUD → (your currency) rate ein. Feste Preise sind immer in Ihrer Standardwährung.
GST wird auf den Versand doppelt berechnet: Inländische Preise von Australia Post enthalten 10% GST. Ist Tax status auf Taxable gesetzt und hat der Versanddienst eine Steuerregel, schalten Sie Remove GST ein oder setzen Sie Tax status auf None.
Auf den Versand wird keine Steuer aufgeschlagen: Bei Tax status = Taxable kommt die Steuer aus der Steuerregel des Versanddienstes. Wählen Sie sie unter Shipping > Carriers aus. Die Modulseite zeigt eine Warnung, solange der Versanddienst keine Steuerregel hat.
Der Preis ist zu hoch oder zu niedrig: Prüfen Sie die Produktgewichte und -abmessungen sowie die Standardwerte unter Paket für Live-Tarife. Bei Item (price × quantity) werden feste Preise mit der Anzahl der Artikel multipliziert.
Tarife wirken nach einer Änderung veraltet: Klicken Sie auf der Modulseite auf Save. Dadurch werden die zwischengespeicherten Tarife von Australia Post geleert.
Die Seite meldet, dass der Versanddienst Australia Post gelöscht wurde: Der Versanddienst wurde unter Shipping > Carriers gelöscht. Klicken Sie auf der Modulseite auf Save, um ihn neu anzulegen, oder setzen Sie das Modul unter Modules > Module Manager zurück.
Deinstallation
Gehen Sie zu Modules > Module Manager, öffnen Sie das Menü neben VibeFox Australia Post und wählen Sie Uninstall. Lizenzschlüssel und Lizenzstatus werden immer entfernt. Der Versanddienst wird immer entfernt (Bestellungen behalten ihren Verlauf), und die zwischengespeicherten Tarife werden geleert. Ist Remove data on uninstall eingeschaltet, werden außerdem die Einstellungen, die Tabelle des Tarif-Caches und das Protokoll gelöscht. Ist die Option ausgeschaltet, bleiben die Einstellungen erhalten, und bei einer erneuten Installation des Moduls wird der Versanddienst mit seinen Zonen, Gruppen und seinem Logo wiederhergestellt.
Australia Post ist eine Marke ihres jeweiligen Inhabers. Dieses Modul ist nicht mit Australia Post verbunden und wird von Australia Post nicht unterstützt.
