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

ShipStation-Konto: verbinden Sie Ihre Versanddienstleister in ShipStation (Settings > Shipping > Carriers) und kopieren Sie danach API Key und API Secret von ShipStation > Settings > Account > API Settings. Der API-Zugang hängt von Ihrem ShipStation-Tarif ab. Ist die Seite nicht verfügbar, enthält Ihr Tarif keinen API-Zugang. Das Modul verwendet die ShipStation API V1 (API Key und API Secret). ShipStation-Konten mit API V2 und einem einzigen API-Schlüssel werden nicht unterstützt. Ohne Schlüssel werden nur die Ersatzpreise verwendet.

VibeFox-Lizenzschlüssel: wird auf vibefox.net gekauft. 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 ShipStation in der Modulliste und klicken dort auf Configure.

3. Fügen 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 API Key und API Secret ein, geben Sie die Versand-Postleitzahl ein und klicken Sie auf Save. Die Seite listet nun die Carrier-Codes Ihres Kontos auf. Tragen Sie den oder die gewünschten unter Carrier codes ein und speichern Sie erneut.

5. Wenn die Standardwährung Ihres Shops nicht die Währung Ihres ShipStation-Kontos ist, stellen Sie Exchange rate ein.

6. Optional können Sie die Ersatzpreise ausfüllen.

Bei der Installation legt das Modul den Versanddienstleister ShipStation Shipping mit dem Lieferzeittext ShipStation carriers (USPS, UPS, FedEx, ...) 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 vom Modul.

Konfiguration

Alle Einstellungen befinden sich auf der Modulseite: Modules > Module Manager > VibeFox ShipStation > Configure. Jeder Abschnitt hat seine eigene Schaltfläche Save, die die gesamte Seite speichert. Jedes Speichern leert die zwischengespeicherten ShipStation-Tarife und prüft API Key und API Secret. Danach zeigt die Seite die mit Ihrem Konto verbundenen Versanddienstleister mit ihren Codes, zum Beispiel "stamps_com (Stamps.com), ups_walleted (UPS by ShipStation)".

Warnungen oben auf der Seite zeigen an, wenn Live-Tarife nicht funktionieren können: keine Schlüssel, kein Carrier-Code, keine Versand-Postleitzahl, ein fehlender Wechselkurs, eine fehlgeschlagene Verbindungsprüfung oder Carrier-Codes, die nicht mit Ihrem Konto verbunden sind. Eine Warnung erscheint auch, wenn die Gewichts- oder Maßeinheit des Shops eine ist, die das Modul nicht umrechnen kann. Stellen Sie kg, g, lb oder oz sowie cm, mm, m oder in unter International > Localization (Local units) ein. Ein Zahlenfeld mit negativem Wert oder mit Text, der keine Zahl ist, oder ein Minimum weight über dem Maximum weight wird als Fehler gemeldet, und nichts wird gespeichert.

Allgemein

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

Name: der Name des Versanddienstleisters, den der Kunde an der Kasse sieht. Standard: ShipStation Shipping. Pflichtfeld, höchstens 64 Zeichen.

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

ShipStation-Konto

API Key: der API Key von ShipStation > Settings > Account > API Settings. Er wird nur an ShipStation 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.

API Secret: das API Secret von derselben Seite. Es wird genauso behandelt wie der Schlüssel.

Remove the saved API key and secret: erscheint, sobald Schlüssel gespeichert sind. Aktivieren Sie es und speichern Sie, um beide zu entfernen.

Carrier codes: ein oder mehrere ShipStation-Carrier-Codes, durch Komma getrennt, zum Beispiel stamps_com, ups_walleted. Es werden bis zu 5 Codes verwendet, mit einer API-Anfrage pro Carrier. Wenn Sie mehr eingeben, werden nur die ersten 5 behalten, und die Seite weist darauf hin. Angezeigt wird der günstigste Tarif dieser Carrier. Die Codes entnehmen Sie der Liste, die nach dem Speichern erscheint.

Allowed services: optional, durch Komma getrennte ShipStation-Service-Codes, zum Beispiel usps_priority_mail, ups_ground. Leer lassen, um den günstigsten Service der oben genannten Carrier anzuzeigen.

Package code: "package" (Standard) bewertet Ihre eigene Box und lässt Umschläge und Flatrate-Boxen des Carriers aus. Leer lassen, um alle vom Carrier angebotenen Paketarten zu bewerten.

Versand von

Ship-from postal code: für Live-Tarife erforderlich. ShipStation berechnet den Tarif nur anhand der Postleitzahl, und diese muss im Land Ihres ShipStation-Kontos liegen. Leer lassen, um die Shop-Postleitzahl unter Shop Parameters > Contact > Stores zu verwenden.

Tarife

Parcels: wie der Warenkorb an ShipStation gesendet wird.

One parcel per order (the cart is packed into one box): alle Artikel werden in einer Box gestapelt und einmal bewertet.

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. Auch die Ersatzpreise werden pro Einheit berechnet.

ShipStation account currency: die Währung, in der ShipStation die Tarife zurückgibt: USD, CAD, GBP, AUD, NZD oder EUR. Standard: USD (US-Konten).

Exchange rate: der Preis von 1 Einheit der Kontowährung in der Standardwährung Ihres Shops, zum Beispiel 0.92. Er wird nur benötigt, wenn sich die Standardwährung von der Kontowährung unterscheidet. Ohne ihn werden Live-Tarife nicht verwendet, und es gelten die Ersatzpreise. Wechselkurse werden nicht automatisch aktualisiert.

Ersatzpreise (werden verwendet, wenn kein Live-Tarif vorliegt: keine API-Schlüssel, ShipStation nicht erreichbar, keine Carrier-Tarife für die Adresse; Preise in der Standardwährung Ihres Shops; lassen Sie die Tabelle und Other countries leer, um den Versanddienstleister in diesem Fall auszublenden)

Prices by country: eine Tabelle mit einem Grundpreis pro Land und Größenspalten nach Paketgewicht: XS ≤ 1 kg, S ≤ 2 kg, M ≤ 3 kg, L ≤ 5 kg und XL > 5 kg. Klicken Sie auf Add country, um eine Zeile hinzuzufügen, und auf das Papierkorbsymbol, um sie zu entfernen. Eine leere Größe verwendet den Grundpreis. Ein Grundpreis von 0 bedeutet kostenlosen Versand. Die Zeile * Default (all other countries) gilt für Länder ohne eigene Zeile. Eine Zeile ohne Preis wird nicht gespeichert.

Other countries: der Preis, wenn die Tabelle für das Land keinen Preis enthält. Lassen Sie das Feld leer, um den Versanddienstleister in diesem Fall auszublenden.

Bedingungen

Free shipping from: die Warenkorb-Zwischensumme (nach Rabatten, vor Steuern), ab der der Versand kostenlos ist. In diesem Fall wird keine Anfrage an ShipStation gestellt. Leer lassen, um die Option zu deaktivieren.

Minimum subtotal: den Versanddienstleister nur anzeigen, wenn die Warenkorb-Zwischensumme (nach Rabatten, vor Steuern) mindestens diesen Betrag erreicht. Leer lassen, um ihn immer anzuzeigen.

Minimum weight: das minimale Warenkorbgewicht in der Gewichtseinheit Ihres Shops, ab dem der Versanddienstleister angezeigt wird. 0 bedeutet keine Begrenzung.

Maximum weight: der Versanddienstleister wird bei einem Warenkorbgewicht über diesem Wert ausgeblendet, in der Gewichtseinheit Ihres Shops. 0 bedeutet keine Begrenzung.

Verfügbarkeit ohne Versandzonen

Normalerweise wird der Versanddienstleister in seinen Zonen unter Shipping > Carriers angeboten. Alternativ kann er 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 die Option aktiv ist, wird der Versanddienstleister allen Zonen hinzugefügt, auch später erstellten Zonen. Beim Ausschalten werden diese hinzugefügten 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 aktiv ist.

Erweitert

Debug log: protokolliert die Anfragen an ShipStation in logs/vfd_shst_debug.log.php im Modulordner. Die Datei kann nicht über das Web geöffnet werden. API-Fehler werden immer protokolliert, auch wenn diese Option ausgeschaltet ist. API Key, API Secret und Kundenadressen werden nie protokolliert. Die Postleitzahl wird maskiert.

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 aktiv, löscht die Deinstallation des Moduls die Einstellungen, den Versanddienstleister, das Protokoll und den mit Bestellungen gespeicherten ShipStation-Service. Ist sie aus, bleibt alles für eine erneute Installation erhalten.

So funktioniert es an der Kasse

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

Danach sendet das Modul an ShipStation die Versand-Postleitzahl, das Zielland, Bundesland, Ort und Postleitzahl, das Paketgewicht und die Boxgröße. Vor der Eingabe einer Postleitzahl durch den Kunden wird keine Anfrage gestellt. Länder ohne Postleitzahlen erhalten die Ersatzpreise. Die Artikel werden in einer Box gestapelt. Hat ein Produkt keine Maße, wird das Paket nur nach Gewicht bewertet.

ShipStation wird pro Carrier-Code einmal abgefragt. Das Modul verwendet den günstigsten erlaubten Tarif, umgerechnet in die Standardwährung Ihres Shops. Der Preis wird dann in der Warenkorbwährung des Kunden angezeigt.

Jede Antwort wird 1 Stunde zwischengespeichert. Antwortet ShipStation ohne brauchbaren Tarif, wird diese Antwort 10 Minuten gemerkt. Lehnt ShipStation die Schlüssel ab oder ist es nicht erreichbar, werden Anfragen 5 Minuten pausiert. Nach einem Ratenlimit richtet sich die Pause nach der Reset-Zeit, die ShipStation angibt. Das Zeitlimit für Anfragen beträgt 12 Sekunden. Das Deaktivieren des Moduls leert die zwischengespeicherten Tarife.

Gibt es keinen Live-Tarif, stammt der Preis aus der Tabelle der Ersatzpreise und danach aus Other countries. Trifft keines davon zu, wird der Versanddienstleister ausgeblendet. Kunden sehen nie ShipStation-Fehlermeldungen. Details gehen in das Debug-Protokoll.

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, erstellt keine ShipStation-Bestellungen oder Sendungen, verfolgt keine Pakete und übernimmt keine Retouren. Es gibt keine Abholstellen, keine Auswahl zwischen mehreren Services an der Kasse, keine Adressprüfung, Versicherung, Unterschriftsbestätigung, Verpackung in mehrere Pakete und keinen Tarifaufschlag.

Bestellungen

Wird eine Bestellung mit einem Live-Tarif von ShipStation aufgegeben, wird der gewählte Service mit der Bestellung gespeichert. Die Bestellseite im Back Office zeigt ihn in einem Block ShipStation als Service an, zum Beispiel "USPS Ground Advantage - Package", damit Sie in ShipStation das passende Etikett erstellen können. Spätere Neuberechnungen des Warenkorbs ändern ihn nicht. Bestellungen mit Ersatzpreis oder kostenlosem Versand haben keinen Service-Block.

Lizenzschlüssel

Das Modul arbeitet mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock License — VibeFox ShipStation ist der erste Block auf Modules > Module Manager > VibeFox ShipStation > 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-shipstation und der Link Manage licenses and domains in your account, der Ihr vibefox.net-Konto öffnet. Den Schlüssel können nur Mitarbeiter ändern, die die Berechtigung Configure für das Modul haben. Die Texte des Blocks folgen der Sprache des Back Office (Englisch und Russisch sind enthalten).

Ist der Schlüssel nicht gültig, 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 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 aktiven Schlüssel wird der ShipStation-Versanddienstleister an der Kasse nicht angezeigt und kein Tarif berechnet. Die Kundenseite von PrestaShop weiß nicht, dass Sie im Back Office angemeldet sind, daher ist der Versanddienstleister auch für Sie ausgeblendet: Sie können das Modul vor dem Kauf eines Schlüssels einrichten, an der Kasse aber 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 aber 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

ShipStation erscheint nicht an der Kasse: Prüfen Sie, ob die Lizenz aktiv ist und Enable ShipStation shipping eingeschaltet ist. Prüfen Sie unter Shipping > Carriers, ob der Versanddienstleister die Zone des Landes und die Kundengruppe abdeckt, oder schalten Sie Ignore shipping zones ein und prüfen Sie Countries. Kontrollieren 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 außerdem auf der Produktseite auf bestimmte Versanddienstleister beschränkt sein.

Die Kasse zeigt den Ersatzpreis statt des ShipStation-Tarifs: Prüfen Sie die Warnungen oben auf der Modulseite (Schlüssel, Carrier-Code, Versand-Postleitzahl, Wechselkurs). Schalten Sie das Debug log ein, laden Sie die Kasse neu und sehen Sie im Feld Log nach. Die Postleitzahl des Kunden ist erforderlich. Vor ihrer Eingabe wird keine Anfrage gestellt.

Welchen Carrier-Code Sie eintragen: Speichern Sie die Einstellungen mit Schlüssel und Secret. Die Seite listet die Carrier-Codes Ihres Kontos auf. Verwenden Sie einen oder mehrere davon.

Die ShipStation-Verbindungsprüfung ist fehlgeschlagen: Die Meldung nennt den Grund. Prüfen Sie API Key und API Secret und speichern Sie erneut, um die Prüfung zu wiederholen.

Der Tarif weicht von ShipStation ab: Das Paket wird aus den Produktgewichten und -maßen gebildet, die Artikel sind in einer Box gestapelt. Produkte ohne Maße werden nur nach Gewicht bewertet. Tarife werden 1 Stunde zwischengespeichert. Klicken Sie auf der Modulseite auf Save, um den Cache zu leeren.

Die Seite meldet, dass der ShipStation-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 ShipStation und wählen Sie Uninstall. Der Lizenzschlüssel und der Lizenzstatus werden immer entfernt. Der Tarif-Cache und das Ergebnis der Verbindungsprüfung werden immer entfernt. Ist Remove data on uninstall eingeschaltet, wird der Versanddienstleister gelöscht (Bestellungen behalten ihren Verlauf), und die Einstellungen, das Protokoll sowie der mit Bestellungen gespeicherte Service werden entfernt. Ist die Option aus, wird der Versanddienstleister nur deaktiviert, und die Einstellungen und der Service bereits aufgegebener Bestellungen bleiben erhalten. Bei einer erneuten Installation oder einem Reset erhält der Versanddienstleister den Status zurück, den er vorher hatte.

ShipStation ist eine Marke ihres jeweiligen Inhabers. Dieses Modul ist nicht mit ShipStation verbunden und wird von ShipStation nicht unterstützt.