Skip to content

Get the hosted storefront status

GET
/stores/{storeRef}/hosting/production
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/hosting/production \
--header 'x-api-key: <x-api-key>'

Returns which deployment the store’s storefront serves, the state of the rollout, the addresses it answers on, and whether the store’s plan includes Hosting. Without Hosting in the plan the shared storefront serves the store whatever the stored state says.

Required scopes: deploy:storefront

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
deployment_id
required

The deployment the store’s storefront serves, or null when the shared storefront does.

string
nullable
state
required

none: the shared storefront serves the store. rolling_out: a deployment is being put live and the previous one keeps serving. running: it is serving. degraded: it has a problem.

string
Allowed values: none rolling_out running degraded
rollout_error
required

Why the last rollout failed, or null. The store keeps serving what it served before.

string
nullable
urls
required

The addresses the storefront answers on.

Array<string>
entitled
required

Whether the store’s plan includes hosting. Without it the shared storefront serves the store.

boolean

Example

{
"state": "none"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}