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

Shippo-Konto: erstellen Sie ein Shippo-Konto, verbinden oder aktivieren Sie Versanddienstleister (USPS, UPS, FedEx, DHL und andere) und kopieren Sie den API-Token aus Shippo > Settings > Advanced > API. Shippo berechnet Gebühren für gekaufte Etiketten, nicht für Tarifanfragen. Neue Shippo-Konten müssen unter Umständen erst von Shippo verifiziert werden, bevor Live-Tarife zurückgegeben werden. Ohne Token werden nur die Ersatzpreise verwendet.

Produkte: Produkte sollten ein Gewicht und Abmessungen haben. Produkte ohne Abmessungen verwenden die Standardkartongröße.

VibeFox-Lizenzschlüssel: erhältlich 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. Wenn der Upload abgeschlossen ist, klicken Sie auf Configure, oder suchen Sie VibeFox Shippo später in der Modulliste und klicken Sie auf Configure.

3. Geben 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ügen Sie Ihren Shippo-API-Token ein und füllen Sie die Adresse unter Ship from aus. Die Postleitzahl ist für Live-Tarife erforderlich.

5. Wählen Sie die Shippo rate currency (USD, wenn Sie aus den USA versenden) und geben Sie, falls die Standardwährung Ihres Shops abweicht, den Exchange rate ein.

6. Tragen Sie optional Ersatzpreise in der Tabelle nach Land und Gewicht ein und klicken Sie dann auf Save.

Bei der Installation erstellt das Modul den Versanddienstleister Shippo Shipping mit dem Lieferzeittext Shippo carriers (USPS, UPS, FedEx, DHL). Der Versanddienstleister wird allen Zonen und allen Kundengruppen zugewiesen. Sie können Zonen, Kundengruppen, Lieferzeit, Logo und Größenbegrenzungen 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 Shippo > Configure. Jeder Abschnitt hat seine eigene Schaltfläche Save, die die gesamte Seite speichert. Jedes Speichern löscht außerdem die zwischengespeicherten Shippo-Tarife.

Warnungen oben auf der Seite zeigen an, wenn der Versanddienstleister nie angezeigt werden kann oder Live-Tarife nicht verwendet werden können: kein API-Token, keine Postleitzahl oder kein Land des Absenders, ein fehlender Wechselkurs oder eine Gewichts- oder Abmessungseinheit des Shops, die das Modul nicht kennt (kg, g, lb oder oz sowie cm, mm, m oder in unter International > Localization, lokale Einheiten). Ein Hinweis erinnert Sie, wenn ein Test-Token gesetzt ist. Beim Speichern wird ein Wert, der keine Zahl ist, eine negative Zahl oder ein Minimum weight (kg), das größer als Maximum weight (kg) ist, als Fehler gemeldet, und es wird nichts gespeichert, bis Sie ihn korrigieren.

Allgemein

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

Name: der Name des Versanddienstleisters, der dem Kunden an der Kasse angezeigt wird. Standard: Shippo Shipping. Pflichtfeld, maximal 64 Zeichen.

Tax: die Steuerregel des Versanddienstleisters oder No tax. Shippo-Tarife enthalten keine Umsatzsteuer. No tax zeigt sie wie angeboten an, eine Steuerregel fügt dem Versand Steuer gemäß Ihren Steuerregeln hinzu.

Shippo-Konto

API token: Ihr Shippo-API-Token. Verwenden Sie das Live-Token (shippo_live_...) für echte Tarife im Live-Shop oder ein Test-Token (shippo_test_...) für Shippo-Testtarife. Das Token wird nur an Shippo gesendet und nie protokolliert. 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, oder aktivieren Sie das Kontrollkästchen Remove the saved API token, um es zu löschen.

Allowed carriers / services: optional, durch Kommas getrennt. Geben Sie einen Versanddienstleister so ein, wie Shippo ihn benennt (USPS, UPS, FedEx, DHL Express), oder ein Shippo-Servicestufen-Token (usps_priority, ups_ground). Der günstigste erlaubte Tarif wird angezeigt. Lassen Sie das Feld leer, um den günstigsten Tarif eines beliebigen Versanddienstleisters anzuzeigen.

Absenderadresse (die Adresse, von der Ihre Pakete versendet werden; leere Felder werden aus der Shopadresse unter Shop Parameters > Contact > Stores übernommen, wenn sie im selben Land liegt)

Sender name / company: der Name des Absenders. Er wird auch zum Unterzeichnen der Zollerklärung verwendet. Ist er leer, wird der Shopname verwendet.

Street address: die Straße des Absenders.

City: die Stadt des Absenders.

State / province: der zweistellige Bundesstaatscode, zum Beispiel CA oder NY. Manche Versanddienstleister benötigen ihn.

Postal / ZIP code: für Live-Tarife erforderlich.

Country: das Land, aus dem Sie versenden. Standard: Vereinigte Staaten.

Tarife

Parcels: wie der Warenkorb an Shippo gesendet wird.

Default box size: Länge x Breite x Höhe in der Abmessungseinheit Ihres Shops (die im Feldnamen angezeigt wird), zum Beispiel 30 x 20 x 10. Shippo benötigt die Kartongröße. Sie wird verwendet, wenn ein Produkt im Warenkorb keine Abmessungen hat. Lassen Sie das Feld leer, um 30 x 20 x 10 cm zu verwenden. Ein Wert, der nicht gelesen werden kann, wird nach dem Speichern mit einem Hinweis ignoriert.

Shippo rate currency: die Währung, in der Shippo Ihre Versanddienstleister angibt; es ist die Währung des Absenderlandes: USD (USA), CAD (Kanada), GBP (Vereinigtes Königreich), EUR (Eurozone) oder AUD (Australien). Standard: USD. Tarife, die Shippo in der Standardwährung Ihres Shops zurückgibt, werden immer unverändert verwendet.

Exchange rate: der Preis von 1 Einheit der Shippo-Tarifwährung in der Standardwährung Ihres Shops, zum Beispiel 0.92. Nicht nötig, wenn beide Währungen gleich sind. Ohne ihn werden Tarife in der anderen Währung nicht verwendet, und es gelten die Ersatzpreise. Das Modul rechnet Währungen nicht automatisch um.

Ersatzpreise (werden verwendet, wenn kein Live-Tarif verfügbar ist: kein API-Token, Shippo nicht erreichbar, Token abgelehnt oder keine Versanddienstleister-Tarife für die Adresse; Preise in der Standardwährung Ihres Shops, ohne Steuer; lassen Sie beide Felder leer, um den Versanddienstleister in diesem Fall auszublenden)

Country prices: eine Preistabelle nach Land und Warenkorbgewicht. Klicken Sie auf Add country, um eine Zeile hinzuzufügen, und auf das Papierkorb-Symbol, um eine zu entfernen. Die Spalten sind Price und die Gewichtsstufen XS (bis 1 kg), S (bis 2 kg), M (bis 3 kg), L (bis 5 kg) und XL (über 5 kg). Eine leere oder 0-Stufe verwendet die Spalte Price. Die Zeile * Default gilt für Länder ohne eigene Zeile. Eine neue Zeile beginnt als * Default. Eine Zeile, die mit allen leeren Feldern gespeichert wird, berechnet 0, daher löschen Sie Zeilen, die Sie nicht ausfüllen.

Other countries: der Preis für Länder, die nicht in der obigen Tabelle stehen (wenn keine Zeile * Default vorhanden ist). Lassen Sie das Feld leer, um den Versanddienstleister für diese Länder auszublenden.

Bedingungen

Free shipping from: die Warenkorb-Zwischensumme (nach Rabatten, vor Steuer), ab der der Versand kostenlos ist. Dann wird keine Anfrage an Shippo gestellt. Lassen Sie das Feld leer, um es zu deaktivieren.

Minimum subtotal: den Versanddienstleister nur anzeigen, wenn die Warenkorb-Zwischensumme (nach Rabatten, vor Steuer) mindestens diesen Betrag erreicht. Lassen Sie das Feld leer, um ihn immer anzuzeigen.

Minimum weight (kg): das minimale Warenkorbgewicht, um den Versanddienstleister anzuzeigen. 0 bedeutet keine Grenze.

Maximum weight (kg): der Versanddienstleister wird über diesem Warenkorbgewicht ausgeblendet. Standard: 30. 0 bedeutet keine Grenze. Ein leeres Feld wird als 30 gespeichert.

Verfügbarkeit ohne Versandzonen

Normalerweise wird der Versanddienstleister in seinen Versandzonen unter Shipping > Carriers angeboten. Alternativ kann er unabhängig von Zonen nach Land angeboten werden.

Ignore shipping zones: bietet den Versanddienstleister für die unten genannten Länder an, unabhängig davon, ob deren Zone zugewiesen ist. Solange dies aktiviert ist, wird der Versanddienstleister allen Zonen hinzugefügt, auch später erstellten Zonen. Wenn Sie es deaktivieren, werden diese hinzugefügten Zonen wieder entfernt, und der Versanddienstleister behält seine eigenen Zonen.

Countries: die Zielländer für diesen Modus. Lassen Sie das Feld leer, um alle aktiven Länder des Shops zu verwenden. Dieses Feld wird nur verwendet, wenn Ignore shipping zones aktiviert ist.

Erweitert

Debug log: protokolliert Shippo-Anfragen in logs/vfd_shpo_debug.log.php im Modulordner. Die Datei kann nicht über das Web geöffnet werden. API-Fehler werden immer protokolliert, auch wenn diese Option aus ist. Das API-Token und Kundenadressen 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 aktiviert, löscht die Deinstallation des Moduls die Moduleinstellungen, den Versanddienstleister und das Protokoll. Wenn deaktiviert, bleibt alles für eine erneute Installation erhalten. Zwischengespeicherte Tarife werden immer entfernt. Der Versanddienstleister und der Service, die mit Bestellungen gespeichert sind, gehören zur Bestellhistorie und bleiben erhalten.

So funktioniert es an der Kasse

Im Versandschritt fragt PrestaShop das Modul nach dem Shippo-Preis. Nur physische Produkte zählen: Virtuelle Produkte erhöhen das Gewicht nicht und sind nicht in der Zwischensumme enthalten. Das Modul prüft zuerst die Bedingungen: die Länder von Ignore shipping zones, das Warenkorbgewicht und die Mindestzwischensumme. Gilt kostenloser Versand, beträgt der Preis 0 und es wird keine Anfrage an Shippo gesendet.

Anschließend sendet das Modul an Shippo die Absenderadresse, die Adresse des Kunden und das Paket. Für Länder, in denen PrestaShop eine Postleitzahl verlangt, wartet die Anfrage, bis der Kunde sie eingegeben hat. Bei internationalen Sendungen wird eine Zollerklärung mit Artikelnamen, Mengen, Gewichten und Werten hinzugefügt. Shippo gibt die Tarife Ihrer Versanddienstleister zurück, und das Modul verwendet den günstigsten erlaubten Tarif. Der Preis wird in der Standardwährung Ihres Shops berechnet und dann in der Warenkorbwährung des Kunden angezeigt.

Im Modus pro Bestellung werden die Artikel in einem Karton gestapelt: die längste und die mittlere Seite der größten Artikel sowie die kürzesten Seiten aller Einheiten, zusammengezählt. Hat ein Produkt keine Abmessungen, wird für das gesamte Paket die Standardkartongröße verwendet. Im Modus pro Artikel wird jedes Produkt als eigenes Paket bewertet, und der Tarif wird mit seiner Menge multipliziert.

Jede Antwort wird 1 Stunde lang pro Adresse und Paket zwischengespeichert. Antwortet Shippo ohne brauchbaren Tarif, wird die Adresse 10 Minuten lang gemerkt. Nach einer Zeitüberschreitung, einem abgelehnten Token, einem Serverfehler oder einem Ratenlimit pausiert das Modul die Anfragen für 5 Minuten und verwendet die Ersatzpreise. Das Zeitlimit für Anfragen beträgt 10 Sekunden.

Gibt es keinen Live-Tarif, stammt der Preis aus der Ersatztabelle, dann aus Other countries. Trifft nichts davon zu, wird der Versanddienstleister ausgeblendet. Der Kunde sieht nie einen Fehler. Der Grund wird im Debug-Log vermerkt.

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 nur Tarife. Es kauft keine Etiketten, verfolgt keine Pakete, prüft keine Adressen und bietet keine Abhol- oder Abgabestellen, Versicherung, Unterschriftsoptionen oder Retourenetiketten an. Nur der günstigste erlaubte Tarif wird angezeigt, nicht eine Liste aller Services. Es gibt keine Kartonpackung über das oben beschriebene Stapeln hinaus, keinen Tarifaufschlag und keine Bearbeitungsgebühr.

Bestellungen

Wenn eine Bestellung mit einem Live-Tarif von Shippo aufgegeben wird, speichert das Modul den gewählten Carrier / service und bei einem Paket pro Bestellung die Estimated delivery days. Sie erscheinen im Block Shippo auf der Bestellseite im Back Office, damit Sie das passende Etikett in Shippo kaufen können. Die Daten werden mit der Bestellung eingefroren: Spätere Änderungen am Warenkorb ändern sie nicht. Bestellungen mit Ersatzpreis oder kostenlosem Versand haben keinen Shippo-Block.

Lizenzschlüssel

Das Modul arbeitet mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock License — VibeFox Shippo ist der erste Block auf Modules > Module Manager > VibeFox Shippo > Configure, oberhalb der Einstellungen. Fügen Sie den Schlüssel in License key ein und klicken Sie auf Activate. Danach zeigt der Block den maskierten Schlüssel, 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-shippo 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 gilt 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 Shippo-Versanddienstleister Kunden an der Kasse nicht angezeigt und es wird kein Tarif berechnet. Das PrestaShop-Frontend 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. Ein Hinweis erscheint unter Modules > Module Manager auf der Registerkarte Alerts. Bestehende Bestellungen sind nicht betroffen.

Wenn eine Lizenz abläuft, arbeitet das Modul weiter, aber Updates und Support erfordern 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 der Eingabe des Schlüssels, danach einmal pro Woche. Ein Cron-Job wird nicht benötigt. Das Deinstallieren oder Zurücksetzen des Moduls entfernt immer den Lizenzschlüssel und den Lizenzstatus.

Fehlerbehebung

Shippo erscheint nicht an der Kasse: prüfen Sie, ob die Lizenz aktiv ist und Enable Shippo shipping eingeschaltet ist. Prüfen Sie unter Shipping > Carriers, ob der Versanddienstleister die Zone des Landes des Kunden und die Kundengruppe abdeckt (oder Ignore shipping zones ist aktiv und das Land ist erlaubt). Prüfen Sie die Gewichtsgrenzen und die Minimum subtotal. Ohne Live-Tarif prüfen Sie, ob das Land, * Default oder Other countries einen Preis hat. Produkte können auf der Produktseite auch auf bestimmte Versanddienstleister beschränkt werden.

Live-Tarife erscheinen nicht: aktivieren Sie Debug log, laden Sie die Kasse neu und sehen Sie im Feld Log auf der Modulseite nach. Häufige Gründe: kein API-Token oder keine Postleitzahl des Absenders, eine Standardwährung des Shops, die sich von der Shippo-Tarifwährung unterscheidet, ohne Wechselkurs, die Postleitzahl des Kunden ist noch nicht eingegeben, kein Versanddienstleister Ihres Shippo-Kontos bedient die Adresse, oder das Shippo-Konto ist noch nicht verifiziert.

Testtarife im Live-Shop: ein Test-Token (shippo_test_...) liefert Shippo-Testtarife. Verwenden Sie das Live-Token (shippo_live_...).

Kostenloser Versand für unerwartete Länder: prüfen Sie die Preistabelle auf eine leere Zeile, besonders eine leere * Default-Zeile. Eine Zeile mit allen leeren Feldern berechnet 0.

Tarife wirken nach einer Änderung veraltet: klicken Sie auf der Modulseite auf Save. Dadurch werden die zwischengespeicherten Shippo-Tarife gelöscht.

Die Seite meldet, dass der Shippo-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 zu erstellen.

Deinstallation

Gehen Sie zu Modules > Module Manager, öffnen Sie das Menü neben VibeFox Shippo 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 aktiviert, wird der Versanddienstleister gelöscht (Bestellungen behalten ihre Historie), und die Einstellungen und das Protokoll werden entfernt. Ist es deaktiviert, wird der Versanddienstleister nur deaktiviert und alle Einstellungen bleiben erhalten. Wird das Modul erneut installiert, erhält der Versanddienstleister den Status zurück, den er vorher hatte. Bestehende Bestellungen behalten ihre Shippo-Versanddienstleister- und Servicedaten.

Shippo ist eine Marke ihres jeweiligen Inhabers. Dieses Modul ist nicht mit Shippo verbunden und wird von Shippo weder unterstützt noch empfohlen.