Restore a build (deprecated)
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/themes/example/versions/example/restore';const options = {method: 'POST', 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 POST \ --url https://apibase.ecomweb.app/api/v1/stores/example/themes/example/versions/example/restore \ --header 'x-api-key: <x-api-key>'Deprecated: use the route that makes a theme use a version. Makes the theme use one of its builds, named by its deployment ID or version ID, and returns the older list of builds. It answers 202. Needs the deploy:storefront scope.
Required scopes: deploy:storefront
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The theme ID.
The deployment ID or the version ID of the build.
The store’s ref, as returned by GET /stores.
Responses
Section titled “Responses”object
Why the build failed, or null.
When the build was created, as an ISO 8601 timestamp.
When the build ended, as an ISO 8601 timestamp, or null.
The deployment or version ID.
The deployment’s status.
Whether the theme uses this build.
Whether the storefront serves this build now.
Whether the build can be used.
Example generated
[ { "error": "example", "created_at": "2026-04-15T12:00:00Z", "build_finished_at": "2026-04-15T12:00:00Z", "id": "example", "status": "example", "current": true, "serving": true, "restorable": true }]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"}The request conflicts with the resource’s current state.
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"}