VibeFox EasyPost for PrestaShop — Hilfe

Anforderungen

PrestaShop: 8.0 bis 9.x.

PHP: 8.0 oder neuer mit der cURL-Erweiterung. Ohne sie verweigert das Modul die Installation.

EasyPost-Konto (nur für Live-Tarife): Erstellen Sie ein Konto auf der Website von EasyPost, verbinden Sie Ihre Versanddienstleister-Konten (USPS, UPS, FedEx und weitere) im EasyPost-Dashboard und kopieren Sie den API-Schlüssel aus EasyPost Dashboard > Account Settings > API Keys. EasyPost berechnet Gebühren für gekaufte Etiketten, nicht für Tarifabfragen. Wenn Sie nur Ersatzpreise verwenden, benötigen Sie kein EasyPost-Konto.

Produkte: Produkte benötigen ein Gewicht und, besser noch, Abmessungen.

VibeFox-Lizenzschlüssel: Er wird auf vibefox.net erworben. 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 aus.

2. Wenn der Upload abgeschlossen ist, klicken Sie auf Configure, oder suchen Sie später VibeFox EasyPost in der Modulliste und klicken Sie auf Configure.

3. Geben 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ügen Sie Ihren EasyPost-API-Schlüssel ein und füllen Sie die Adresse Ship from aus. Die PLZ ist für Live-Tarife erforderlich.

5. Wenn Ihre Standardwährung nicht USD ist, geben Sie den USD exchange rate ein. Optional können Sie Ersatzpreise eintragen (siehe Konfiguration). Klicken Sie auf Save.

Bei der Installation legt das Modul den Dienstleister EasyPost Shipping mit dem Lieferzeittext Live carrier rate (EasyPost) an. Der Dienstleister wird allen Zonen und allen Kundengruppen zugewiesen. Sie können Zonen, Kundengruppen, Lieferzeit, Logo und Größenbeschränkungen unter Shipping > Carriers ändern. Setzen Sie dort keine Preise: Der Preis stammt immer aus dem Modul.

Konfiguration

Alle Einstellungen befinden sich auf der Modulseite: Modules > Module Manager > VibeFox EasyPost > Configure. Jeder Abschnitt hat seine eigene Schaltfläche Save, die die gesamte Seite speichert. Jedes Speichern löscht außerdem die zwischengespeicherten EasyPost-Tarife.

Oben auf der Seite zeigt das Modul Warnungen an, wenn Live-Tarife nicht verwendet werden können: kein API-Schlüssel (mit oder ohne Ersatzpreise), keine PLZ oder kein Land für den Versandort, oder eine Standardwährung ungleich USD ohne Wechselkurs. Ein Hinweis erscheint außerdem, wenn ein Test-API-Schlüssel gesetzt ist, ein Fehler, wenn der Dienstleister des Moduls gelöscht wurde, und eine Warnung, wenn die Gewichts- oder Abmessungseinheit Ihres Shops (International > Localization) nicht eine ist, die das Modul kennt (kg, g, lb, oz; cm, mm, m, in).

Beim Speichern wird ein Wert, der keine Zahl ist (oder negativ ist), nicht gespeichert: Eine Warnung nennt das Feld, und der bisherige Wert bleibt erhalten. Dasselbe passiert, wenn der USD exchange rate 0 ist oder wenn das Minimum weight größer als das Maximum weight ist.

Allgemein

Enable EasyPost shipping: schaltet den Dienstleister ein oder aus. Das ist derselbe Schalter wie der Status des Dienstleisters unter Shipping > Carriers. Standard: on.

Name: der Name des Dienstleisters, den der Kunde an der Kasse sieht, höchstens 64 Zeichen (ein längerer Name wird abgelehnt, und nichts wird gespeichert). Standard: EasyPost Shipping. Ist der Name leer oder enthält er Zeichen, die PrestaShop in einem Dienstleisternamen nicht zulässt, wird der Standardname verwendet.

EasyPost-Konto

API key: Ihr EasyPost-API-Schlüssel aus EasyPost Dashboard > Account Settings > API Keys. Ein Produktionsschlüssel (beginnt mit EZAK) liefert echte Tarife. Ein Testschlüssel (beginnt mit EZTK) liefert EasyPost-Testtarife; verwenden Sie ihn nur zum Testen. Nach dem Speichern bleibt das Feld leer und zeigt den gespeicherten Schlüssel maskiert an, zum Beispiel EZAK******abcd. Lassen Sie das Feld leer, um ihn zu behalten. Geben Sie einen neuen Wert nur ein, um ihn zu ändern.

Remove the saved API key: Setzen Sie dieses Häkchen und klicken Sie auf Save, um den gespeicherten Schlüssel zu löschen.

Allowed carriers / services: optional, durch Kommas getrennt. Geben Sie einen Dienstleister (USPS) oder einen Dienstleister und einen Service (USPS:Priority, UPS:Ground) so ein, wie EasyPost sie benennt. Der günstigste erlaubte Tarif wird angezeigt. Lassen Sie das Feld leer, um den günstigsten Tarif aller Dienstleister anzuzeigen.

Versand von

Die Adresse, von der Ihre Pakete versendet werden. Wenn das Country Ihr Shop-Land ist, werden leere Felder aus der Shop-Adresse unter Shop Parameters > Contact > Stores übernommen (und der Absendername aus dem Shop-Namen).

Sender name / company: der Name des Absenders oder das Unternehmen.

Street address: die Straße der Versandadresse.

City: die Stadt der Versandadresse.

State: der zweistellige Bundesstaatscode, zum Beispiel CA oder NY.

ZIP code: die PLZ bzw. Postleitzahl der Versandadresse. Für Live-Tarife erforderlich.

Country: das Land, aus dem Sie versenden. Standard: United States.

Tarife

Parcels: wie der Warenkorb an EasyPost gesendet wird.

One parcel per order (the cart is packed into one box): alle Einheiten werden in einen Karton gepackt und einmal bewertet. Das ist der Standard.

One parcel per item (every unit ships in its own box): jedes Produkt wird als eigenes Paket bewertet, und der Tarif wird für jede Einheit berechnet. Ersatzpreise werden ebenfalls pro Einheit berechnet.

Gewichte werden von der Einheit Ihres Shops in Unzen umgerechnet (mindestens 1 oz), Abmessungen in Zoll. Hat ein Produkt keine Abmessungen, wird das Paket nur nach Gewicht bewertet.

USD exchange rate: EasyPost-Tarife sind in USD. Geben Sie den Preis von 1 USD in Ihrer Standardwährung ein, zum Beispiel 0.92. Ohne diesen Wert werden keine Live-Tarife verwendet, nur Ersatzpreise. Er wird nicht benötigt, wenn die Standardwährung USD ist. Shops in USD und CAD lassen EasyPost in ihrer eigenen Währung angeben. Sowohl Punkt als auch Komma werden als Dezimaltrennzeichen akzeptiert.

Tax: die Steuerregel des Dienstleisters oder No tax. EasyPost-Tarife enthalten keine Umsatzsteuer. Wählen Sie die Steuerregeln, die für den Versand gelten.

Ersatzpreise

Sie werden verwendet, wenn kein Live-Tarif vorliegt: kein API-Schlüssel, EasyPost ist nicht erreichbar, der Schlüssel wird abgelehnt oder kein Dienstleister hat einen Tarif für die Adresse. Die Preise gelten in Ihrer Standardwährung ohne Steuer. Lassen Sie beide Felder leer, um den Dienstleister in diesem Fall auszublenden.

Country prices: eine Zeile pro Land: zweistelliger Ländercode, ein Doppelpunkt und der Preis, zum Beispiel US:9.99. Zeilen in einem anderen Format werden ignoriert und beim Speichern in einer Warnung aufgelistet.

Other countries: der Preis für Länder, die nicht in der obigen Liste stehen. Lassen Sie das Feld leer, um den Dienstleister für sie auszublenden.

Bedingungen

Free shipping from: die Zwischensumme des Warenkorbs (zu versendende Produkte, nach Rabatten, vor Steuern, in Ihrer Standardwährung), ab der der Versand kostenlos ist. In diesem Fall wird keine Anfrage an EasyPost gestellt. Lassen Sie das Feld leer, um die Funktion auszuschalten.

Minimum subtotal: Der Dienstleister wird nur angezeigt, wenn die Zwischensumme des Warenkorbs (zu versendende Produkte, nach Rabatten, vor Steuern) mindestens diesen Betrag erreicht. Lassen Sie das Feld leer, um ihn immer anzuzeigen.

Minimum weight: blendet den Dienstleister aus, wenn der Warenkorb weniger wiegt, in der Gewichtseinheit Ihres Shops (wird im Feldnamen angezeigt). 0 bedeutet keine Grenze.

Maximum weight: blendet den Dienstleister aus, wenn der Warenkorb mehr wiegt, in der Gewichtseinheit Ihres Shops. 0 bedeutet keine Grenze.

Verfügbarkeit ohne Versandzonen

Normalerweise wird der Dienstleister in den Zonen angeboten, die ihm unter Shipping > Carriers zugewiesen sind. Alternativ kann er unabhängig von Zonen nach Land angeboten werden.

Ignore shipping zones: bietet den Dienstleister für die unten angegebenen Länder an, unabhängig davon, ob deren Zone dem Dienstleister zugewiesen ist. Wenn Sie mit aktivierter Option speichern, wird der Dienstleister allen Zonen zugewiesen, auch später angelegten Zonen. Wenn Sie die Option deaktivieren, erhält der Dienstleister seine vorherigen Zonen zurück.

Countries: die Zielländer für diesen Modus. Verwenden Sie Strg+Klick, um mehrere auszuwählen. Lassen Sie das Feld leer, um alle aktiven Länder Ihres Shops zu verwenden. Dieses Feld wird nur verwendet, wenn Ignore shipping zones aktiviert ist.

Erweitert

Debug log: schreibt EasyPost-Anfragen in modules/vfd_easypost/logs/vfd_ep.log.php. Die Datei kann nicht über den Webbrowser geöffnet werden und wird bei 5 MB rotiert. API-Fehler werden immer protokolliert, auch wenn diese Option aus ist. Der API-Schlüssel und Kundenadressen werden nie protokolliert.

Remove data on uninstall: Wenn diese Option aktiv ist, löscht die Deinstallation des Moduls seine Einstellungen, Tabellen und das Protokoll. Das Deaktivieren des Moduls löscht nie Einstellungen.

Log: das Panel unter den Einstellungen zeigt die letzten 100 Zeilen des Protokolls. Klicken Sie auf Clear log, um es zu leeren.

So funktioniert es an der Kasse

Im Versandschritt fragt PrestaShop das Modul nach dem EasyPost-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: Zielland (mit Ignore shipping zones), Warenkorbgewicht und Mindestzwischensumme. Gilt kostenloser Versand, beträgt der Preis 0, und es wird keine Anfrage an EasyPost gesendet.

Andernfalls sendet das Modul an EasyPost die Versandadresse, die Lieferadresse und das Paket und erhält die Tarife aller Ihrer Versanddienstleister-Konten. Es wählt den günstigsten erlaubten Tarif, rechnet ihn in Ihre Standardwährung um und zeigt ihn in der Warenkorbwährung des Kunden an. Für Länder, die eine Postleitzahl benötigen, wird die Anfrage nur gestellt, wenn die Lieferadresse eine PLZ hat. Bevor der Kunde eine Adresse eingegeben hat, ist nur das Land des Besuchers bekannt. Daher erhalten Länder, die eine PLZ benötigen, bis zur Eingabe der Adresse den Ersatzpreis.

Jede Antwort wird für dieselbe Adresse und dasselbe Paket 1 Stunde lang zwischengespeichert. Eine Adresse ohne brauchbare Tarife wird 10 Minuten lang gemerkt. Nach einer Zeitüberschreitung, einem abgelehnten Schlüssel, einem Ratenlimit oder einem Serverfehler von EasyPost werden 5 Minuten lang keine Anfragen gestellt. Das API-Zeitlimit beträgt 10 Sekunden. In all diesen Fällen sieht der Kunde keinen Fehler: Es wird der Ersatzpreis verwendet, oder der Dienstleister wird ausgeblendet, wenn kein Ersatzpreis vorhanden ist. Der Grund wird im Protokoll festgehalten.

Wenn Sie den Dienstleister unter Shipping > Carriers bearbeiten, nachdem er Bestellungen hat, speichert PrestaShop ihn als neue Version des Dienstleisters. Das Modul folgt der neuen Version automatisch.

Das Modul berechnet nur Tarife. Es kauft keine Etiketten, verfolgt keine Pakete, prüft keine Adressen, bietet keine Abhol- oder Abgabestellen an und fügt keine Versicherungs- oder Unterschriftsoptionen hinzu. Es zeigt eine Option (den günstigsten erlaubten Tarif), nicht eine Liste von Services. Es gibt keine Kartonpackung über das Zusammenlegen der Artikel in ein Paket hinaus und keinen Tarifaufschlag oder keine Bearbeitungsgebühr.

Bestellungen

Wenn eine Bestellung mit dem EasyPost-Dienstleister aufgegeben wird, wird der an der Kasse angezeigte Tarif zusammen mit der Bestellung gespeichert. Die Bestellseite im Back Office zeigt den Block EasyPost shipping:

Carrier / service: der EasyPost-Dienstleister und -Service des Tarifs, zum Beispiel USPS Priority. Im Modus ein Paket pro Artikel werden alle verwendeten Services aufgelistet.

Estimated delivery days: die von EasyPost gelieferten Liefertage (nur im Modus ein Paket pro Bestellung, wenn EasyPost sie zurückgibt).

Price source: Live EasyPost rate, Fallback price (no live rate) oder Free shipping threshold.

Calculated price (excl. tax): der Preis in Ihrer Standardwährung.

Spätere Änderungen des Warenkorbs im Back Office ändern diese Werte nicht. Nutzen Sie sie, um das Etikett in Ihrem EasyPost-Konto zu kaufen. Tarife abgebrochener Warenkörbe werden nach 30 Tagen entfernt.

Lizenzschlüssel

Das Modul arbeitet mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock License — VibeFox EasyPost ist der erste Block unter Modules > Module Manager > VibeFox EasyPost > 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 zum erneuten Prüfen des Status, Change key zum Eingeben eines anderen Schlüssels und Remove key zum Entfernen des Schlüssels aus diesem Shop. Darunter stehen die Zeile Product: presta-shipping-easypost und der Link Manage licenses and domains in your account, der zu Ihrem vibefox.net-Konto führt. 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 Shop-Adresse 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 auf einer Domain: der 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 einen aktiven Schlüssel wird der EasyPost-Dienstleister 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 Dienstleister 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 Tab 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 Ihrer Arbeit im Back Office automatisch erneut geprüft: einmal am Tag in den ersten 14 Tagen nach der Eingabe des Schlüssels, danach einmal pro Woche. Ein Cron-Job ist nicht nötig. Die Deinstallation oder das Zurücksetzen des Moduls entfernt immer den Lizenzschlüssel und den Lizenzstatus.

Fehlerbehebung

EasyPost erscheint nicht an der Kasse: Prüfen Sie, ob die Lizenz aktiv ist und Enable EasyPost shipping eingeschaltet ist. Prüfen Sie unter Shipping > Carriers, ob der Dienstleister aktiviert ist und die Zone des Kundenlandes sowie die Kundengruppe abdeckt (oder ob Ignore shipping zones aktiviert und das Land ausgewählt ist). Prüfen Sie die Gewichtsgrenzen und die Minimum subtotal. Ohne Live-Tarif braucht der Dienstleister einen Ersatzpreis für das Land oder für Other countries. Produkte können auf der Produktseite außerdem auf bestimmte Dienstleister beschränkt werden.

Live-Tarife erscheinen nicht: Lesen Sie die Warnungen oben auf der Modulseite, aktivieren Sie dann das Debug log, laden Sie die Kasse neu und sehen Sie sich das Panel Log an. Häufige Gründe: kein API-Schlüssel oder keine PLZ des Versandorts, ein Shop ohne USD ohne USD exchange rate, die Lieferadresse hat noch keine PLZ, kein Dienstleister Ihres EasyPost-Kontos bedient die Adresse, oder Allowed carriers / services filtert alle Tarife heraus.

Tarife sehen wie Testpreise aus: Es ist ein Testschlüssel (EZTK...) gesetzt. Verwenden Sie in dem Live-Shop einen Produktionsschlüssel (EZAK...).

Tarife wurden für einige Minuten gestoppt: Nach einer Zeitüberschreitung, einem abgelehnten Schlüssel oder einem Serverfehler von EasyPost pausiert das Modul die Anfragen für 5 Minuten und verwendet Ersatzpreise. Prüfen Sie den API-Schlüssel und das Protokoll.

Sind Steuern enthalten? EasyPost-Tarife enthalten keine Umsatzsteuer. Wählen Sie die Steuerregel unter Tax, um Steuern auf den Versand aufzuschlagen.

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

Die Seite meldet, dass der Dienstleister des Moduls nicht gefunden wurde: Der Dienstleister wurde unter Shipping > Carriers gelöscht. Setzen Sie das Modul unter Modules > Module Manager zurück, um ihn neu anzulegen.

Entwickler-Hooks: Die Hooks actionVfdEpShipmentRequest (Anfragetext), actionVfdEpSelectedRate (gewählter Tarif) und actionVfdEpApiUrl (API-Basis-URL) passen das Modul an.

Deinstallation

Gehen Sie zu Modules > Module Manager, öffnen Sie das Menü neben VibeFox EasyPost und wählen Sie Uninstall. Der Lizenzschlüssel und der Lizenzstatus werden immer entfernt. Der Dienstleister wird aus der Kasse entfernt (Bestellungen behalten ihren Verlauf), und die zwischengespeicherten Tarife werden in jedem Fall gelöscht. Ist Remove data on uninstall aktiviert, werden außerdem die Einstellungen, die gespeicherten Tarife der Bestellungen und das Protokoll entfernt. Ist die Option deaktiviert, bleiben die Einstellungen und die EasyPost-Daten der aufgegebenen Bestellungen für eine erneute Installation erhalten. Die Installation oder das Zurücksetzen des Moduls legt einen neuen Dienstleister an. Wurden die Einstellungen behalten, erhält er den Status (aktiviert oder deaktiviert) des vorherigen Dienstleisters.

EasyPost ist eine Marke ihres jeweiligen Inhabers. Dieses Modul ist weder mit EasyPost verbunden noch wird es von EasyPost unterstützt.