Skip to main content
The shopStatus/ endpoint provides an interface that lets you check whether all prerequisites for switching a subshop to live are fulfilled. The actual status change is not performed via this endpoint but as a regular write access to the configuration. A functional description of the three modes and the transitions between them can be found at Shop modes.

​
Supported methods

List of all supported methods
Command/InfoEndpointsDELETEGETPOSTPUT
Readiness checkshopStatus/goLive/{subshopId}

​
Method for the readiness check

The following method checks whether a subshop is allowed to switch to active mode. It is read-only and does not make any changes. All active online payment methods are checked. If one of these payment methods is still in sandbox mode, it is reported as a blocker. To use this method you need the corresponding permissions to read configuration data.

​
GET shopStatus/goLive/{subshopId}

Checks for the specified subshop whether the prerequisites for switching to “Active” mode are fulfilled.

​
Example

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

​
Response - readiness fulfilled

{
    "allowed": true
}

​
Response - blocker found (payment method PayPal in sandbox mode)

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

​
Response fields

NameTypeMeaning
allowedbooltrue if no blockers were found and the switch to “Active” is permitted.
false if blockers were found.
blockersobjectOnly present if allowed = false.
Key: technical identifier of the blocking payment method.
Value: reason for blocking (e.g. sandbox).

​
Error codes

ErrorTypeReason
401 UnauthorizedNot authorized. You are not logged in or you do not have the required permissions to read configuration data.
Setting the status
This interface does not provide its own method for setting the status. The status change is performed as a regular write access to the configuration node with the body { "data": { "status": "active" } }. See API reference configuration.
When setting the status directly via the configuration endpoint, no readiness check is performed. The switch to active is applied even if active online payment methods are still running in sandbox mode. Therefore, always call the GET method described here before setting the status, so the check is not bypassed.