VibeFox SMSA Express 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.

SMSA-Express-Preisliste: Die Preise für die Preistabelle stammen von Ihrem SMSA-Konto oder dem SMSA-Vertrieb. Geben Sie sie in Ihrer Shopwährung ein. Liegt Ihre Preisliste in SAR, AED oder einer anderen Währung vor, rechnen Sie sie vorher um.

SMSA passKey (nur für Live-Tarife): Live-Tarife nutzen den SMSA-Webservice (SECOM, Operation getShipCharges). SMSA stellt den passKey auf Anfrage aus: Fragen Sie Ihren SMSA-Kundenbetreuer oder schreiben Sie an info@smsaexpress.com und bitten Sie unter Angabe Ihrer Kontonummer um Zugang zum SMSA-Webservice. Der passKey kann vom API-Schlüssel des SMSA-E-Commerce-Portals abweichen. Für diesen Dienst gibt es keinen Testserver (Sandbox) von SMSA.

VibeFox-Lizenzschlüssel: erhältlich auf vibefox.net. Ein Schlüssel funktioniert auf einer Domain.

Installation

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

2. Klicken Sie auf Activate.

3. Öffnen Sie die Einstellungen: WooCommerce > Settings > Shipping > VibeFox SMSA Express, 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. Tragen Sie Ihre SMSA-Express-Preise in die Preistabelle ein.

6. Optional: Aktivieren Sie unter Live rates (API) die Option Live charges und geben Sie Ihren SMSA passKey, die Versandstadt und das Versandland ein sowie, falls Ihre Shopwährung nicht SAR ist, den Wechselkurs.

7. Fügen Sie VibeFox SMSA Express unter WooCommerce > Settings > Shipping > Shipping zones einer Versandzone hinzu (zum Beispiel „Saudi-Arabien“) 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 SMSA Express. Sie gelten für alle Versandzonen. Wenn Sie die Methode einer Zone hinzufügen, hat das Zonenfenster nur ein Feld:

Title (zone): der Name, den Kunden für diese Zone sehen. Lassen Sie das Feld leer, um den globalen Method title zu verwenden.

Jedes Mal, wenn Sie die Einstellungen speichern, werden die zwischengespeicherten SMSA-Tarife gelöscht. Sind Live-Tarife aktiviert, weisen Hinweise über den Einstellungen auf einen fehlenden passKey, eine fehlende Versandstadt, einen fehlenden Wechselkurs oder eine leere Preistabelle hin.

Allgemein

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

Method title: der Name der Versandart, der im Warenkorb und in der Kasse angezeigt wird. Eine Zone kann ihn überschreiben. Standard: SMSA Express.

Live-Tarife (API) (optional; liefert SMSA keinen Tarif, wird die Preistabelle verwendet)

Live charges: ermittelt den Versandtarif von SMSA Express. Standard: aus.

SMSA passKey: der Schlüssel des SMSA-Webservices (SECOM). Zeigt das Protokoll „Invalid Passkey“, akzeptiert dieser Dienst den Schlüssel nicht. Fragen Sie SMSA nach einem passKey für den Webservice.

Ship-from city: die Stadt, von der Ihre Pakete versendet werden, so geschrieben, wie SMSA sie schreibt, zum Beispiel Riyadh, Jeddah oder Dammam. Lassen Sie das Feld leer, um die Shopstadt aus WooCommerce > Settings > General zu verwenden.

Ship-from country: das Land, von dem Ihre Pakete versendet werden. Standardmäßig ist es Ihr Shopland.

Shipment type: wird als Sendungsart an SMSA übermittelt. DLV (der Standard) ist die Standardzustellung. Ändern Sie es nur, wenn SMSA Ihnen einen anderen Code gegeben hat.

Currency of SMSA charges: SMSA liefert jeden Tarif mit seinem Währungscode, meist SAR (Standard). Ein Tarif in einer anderen Währung als dieser oder Ihrer Shopwährung wird nicht verwendet.

Exchange rate: der Preis von 1 Einheit der SMSA-Währung in Ihrer Shopwährung, zum Beispiel 0.24. Nicht nötig, wenn beide Währungen gleich sind. Ohne ihn werden Tarife in einer anderen Währung nicht verwendet und die Preistabelle gilt. Als Dezimaltrennzeichen werden Punkt und Komma akzeptiert.

Preise (Ihre SMSA-Express-Preisliste in Ihrer Shopwährung; wird verwendet, wenn Live-Tarife aus sind, und als Ersatz, wenn SMSA keinen Tarif liefert)

Price table: eine Zeile pro Zielland. Klicken Sie auf + Add country, um eine Zeile hinzuzufügen, und auf das Kreuz, um eine zu entfernen. Die Zeile * All other countries gilt für Länder ohne eigene Zeile. Jede Zeile hat einen Grundpreis und Gewichtsspalten: XS bis 1 kg, S bis 2 kg, M bis 3 kg, L bis 5 kg und XL über 5 kg. Eine leere oder mit 0 belegte Gewichtsspalte verwendet den Grundpreis. Ein Grundpreis von 0 bedeutet kostenlosen Versand. Zeilen ohne Preis werden beim Speichern entfernt. Sowohl „9.99“ als auch „9,99“ werden akzeptiert.

Price for countries not in the table: wird verwendet, wenn die Tabelle für das Zielland keine Zeile hat (und keine *-Zeile) oder die Zeile für dieses Gewicht keinen Preis hat. Lassen Sie das Feld leer, um die Methode in diesem Fall auszublenden.

Price applies: wie der Preis berechnet wird.

Produktgewichte werden von Ihrer Shop-Gewichtseinheit in Kilogramm umgerechnet.

Bedingungen

Minimum weight (kg): blendet die Methode aus, wenn der Warenkorb weniger wiegt. 0 bedeutet kein Limit.

Maximum weight (kg): blendet die Methode aus, wenn der Warenkorb mehr wiegt. Standard: 30. 0 bedeutet kein Limit.

Minimum order amount: zeigt die Methode nur an, wenn die Zwischensumme des Warenkorbs (nach Rabatten, vor Steuern) diesen Betrag erreicht. Leer lassen, um sie immer anzuzeigen.

Free shipping from: die Zwischensumme des Warenkorbs (nach Rabatten, vor Steuern), ab der der Versand mit SMSA Express kostenlos ist. Kostenloser Versand wird nur dort angeboten, wo die Methode einen Preis für das Ziel hat: einen SMSA-Tarif, eine Tabellenzeile oder den Preis für Länder außerhalb der Tabelle. Hat die Tabelle einen Preis, wird keine Anfrage an SMSA gesendet. Leer lassen, um nie kostenlosen Versand anzubieten.

Excluded shipping classes: blendet die Methode aus, wenn der Warenkorb ein Produkt aus einer dieser WooCommerce-Versandklassen enthält.

Tax status: Taxable fügt die WooCommerce-Steuer den Versandkosten hinzu, None nicht. Wählen Sie None, wenn Ihre Preise (die Tabelle und die SMSA-Tarife) bereits Steuern enthalten, zum Beispiel die saudische Mehrwertsteuer (VAT).

Verfügbarkeit ohne Versandzonen

Ignore shipping zones: bietet SMSA Express für die unten genannten Länder an, auch wenn die Methode keiner Versandzone hinzugefügt ist.

Countries: die Zielländer für diesen Modus. Leer lassen, um alle Länder zu verwenden, in die Sie liefern. Dieses Feld wird nur verwendet, wenn Ignore shipping zones aktiviert ist. Eine einer Versandzone hinzugefügte Methode funktioniert immer für die Länder ihrer Zone.

Erweitert

Debug log: protokolliert jede Tarifberechnung unter WooCommerce > Status > Logs, Quelle vfd_smsa_express. Es werden keine Kundenadressen und keine Schlüssel protokolliert. Fehler bei Live-Tarifen werden immer protokolliert, auch wenn diese Option aus ist. Schalten Sie das Protokoll aus, wenn Sie fertig sind.

Remove data on uninstall: ist die Option aktiviert, entfernt das Löschen des Plugins alle Einstellungen von SMSA Express und die Zonenmethoden. Das Deaktivieren des Plugins löscht nie etwas.

So funktioniert es in der Kasse

Wenn der Kunde eine Lieferadresse eingibt, fragt WooCommerce das Plugin nach einem Preis. Das Plugin prüft zuerst die Bedingungen: Lieferland, Warenkorbgewicht, Mindestbestellwert und ausgeschlossene Versandklassen. Gilt kostenloser Versand und hat das Ziel einen Preis, wird die Methode mit einem Preis von 0 angezeigt.

Sind Live-Tarife aktiviert, sendet das Plugin an SMSA Ihre Versandstadt und Ihr Versandland, die Stadt und das Land des Kunden, die Sendungsart, das Paketgewicht in kg und einen Nachnahmebetrag von 0. SMSA antwortet mit dem Tarif und seiner Währung. Das Plugin rechnet ihn in Ihre Shopwährung um und zeigt ihn an. Ein Live-Tarif wird erst angefragt, nachdem der Kunde eine Stadt eingegeben hat.

Jeder Tarif wird eine Stunde lang zwischengespeichert, damit derselbe Warenkorb keine neue Anfrage auslöst. Eine fehlgeschlagene Anfrage wird fünf Minuten lang zwischengespeichert. Nach einem Timeout oder Serverfehler wird SMSA zwei Minuten lang nicht erneut angefragt. Nach einem abgelehnten Schlüssel wird fünf Minuten lang nicht angefragt. So wartet die Kasse bei jeder Aktualisierung nie auf einen fehlerhaften Dienst. Das Timeout der Anfrage beträgt 12 Sekunden.

Liefert SMSA keinen brauchbaren Tarif (kein passKey, noch keine Stadt eingegeben, fehlende Produktgewichte, ein ungültiger Schlüssel, ein Timeout, ein Fehler, kein Service in die Stadt oder eine unbekannte Währung), wird die Preistabelle verwendet. Liefern die Tabelle und Price for countries not in the table keinen Preis, wird die Methode ausgeblendet. Der Kunde sieht nie eine Fehlermeldung. Der Grund wird im Protokoll festgehalten.

Die Methode funktioniert in der klassischen Kasse sowie im Warenkorb- und im Kassen-Block. Sie ist mit der hochperformanten Bestellspeicherung von WooCommerce (HPOS) kompatibel. Eine arabische Übersetzung ist enthalten.

Das Plugin berechnet nur den Versandpreis. Es erstellt keine SMSA-Sendungen, druckt keine AWB-Etiketten, verarbeitet keine Retouren und verfolgt keine Pakete. Nachnahme und deren Gebühr sind nicht im Live-Tarif enthalten. Eine Auswahl von SMSA-Filialen gibt es nicht: Die Methode ist Haus-zu-Haus-Zustellung.

Lizenzschlüssel

Das Plugin funktioniert mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock steht oben unter WooCommerce > Settings > Shipping > VibeFox SMSA Express. Fügen Sie den Schlüssel in License key ein und klicken Sie auf Activate. Der Block zeigt den Status, zum Beispiel 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 funktioniert auf einer 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 SMSA Express Kunden in der Kasse nicht angezeigt. Angemeldete Shopmanager sehen es weiterhin, markiert mit (unlicensed — visible to admins only), damit Sie das Plugin einrichten und testen können, bevor Sie einen Schlüssel kaufen. Auf der Seite Plugins und auf WooCommerce-Seiten erscheint ein Hinweis. Bestehende Bestellungen sind nicht betroffen.

Läuft eine Lizenz ab, funktioniert das Plugin weiter, für Updates und Support ist aber eine Verlängerung nötig. Der Status wird im Hintergrund automatisch erneut geprüft.

Fehlerbehebung

SMSA Express erscheint nicht in der Kasse: Prüfen Sie, ob die Lizenz aktiv ist, Enable/Disable eingeschaltet ist und die Methode der Zone des Kundenlandes hinzugefügt ist (oder Ignore shipping zones aktiviert ist und das Land erlaubt ist). Prüfen Sie die Gewichtsgrenzen, Minimum order amount und Excluded shipping classes. Prüfen Sie, ob das Land oder * einen Preis hat oder Price for countries not in the table gesetzt ist.

Kunden sehen den Tabellenpreis statt des SMSA-Tarifs: SMSA braucht die Stadt des Kunden, daher wird bis zu ihrer Eingabe der Tabellenpreis angezeigt. Die Tabelle wird auch verwendet, wenn SMSA nicht antwortet, den Schlüssel oder die Stadt ablehnt oder den Tarif in einer Währung ohne Wechselkurs liefert. Den Grund finden Sie unter WooCommerce > Status > Logs, Quelle vfd_smsa_express.

„Invalid Passkey“ im Protokoll: Der Schlüssel wird vom SMSA-Webservice nicht akzeptiert. Fragen Sie SMSA nach einem passKey für den Webservice.

Die Stadt des Kunden wird nicht akzeptiert: SMSA erwartet seine eigene Schreibweise der Städte. Entwickler können die Anfrage anpassen, zum Beispiel den Stadtnamen, über den Filter vfd_smsa_express_live_request_fields.

Die Versandkosten werden doppelt versteuert: Ihre Preisliste oder die SMSA-Tarife enthalten die Mehrwertsteuer möglicherweise schon. Setzen Sie Tax status auf None.

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

Der Lizenzblock zeigt einen Fehler: Folgen Sie der Meldung im Block. Ist der Schlüssel zum Beispiel bereits auf einer anderen Domain verwendet, geben Sie in Ihrem vibefox.net-Konto einen Platz 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. Ist der Lizenzserver nicht erreichbar, 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, Zonenmethoden und zwischengespeicherte Tarife werden nur entfernt, wenn Remove data on uninstall aktiviert war. Andernfalls bleiben sie für eine spätere Neuinstallation erhalten. Bestehende Bestellungen behalten ihre Versandpositionen.

SMSA Express ist eine Marke ihres jeweiligen Inhabers. Dieses Plugin ist weder mit SMSA Express verbunden noch wird es von SMSA Express unterstützt.