StorefrontStatus returns the current status of a storefront as a series of diagnostic checks

GET

/v2/storefront/status/{storefrontId}

curl --request GET \
  --url https://your-host.example/v2/storefront/status/example \
  --header 'X-Zentail-Signature: <X-Zentail-Signature>' \
  --header 'X-Zentail-Timestamp: <X-Zentail-Timestamp>'

Authorizations

• zentail_callback_signature
• zentail_callback_timestamp

Parameters

Path Parameters

storefrontId

required

string

Responses

200

A successful response.

Media typeapplication/json

StorefrontStatusResponse contains the results of all diagnostic checks

object

checks

Array<object>

object

name

string

state

CheckState represents the result state of a diagnostic check

string

default: CHECK_STATE_UNSPECIFIED

Allowed values: CHECK_STATE_UNSPECIFIED CHECK_STATE_PASS CHECK_STATE_FAIL CHECK_STATE_WARNING

stateShortDescription

string

details

string

Example

{
  "checks": [
    {
      "state": "CHECK_STATE_UNSPECIFIED"
    }
  ]
}

default

An unexpected error response.

Media typeapplication/json

object

code

integer format: int32

message

string

details

Array<object>

object

@type

string

key

additional properties

Example^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}