API-Referenz Shop-Modi

Über den Endpunkt shopStatus/ wird eine Schnittstelle bereitgestellt, mit der sich vor dem Live-Schalten eines Subshops überprüfen lässt, ob alle Voraussetzungen dafür erfüllt sind. Die eigentliche Statusänderung erfolgt nicht über diesen Endpunkt, sondern als regulärer Schreibzugriff auf die Konfiguration.

Eine fachliche Beschreibung der drei Modi und des Wechsels zwischen ihnen findet sich unter Shop-Modi.

---

Unterstützte Methoden

Angabe aller unterstützten Methoden

Befehl/Info	Endpunkte	DELETE	GET	POST	PUT
Bereitschaftsprüfung	shopStatus/goLive/{subshopId}

Methode für die Bereitschaftsprüfung

Mithilfe der folgenden Methode wird geprüft, ob ein Subshop in den Aktiv-Modus wechseln darf. Sie ist rein lesend und nimmt keine Änderungen vor. Es werden alle aktiven Online-Zahlungsarten geprüft. Befindet sich eine dieser Zahlungsarten noch im Sandbox-Modus, wird sie als Blocker gemeldet.

Für die Anwendung dieser Methode müssen entsprechende Berechtigungen zum Lesen von Konfigurationsdaten vorhanden sein.

GET shopStatus/goLive/

Prüft für den angegebenen Subshop, ob die Voraussetzungen für einen Wechsel in den Modus “Aktiv” erfüllt sind.

Beispiel

http://www.<ihr-shop>.de/admin/api/v1/shopStatus/goLive/deutsch

Antwort - Bereitschaft erfüllt

{
    "allowed": true
}

Antwort - Blocker gefunden (Zahlungsmethode PayPal im Sandbox-Modus)

{
    "allowed": false,
    "blockers": {
        "paypal": "sandbox"
    }
}

Antwortfelder

Name	Typ	Bedeutung
allowed	bool	true, wenn keine Blocker gefunden wurden und der Wechsel auf “Aktiv” zulässig ist. false, wenn Blocker gefunden wurden.
blockers	object	Nur vorhanden, wenn allowed = false. Schlüssel: technischer Bezeichner der blockierenden Zahlungsart. Wert: Grund der Blockung (z.B. sandbox).

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert. Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Konfigurationsdaten.

Setzen des Status
In dieser Schnittstelle gibt es keine eigene Methode zum Setzen des Status. Die Statusänderung erfolgt als regulärer Schreibzugriff auf den Konfigurationsknoten mit dem Body { "data": { "status": "active" } } . Siehe API-Referenz Konfiguration.

Beim Setzen des Status direkt über den Konfigurations-Endpunkt findet keine Bereitschaftsprüfung statt. Der Wechsel auf active wird auch dann übernommen, wenn aktive Online-Zahlungsarten noch im Sandbox-Modus laufen. Rufen Sie deshalb vor dem Setzen unbedingt die hier beschriebene GET-Methode auf, um die Prüfung nicht zu umgehen.