Push a theme's settings schema
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/themes/example/schema';const options = { method: 'PUT', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"settings_schema":[{}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://apibase.ecomweb.app/api/v1/stores/example/themes/example/schema \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "settings_schema": [ {} ] }'Sets the settings form of a theme that uses a link to your own site, so the theme editor can show the settings your site reads. The route answers 409 THEME_NOT_LINKED for any other theme: a catalog release comes with its own form and a build with the schema deployed with its code. A key with only the deploy:storefront scope can call this route.
Required scopes: deploy:storefront or write:settings
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The theme ID.
The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
The settings schema of the code the theme uses: a list of groups, each with a name and its settings.
object
Example generated
{ "settings_schema": [ {} ]}Responses
Section titled “Responses”object
The saved setting values, by setting ID.
object
The settings the version in use declares, as a list of groups. Each group has a name and
settings, a list of setting definitions (id, type, label, default and so on).
object
theme: a catalog release. custom: your code, built by EcomWeb. headless: a link to your own site.
The version the theme uses.
object
release: a catalog release. build: a deployment of your code. link: your own site.
When the version was added, as an ISO 8601 timestamp.
The deployment ID. Only for a build.
The site address. Only for a link.
The catalog release version. Only for a release.
Version ID.
A short name for the version, such as the release number.
The newest catalog release on a newer major version than the theme’s, or null when there is none.
object
The release’s version.
The preview of the build in use, or null when the theme does not use a build or is live.
object
off: not asked for in the last 24 hours. starting: asked for, not up yet. running: up.
When the preview stops, as an ISO 8601 timestamp, or null when it is not running.
The preview’s address.
The address of the theme’s screenshot, or null until one is taken.
When the theme was created, as an ISO 8601 timestamp.
When the theme was last updated, as an ISO 8601 timestamp.
Deprecated: use mode and current_version. hosted is a release, custom a build and external a link.
Deprecated: use mode. Whether a build is in use.
Deprecated: use current_version. The build in use, or null.
object
When the deployment was created, as an ISO 8601 timestamp.
When the build ended, as an ISO 8601 timestamp, or null.
The theme the build was deployed to, which differs from this theme for a copy.
Deployment ID.
Deprecated: use current_version. The catalog release version the theme comes from.
Deprecated: use preview. The preview’s address, or null.
Theme ID.
Theme name.
Whether this is the live theme, the one shoppers see.
ID of the catalog theme this theme comes from, such as default.
Whether the version in use has settings to edit.
How many versions the theme has.
Example
{ "mode": "theme", "current_version": { "kind": "release" }, "preview": { "state": "off" }, "kind": "hosted"}The request is malformed or failed validation.
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 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"}