Skip to content

Stop serving hosted code

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

Returns the store to the shared storefront. If the live theme uses a build, it goes back to its newest catalog release. The deployments and their builds are kept.

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>

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"
}