VibeFox Correos CityPaq 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.

Lieferung nach Spanien: CityPaq-Automaten gibt es nur in Spanien, daher wird der Versanddienstleister nur für Lieferadressen in Spanien angeboten.

Correos-API-Zugangsdaten (nur für die Live-Liste der Automaten): Die Correos-CityPaq-Liste liest die aktiven Automaten aus der Correos-API „terminals“. Öffnen Sie im Correos-Entwicklerportal die API „terminals“ und nutzen Sie Request access für Ihre Anwendung. Correos genehmigt Anfragen seiner Geschäftskunden und sendet eine Client-ID und ein Client-Secret. Beide werden außerdem unter My applications im Portal angezeigt. Wenn Kunden den Automaten selbst eingeben oder aus Ihrer eigenen Liste wählen, benötigen Sie keine API-Zugangsdaten.

VibeFox-Lizenzschlüssel: erhältlich auf vibefox.net. Ein Schlüssel gilt 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 Correos CityPaq später in der Modulliste und klicken Sie dort 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üllen Sie die Preistabelle aus, wählen Sie, wie der Kunde den Automaten auswählt (siehe Konfiguration), und klicken Sie auf Save.

Bei der Installation legt das Modul den Versanddienstleister Correos CityPaq mit dem Liefertext Delivery to a Correos CityPaq parcel locker an. Der Versanddienstleister wird allen Kundengruppen und der Zone Spanien 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 aus dem Modul.

Konfiguration

Alle Einstellungen befinden sich auf der Modulseite: Modules > Module Manager > VibeFox Correos CityPaq > Configure. Jeder Abschnitt hat eine eigene Schaltfläche Save, die die gesamte Seite speichert. Preise und Beträge akzeptieren ein Dezimalkomma oder einen Dezimalpunkt.

Warnungen über den Einstellungen informieren Sie, wenn der Versanddienstleister nicht gefunden wurde, wenn die Preistabelle weder eine Zeile für Spanien noch eine Standardzeile hat, wenn die gewählte Automatenauswahl nicht funktionieren kann (keine Automaten in Ihrer Liste, keine API-Zugangsdaten), welcher Correos-API-Fehler zuletzt auftrat und wenn die Gewichtseinheit Ihres Shops dem Modul nicht bekannt ist (Produktgewichte werden dann als kg gelesen; stellen Sie kg, g, lb oder oz unter International > Localization ein). Ist der Name leer, ungültig oder länger als 64 Zeichen, ist ein Gewicht oder Betrag keine gültige Zahl von 0 oder mehr, oder ist Min weight (kg) größer als Max weight (kg), zeigt die Seite einen Fehler und es wird nichts gespeichert. Ungültige Preise in der Preistabelle sowie ungültige oder doppelte Zeilen in My lockers werden als Warnungen gemeldet, der Rest wird gespeichert.

Allgemein

CityPaq-Automaten gibt es nur in Spanien, daher wird der Versanddienstleister nie für andere Länder angeboten.

Enable/Disable: schaltet den Versand über Correos CityPaq ein oder aus. Es ist derselbe Schalter wie der Status des Versanddienstleisters unter Shipping > Carriers.

Name: der Name der Versandart, den der Kunde an der Kasse sieht. Er ist auch der Name des Versanddienstleisters. Standard: Correos CityPaq. Pflichtfeld, höchstens 64 Zeichen.

Tax: die Steuerregel des Versanddienstleisters. PrestaShop schlägt diese Steuer auf die Preise aus der Tabelle auf. No tax bedeutet, dass die Preise endgültig sind.

Preise (der Abschnittstitel zeigt die Standardwährung Ihres Shops)

Correos veröffentlicht für CityPaq keine Tarif-API, daher stammt der Preis aus dieser Tabelle. Geben Sie Ihre Vertragspreise mit Correos in der Standardwährung des Shops ein, ohne Steuer.

Price table: eine Zeile für Spain (ES) und/oder eine Standardzeile * Default. Jede Zeile hat einen Grundpreis Price und optionale Preise für die Paketgrößen XS (bis 1 kg), S (bis 2 kg), M (bis 3 kg), L (bis 5 kg) und XL (über 5 kg). Ein Größenpreis von 0 oder leer verwendet den Grundpreis. Klicken Sie auf + Add row, um eine Zeile hinzuzufügen, und auf das Papierkorbsymbol, um eine zu entfernen. Ohne passende Zeile wird der Versanddienstleister ausgeblendet. Erscheint ein Land zweimal, wird nur die erste Zeile verwendet.

Calculation type: wie die Paketgröße ermittelt wird.

Produktgewichte werden aus der Gewichtseinheit Ihres Shops in kg umgerechnet (zum Beispiel kg, g, lb oder oz).

Bedingungen

Min weight (kg): blendet den Versanddienstleister aus, wenn der Warenkorb leichter ist. 0 bedeutet keine Begrenzung.

Max weight (kg): blendet den Versanddienstleister aus, wenn der Warenkorb schwerer ist. Standard: 30, weil CityPaq Pakete bis 30 kg annimmt. 0 bedeutet keine Begrenzung.

Minimum order amount: zeigt den Versanddienstleister nur an, wenn die Zwischensumme des Warenkorbs (Produkte mit Versand, nach Rabatten, vor Steuern) diesen Betrag erreicht. Leer lassen, um ihn immer anzuzeigen.

Kostenloser Versand

Free shipping: aktiviert die kostenlose CityPaq-Lieferung ab dem unten angegebenen Betrag.

Free shipping from: die Zwischensumme des Warenkorbs (nach Rabatten, vor Steuern), ab der dieser Versanddienstleister 0 kostet. Wird nur verwendet, wenn Free shipping aktiviert ist.

Automatenauswahl CityPaq

Der Abschnitt enthält einen Link zum offiziellen CityPaq-Finder von Correos.

Locker selection: wie der Kunde den Automaten vor der Bestellung auswählt. Standard: Der Kunde gibt den Automaten ein.

Wenn Sie die Correos-Liste ohne API-Zugangsdaten wählen oder Ihre eigene Liste, während My lockers leer ist, werden Kunden aufgefordert, den Automaten einzugeben.

My lockers: wird verwendet, wenn Locker selection auf Ihre Liste eingestellt ist. Ein Automat pro Zeile: CODE | Name | Address | Postal code | City. Code und Name sind Pflichtfelder. Steht ein Code zweimal, wird nur die erste Zeile verwendet.

Correos-CityPaq-Liste (API) (wird nur mit der Correos-CityPaq-Liste verwendet)

Der Abschnitt enthält einen Link zur Seite der API „terminals“ im Correos-Entwicklerportal. Gelesen wird nur die Automatenliste. Die Preise stammen immer aus der Preistabelle.

API client ID: die client_id Ihrer Anwendung im Correos-Entwicklerportal.

API client secret: das client_secret Ihrer Anwendung im Correos-Entwicklerportal.

Nach dem Speichern bleiben beide Felder leer und zeigen Saved - leave empty to keep it. Geben Sie nur dann einen neuen Wert ein, wenn Sie ihn ändern möchten. Setzen Sie das Häkchen bei Remove the saved client ID and client secret und klicken Sie auf Save, um sie zu löschen. Ist nichts gespeichert, zeigt der Abschnitt No credentials saved. Ändern Sie die Zugangsdaten oder die Automatenauswahl, werden die zwischengespeicherten Automatenlisten gelöscht.

Verfügbarkeit ohne Versandzonen

Ignore shipping zones: bietet CityPaq für jede spanische Adresse an, auch wenn die Zone der Adresse nicht mit dem Versanddienstleister verknüpft ist. Ist die Option aktiv, wird der Versanddienstleister mit allen aktiven Zonen verknüpft, auch mit später angelegten. Wird sie wieder deaktiviert, erhält der Versanddienstleister die Zonen zurück, die er vorher hatte. Aus (empfohlen) bedeutet, dass die unter Shipping > Carriers festgelegten Zonen verwendet werden.

Erweitert

Debug log: schreibt Debug-Zeilen in logs/vfd_cpq_debug.log.php im Modulordner. Die Datei lässt sich nicht über das Web öffnen. Correos-API-Fehler werden immer geschrieben, auch wenn dies deaktiviert ist. Zugangsdaten und personenbezogene Daten werden nie protokolliert.

Log: zeigt 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, zwischengespeicherte Listen und Protokolle. In Bestellungen gespeicherte Automaten bleiben erhalten. 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 CityPaq-Preis. Nur physische Produkte zählen: Virtuelle Produkte erhöhen das Gewicht nicht und werden nicht in den Bestellwert eingerechnet. Das Modul prüft, ob die Lieferadresse in Spanien liegt, das Warenkorbgewicht und den Mindestbestellwert, findet die Preiszeile für Spanien (oder die *-Zeile) und die Paketgröße und gibt den Preis zurück. Gilt der kostenlose Versand, beträgt der Preis 0. Der Preis wird in der Standardwährung Ihres Shops berechnet und dann in der Warenkorbwährung des Kunden angezeigt. Die Steuer wird über die Steuerregel des Versanddienstleisters hinzugefügt.

Wählt der Kunde CityPaq, erscheint das Feld CityPaq locker unter dem Versanddienstleister. Die Auswahl wird sofort im Warenkorb gespeichert. Ein nicht zulässiger Automat wird mit einer Meldung abgelehnt, die vorherige Auswahl bleibt erhalten. Bei der Correos-Liste wird ein Automatencode nur akzeptiert, wenn Correos ihn für die gesuchte Postleitzahl angeboten hat; Name und Adresse werden von Correos übernommen. Ein Kunde kann pro Warenkorb bis zu 30 verschiedene Postleitzahlen suchen. Danach sieht er Zu viele Suchanfragen. Bitte geben Sie den CityPaq-Automaten ein, den Sie auf der Correos-Karte gefunden haben.

Die Schaltfläche Continue im Versandschritt führt ohne gültigen Automaten nicht weiter. Dies wird auch serverseitig geprüft. Der Kunde sieht zum Beispiel Bitte wählen Sie den CityPaq-Automaten, an dem Sie Ihr Paket abholen möchten. Wird die Bestellung aufgegeben, wird der Automat des Warenkorbs in der Bestellung gespeichert.

Die Correos-Liste wird nur abgefragt, wenn der Kunde CityPaq wählt, nicht für jeden Besucher des Versandschritts. Eine Liste wird 12 Stunden pro Postleitzahl zwischengespeichert. Eine fehlgeschlagene Anfrage wird 10 Minuten zwischengespeichert, damit die Kasse bei jeder Aktualisierung nicht auf Correos warten muss. Das API-Timeout beträgt 12 Sekunden. Der Kunde sieht nie den technischen Fehler, nur eine kurze Meldung und das manuelle Feld. Das Automatenfeld funktioniert mit den Themes Classic und Hummingbird.

Das Modul ruft keine Live-Tarife von Correos ab, zeigt keine Karte, meldet keine Sendungen vorab an, druckt keine Etiketten, bestellt keine Abholungen und verfolgt keine Pakete. Legen Sie die Sendung in Ihrem Correos-Konto mit dem in der Bestellung gespeicherten Automaten an.

Abholstellen

Der gewählte Automat wird in der Bestellung gespeichert. Der Kunde sieht ihn als CityPaq locker: auf der Bestellbestätigungsseite und auf der Bestelldetailseite in seinem Kundenkonto. In der Bestellbestätigungs-E-Mail und in der E-Mail für neue Bestellungen des Moduls Mail alerts wird der Automat der Versandzeile hinzugefügt, zum Beispiel Correos CityPaq - CityPaq locker: ....

Auf der Bestellseite im Admin-Bereich zeigt der Block CityPaq locker den Automaten und seinen Locker code:, wenn er aus einer Liste gewählt wurde. Zum Ändern verwenden Sie das Feld Change CityPaq locker und klicken auf Save: Mit Ihrer Liste wählen Sie einen anderen Automaten aus der Auswahlliste; mit der Correos-Liste geben Sie einen Automatencode (wird bei Correos nachgeschlagen) oder eine Adresse ein; sonst geben Sie einen neuen Code oder eine neue Adresse ein. Lassen Sie das Feld leer, um den aktuellen Automaten zu behalten. Jede Änderung fügt eine private Bestellnachricht hinzu: CityPaq-Automat geändert zu: .... Das Ändern des Automaten erfordert die Berechtigung, Bestellungen zu bearbeiten. Der Zugriff auf die Seiten unter Modules ist nicht nötig.

Lizenzschlüssel

Das Modul arbeitet mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock License — VibeFox Correos CityPaq ist der erste Block auf Modules > Module Manager > VibeFox Correos CityPaq > Configure, oberhalb der Einstellungen. Geben 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 aktiv 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-correos-citypaq 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. Nachdem sich die Shop-Adresse geändert hat oder Sie einen Domain-Platz in Ihrem Konto freigegeben haben, klicken Sie auf Check now. Kann der Lizenzserver nicht erreicht werden, 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-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 einen aktiven Schlüssel wird der Versanddienstleister Correos CityPaq 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 ist der Versanddienstleister auch für Sie ausgeblendet: Sie können das Modul einrichten, bevor Sie einen Schlüssel kaufen, aber nicht an der Kasse testen. Eine Erinnerung 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 ist nicht nötig. Das Deinstallieren oder Zurücksetzen des Moduls entfernt immer den Lizenzschlüssel und den Lizenzstatus.

Fehlerbehebung

Correos CityPaq erscheint nicht an der Kasse: Prüfen Sie, ob die Lizenz aktiv ist, Enable/Disable eingeschaltet ist und die Lieferadresse in Spanien liegt. Prüfen Sie unter Shipping > Carriers, ob der Versanddienstleister die Zone Spanien und die Kundengruppe abdeckt (oder aktivieren Sie Ignore shipping zones). Prüfen Sie, ob die Preistabelle eine Zeile für Spanien oder eine *-Zeile hat und ob der Warenkorb innerhalb der Gewichtsgrenzen und von Minimum order amount liegt. Außerdem können Produkte auf der Produktseite auf bestimmte Versanddienstleister beschränkt sein.

Kunden müssen den Automaten eintippen, obwohl die Correos-Liste gewählt ist: Prüfen Sie, ob API client ID und API client secret gespeichert sind, und lesen Sie die Warnung über den Einstellungen. Dort steht der letzte Correos-API-Fehler. HTTP 401/403 bedeutet, dass Correos die Zugangsdaten abgelehnt hat: Prüfen Sie diese und ob Ihre Anwendung Zugriff auf die API „terminals“ hat. Nach einem Fehler wird der nächste Versuch nach 10 Minuten unternommen.

Keine Automaten für eine Postleitzahl: Correos hat für diese Postleitzahl, ihr Gebiet oder ihre Provinz keinen aktiven Automaten gefunden. Der Kunde kann eine andere Postleitzahl suchen oder den Automaten eingeben, den er auf dem CityPaq-Finder von Correos findet.

Die Auswahlliste meiner Automaten erscheint nicht: My lockers ist leer oder seine Zeilen sind ungültig. Jede Zeile braucht mindestens CODE | Name.

Wo Kunden den Automatencode finden: auf dem CityPaq-Finder von Correos, der unter dem Automatenfeld verlinkt ist.

Die Seite meldet, dass der Versanddienstleister nicht gefunden wurde oder nicht aktualisiert werden konnte: Der Versanddienstleister wurde unter Shipping > Carriers gelöscht. Setzen Sie das Modul unter Modules > Module Manager zurück, um ihn neu anzulegen. Das Zurücksetzen behält die Einstellungen und den Status des Versanddienstleisters bei.

Entwicklerhinweise: Der Automat eines Warenkorbs und einer Bestellung wird in der Tabelle vfd_cpq_locker gespeichert (mit Ihrem Datenbank-Präfix). Das Modul verwendet die produktive Correos-API „terminals“.

Deinstallation

Gehen Sie zu Modules > Module Manager, öffnen Sie das Menü neben VibeFox Correos CityPaq und wählen Sie Uninstall. Der Lizenzschlüssel, der Lizenzstatus, die zwischengespeicherten Correos-Automatenlisten und der letzte API-Fehler werden immer entfernt. Ist Remove data on uninstall aktiv, wird der Versanddienstleister gelöscht (Bestellungen behalten ihren Verlauf), und die Einstellungen, das Protokoll und die Automaten von Warenkörben ohne Bestellung werden entfernt. Ist die Option aus, wird der Versanddienstleister nur deaktiviert und alle Einstellungen bleiben erhalten. Eine erneute Installation stellt den vorherigen Status des Versanddienstleisters wieder her. In Bestellungen gespeicherte Automaten werden nie gelöscht.

Correos und CityPaq sind Marken ihrer jeweiligen Inhaber. Dieses Modul ist weder mit Correos verbunden noch von Correos unterstützt.