Github

Store Credit
432200895 Bb12d407 D013 41dd B97e C3d08112c054

Table of content

Free 15 min initial consultation directly with our experts.

Free consultation +49 421 438 1919–0

Einleitung

Das Store Credit Plugin für Shopware 6 bietet eine flexible und bequeme Lösung für die Verwaltung von Rückgaben und Rückerstattungen von Kunden. Anstatt herkömmliche Rückerstattungen zu bearbeiten, können Shop-Administratoren Store Credit direkt auf das Kundenkonto gutschreiben. Dieses Guthaben kann anschließend für zukünftige Einkäufe verwendet werden, sodass Kunden weiterhin im Shop einkaufen können, während ihr Geld innerhalb des Stores bleibt.
Das Plugin stellt sicher, dass Store Credits über mehrere Bestellungen hinweg angewendet werden können, bis der zugewiesene Betrag vollständig genutzt ist, wodurch Kunden maximale Flexibilität bei der Einlösung ihrer Guthaben erhalten.

Administratoren haben volle Kontrolle über die Vergabe, Nachverfolgung und Verwaltung von Guthaben, was eine präzise Buchführung und ein nahtloses Kundenerlebnis ermöglicht. Durch die Bereitstellung von Store Credit anstelle von Rückerstattungen können Händler die Kundenbindung verbessern, Transaktionsgebühren reduzieren und wiederholte Einkäufe fördern, während der Rückgabeprozess effizienter gestaltet wird. Das Store Credit Plugin integriert sich nahtlos in die Shopware-Umgebung, sodass Guthaben einfach beim Checkout angewendet und im Admin-Panel vollständig überwacht werden können.

Hauptfunktionen

  • Verwaltung von Store-Guthaben: Administratoren können Store-Guthaben für Kunden hinzufügen, entfernen und anpassen.

  • Teilweise Nutzung: Kunden können ihr Store-Guthaben über mehrere Bestellungen hinweg verwenden, bis es vollständig verbraucht ist.

  • Nahtlose Checkout-Integration: Kunden können das Store-Guthaben während des Checkouts zusammen mit anderen Zahlungsmethoden einlösen.

  • Transaktionsverlauf: Kunden und Administratoren können den Verlauf der Store-Guthaben-Transaktionen einsehen.

Kompatibilität

  • ✅ Shopware 6.6.x

Erste Schritte
Installation & Aktivierung
1. Download

  • Plugin-Repository klonen:

  • Öffnen Sie Ihr Terminal und führen Sie den folgenden Befehl im Custom-Plugins-Verzeichnis von Shopware 6 aus (in der Regel unter custom/plugins/ zu finden):

git clone https://github.com/solution25com/store-credit-shopware-6-solution25.git

2. Plugin in Shopware 6 installieren

  • Melden Sie sich im Shopware-6-Administrationsbereich an.

  • Navigieren Sie zu Erweiterungen > Meine Erweiterungen.

  • Suchen Sie das neu geklonte Plugin und klicken Sie auf Installieren.

3.Activate the Plugin

  • Klicken Sie nach der Installation auf Aktivieren, um das Plugin zu aktivieren.

  • Gehen Sie im Shopware-Adminbereich zu Einstellungen > System > Plugins.

  • Laden Sie das Plugin „Store Credit“ hoch oder installieren Sie es.

  • Nach der Installation aktivieren Sie das Plugin über den Schalter.

4. Installation überprüfen

  • Nach der Aktivierung sehen Sie Store Credit in der Liste der installierten Plugins.

  • Der Plugin-Name, die Version und das Installationsdatum sollten wie im untenstehenden Screenshot angezeigt werden.

432200996 Ee52304c 21f8 42a8 9f12 A90287bc1327

Plugin-Konfiguration

1. Auf die Plugin-Einstellungen zugreifen

  • Gehen Sie zu Einstellungen > System > Plugins.

  • Suchen Sie Store Credit und klicken Sie auf das Drei-Punkte-Symbol (…) oder auf den Plugin-Namen, um die Einstellungen zu öffnen.

2. Allgemeine Einstellungen
1.Minimale Konfiguration:Nach der Installation des Store-Credit-Plugins müssen Sie in der Konfiguration den Store-Credit-Rückerstattungstyp aktivieren.
Da dieses Plugin mit Swag Commercial verknüpft ist, muss der Schalter für die Option Store Credit Refund Type aktiviert werden, um Rückerstattungen per Store Credit zu ermöglichen.

432201195 1b9a2531 5ce2 4c69 95ff Bcf934d5375f

2.Store Credit Add State: Aktivieren oder deaktivieren Sie diese Funktion über den Schalter.
3.Post-Purchase-Funktionen: Beschränken Sie die Nutzung des Store-Guthabens auf bestimmte Produkte.

432201310 6c0da891 9f8d 4f72 Bb91 1379a1862491

Funktionsweise

Nach der Installation und Aktivierung des Plugins im Administrationsbereich können Kunden ihr verfügbares Guthaben sowie den Transaktionsverlauf in den Profileinstellungen ihres Kundenkontos im Storefront einsehen.

432201402 5005aaea 4109 4b3f Bff8 B1bf9b268b3c

Administratoren können Store-Guthaben manuell zum Kundenkonto hinzufügen oder davon abziehen.

432201508 1486cb7b B82f 4817 B958 038283332661
432201532 Ec63a465 A4e7 49b5 A5e4 985c95676857

Rückerstattungen & Gutschriften-Workflow

  • Bei der Bearbeitung einer Rücksendung wählen Sie die Option „Als Store Credit erstatten“.

  • Der erstattete Betrag wird dem Store-Guthaben des Kunden hinzugefügt.

  • Kunden können das Store-Guthaben für zukünftige Einkäufe verwenden.

  • Alle Transaktionen werden zur Nachverfolgung in der Tabelle store_credit_history protokolliert.

432201644 1e6d6251 8579 4d66 9dfe 466993b49583

Rückerstattungen & Store-Credit-Verwaltung

Teilweise & vollständige Rückerstattungen:

  • Bei der Erstellung einer Rückerstattung können Sie zwischen einer teilweisen oder vollständigen Rückerstattung als Store Credit wählen.

  • Der erstattete Betrag wird automatisch dem Store-Guthaben des Kunden gutgeschrieben.

  • Der Bestellstatus wird entsprechend aktualisiert.

Projektstruktur

Storefront – Wichtige Dateien/Ordner

  • Controller-Ordner: Definiert die Store-Credit-Guthabentabelle sowie den Store-Credit-Verlauf über eine API.

  • CartSubscriber.php: Prüft, ob der Benutzer Store Credit verwendet hat.

  • OrderRefundSubscriber.php: Verarbeitet die Option „Rückerstattung als Store Credit“.

  • CustomCheckoutController.php: Definiert Store Credit als Zahlungsoption.

Core – Wichtige Dateien/Ordner

  • Entities/StoreCredit.php: Verwaltet das Datenmodell für Store Credit.

  • Entities/StoreCreditHistory.php: Protokolliert Store-Credit-Transaktionen.

Resources – Wichtige Dateien/Ordner

  • services.xml: Registriert Services für die Dependency Injection.

  • routes.xml: Deklariert API-Routen.

Admin-Bereich – Zentrale Funktionen

  • Einsehen des Verlaufs sowie Hinzufügen und Abziehen von Store Credit in den Kundendetails.

  • Erstellen von Berichten zur Nutzung des Store Credits.

API-Endpunkte

Get Store Credit Balance
– Pfad: /store-api/store-credit/balance/{customer_id}
– Methode: GET
– Zweck: Ruft das aktuelle Store-Credit-Guthaben eines Kunden ab.
– Antwort: Gibt das verfügbare Guthaben zurück.

Add Store Credit
– Pfad: /store-api/store-credit/add
– Methode: POST
– Request Body:
– customer_id (string, erforderlich)
– amount (float, erforderlich)
– reason (string, optional)
– Antwort: Gibt die aktualisierten Store-Credit-Daten zurück.

Deduct Store Credit
– Pfad: /store-api/store-credit/deduct
– Methode: POST
– Request Body:
– customer_id (string, erforderlich)
– amount (decimal, erforderlich)
– order_id (string, optional)
– Antwort: Gibt die aktualisierten Store-Credit-Daten zurück.

– Refund to Store Credit
– Pfad: /store-api/store-credit/add
– Methode: POST
– Request Body:
– order_id (string, erforderlich)
– amount (decimal, erforderlich)
– Antwort: Rückerstattung wird verarbeitet und im Store-Credit-Verlauf protokolliert.
– reason (string, optional)

Verwendung durch Endkunden – Checkout-Integration

  • Kunden können beim Checkout wählen, ihr Store-Guthaben als Zahlungsmethode zu verwenden.

432201767 02ec29e2 17b6 4f25 9b9c Fd8a387c2b7b

  • Teilweise und vollständige Nutzung von Store Credit wird unterstützt.

  • Der verbleibende Betrag wird über eine alternative Zahlungsmethode beglichen.

  • Wenn ein Administrator eine Bestellung erstellt, kann er die Store Credits des gewählten Kunden verwenden. Zuerst wird das Produkt bei der Erstellung der Admin-Bestellung hinzugefügt, dann fügen Sie einen weiteren Posten als Guthaben hinzu und verwenden den spezifischen Namen „Store credit discount“.

Store Credit hinzufügen 

POST /api/store-credit/add

Beschreibung 

Adds a store credit amount to a specific customer’s balance. This can optionally be linked to an order and currency.

Request Headers 

Authorization: Bearer
Content-Type: application/json

Beispiel für den Request-Body 

{
  "customerId": "3c2a178f96b7345ad27051c34609e52",
  "amount": 50.0,
  "reason": "Manual admin adjustment"
}

Erfolgreiche Antwort 

{
  "success": true,
  "historyId": "f84b5a7a4fce4a1db9d693c8be304a1e"
}

Beispiel für eine Fehler-Antwort 

{
  "success": false,
  "message": "Customer ID is missing."
}

Store Credit abziehen 

POST /api/store-credit/deduct

Beschreibung 

"Zieht einen Store-Credit-Betrag vom Guthaben eines Kunden ab. Die Abziehung kann einen Grund zur Protokollierung enthalten."

Request-Headers 

Authorization: Bearer
Content-Type: application/json

Beispiel für den Request-Body 

{
  "customerId": "3c2a178f96b7345ad27051c34609e52",
  "amount": 20.0,
  "reason": "Refund adjustment"
}

Erfolgreiche Antwort 

{
  "success": true,
  "historyId": "a9d2554b0ce847cd82f3ac9bd1c0aa2f"
}

Beispiel für eine Fehler-Antwort 

{
  "success": false,
  "message": "Amount exceeds the maximum allowed credit for order."
}

{
  "success": true,
  "historyId": "a9d2554b0ce847cd82f3ac9bd1c0aa2f"
}

{
  "success": true,
  "historyId": "a9d2554b0ce847cd82f3ac9bd1c0aa2f"
}

Store-Credit-Guthaben abrufen

Endpunkt

Beschreibung

Ruft das aktuelle Store-Credit-Guthaben eines Kunden ab.

Request-Headers 

Authorization: Bearer<

Beispiel-Request 

GET /api/store-credit/balance?customerId=3c2a178f96b7345ad27051c309e52

Erfolgreiche Antwort 

{
  "success": true,
  "balance": 80.0,
  "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca"
}

Beispiel für eine Fehler-Antwort 

{
  "success": false,
  "message": "Customer not found."
}

Authentifizierungshinweis

Diese Endpunkte sind geschützt und erfordern ein Bearer-Token, das über die Shopware-Admin-API erhalten wird.

Best Practices

1.Store-Credit-Rückerstattungen aktivieren
Stellen Sie sicher, dass die Option Store Credit Refund Type unter Einstellungen > System > Plugins aktiviert ist.
Ermöglicht, Rückerstattungen als Store Credit statt als Bargeld auszustellen.

2.Pro-Bestellung-Guthabengrenzen festlegen
Definieren Sie ein maximales Limit für die Nutzung von Store Credit pro Bestellung (z. B. 50 Euro).
Hilft, zu kontrollieren, wie viel Guthaben beim Checkout verwendet werden kann.
3.Store-Credit-Transaktionen überwachen
Überprüfen Sie regelmäßig die Store-Credit-Transaktionsprotokolle, um die Nutzung durch Kunden nachzuverfolgen.
Dies hilft, Fehler und Unstimmigkeiten zu vermeiden.
4.Kunden über ihr Guthaben informieren
Stellen Sie sicher, dass Kunden ihr verfügbares Store-Credit-Guthaben in ihrem Konto einsehen können.
Senden Sie Benachrichtigungen, wenn Store Credit hinzugefügt oder verwendet wird.

5.Vor dem Livegang testen
Testen Sie verschiedene Szenarien, wie Rückerstattungen, Teilzahlungen und Store-Credit-Anwendungen während des Checkouts.
Stellen Sie sicher, dass alles korrekt funktioniert, bevor Sie live gehen.
6.API nutzen, um individuelle Anpassungen vorzunehmen
Verwenden Sie API-Endpunkte, um Store-Credit-Regeln anzupassen und mit anderen Shop-Funktionen zu integrieren.
Dies ermöglicht Flexibilität bei der Anwendung von Store Credit.
7.Store Credit für bestimmte Produkte einschränken
Falls erforderlich, beschränken Sie die Nutzung von Store Credit auf bestimmte Produkte oder Verkaufskanäle.
Dies stellt sicher, dass Store Credit nur dort verwendet wird, wo es sinnvoll ist.

Fehlerbehebung

1.Store Credit wird beim Checkout nicht angezeigt

Stellen Sie sicher, dass der Store Credit Refund Type in den Plugin-Einstellungen aktiviert ist.

Überprüfen Sie, ob der Kunde genügend Store Credit in seinem Konto hat.

2.Rückerstattungen werden nicht als Store Credit ausgegeben

Vergewissern Sie sich, dass die Rückerstattungsmethode beim Bearbeiten von Rücksendungen auf Store Credit eingestellt ist.

Prüfen Sie auf Konflikte mit anderen rückerstattungsbezogenen Plugins.
3.Guthaben des Kunden wird nicht aktualisiert

Stellen Sie sicher, dass die geplanten Aufgaben mit den folgenden Befehlen ausgeführt werden:

bin/console scheduled-task:register
bin/console scheduled-task:run
bin/console messenger:consume

Überprüfen Sie, ob der Store-Credit-Verlauf in der Datenbank protokolliert wird.

Administratoren können Store Credit nicht ändern
4.Stellen Sie sicher, dass der Administrator die erforderlichen Berechtigungen zum Bearbeiten des Store-Credit-Guthabens der Kunden hat.

Überprüfen Sie, dass API-Aufrufe für Store-Credit-Anpassungen korrekt funktionieren.
5.Bestellungen nutzen Store Credit beim Checkout nicht

Stellen Sie sicher, dass keine Einschränkung für Store Credit bei den ausgewählten Produkten besteht.

Überprüfen Sie, dass der Guthabenbetrag innerhalb des erlaubten Limits pro Bestellung liegt.

FAQ

1.Kann ich die Nutzung von Store Credit auf bestimmte Produkte beschränken?

Ja, Sie können die Nutzung von Store Credit für bestimmte Produkte oder Kategorien über die Post-Purchase-Funktionen einschränken.
2.Wie füge ich einem Kundenkonto Store Credit hinzu?

Administratoren können Store Credit manuell über den Bereich Kundendetails im Admin-Panel hinzufügen.

3.Kann Store Credit ablaufen?

Derzeit unterstützt das Plugin keine automatische Ablauf-Funktion für Store Credit, aber diese Funktion kann angepasst werden.

4.Können Kunden ihr Store-Credit-Guthaben einsehen?

Ja, Kunden können ihr verfügbares Guthaben sowie den Transaktionsverlauf in ihren Kontoeinstellungen einsehen.

Wiki-Dokumentation

Lesen Sie mehr über die Plugin-Konfiguration in unserem WIKI.