Get the hosted storefront status
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/hosting/production';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Responses
Section titled “Responses”object
The deployment the store’s storefront serves, or null when the shared storefront does.
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.
Why the last rollout failed, or null. The store keeps serving what it served before.
The addresses the storefront answers on.
Whether the store’s plan includes hosting. Without it the shared storefront serves the store.
Example
{ "state": "none"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The resource does not exist in this store.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}