Skip to content

Push a theme's settings schema

PUT
/stores/{storeRef}/themes/{id}/schema
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

id
required
string

The theme ID.

storeRef
required
string

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

Media typeapplication/json
object
settings_schema
required

The settings schema of the code the theme uses: a list of groups, each with a name and its settings.

Array<object>
object
key
additional properties
any

Example generated

{
"settings_schema": [
{}
]
}
Media typeapplication/json
object
settings_values
required

The saved setting values, by setting ID.

object
key
additional properties
any
settings_schema
required

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).

Array<object>
object
key
additional properties
any
mode
required

theme: a catalog release. custom: your code, built by EcomWeb. headless: a link to your own site.

string
Allowed values: theme custom headless
current_version
required

The version the theme uses.

object
kind
required

release: a catalog release. build: a deployment of your code. link: your own site.

string
Allowed values: release build link
created_at
required

When the version was added, as an ISO 8601 timestamp.

string format: date-time
deployment_id

The deployment ID. Only for a build.

string
url

The site address. Only for a link.

string
release_version

The catalog release version. Only for a release.

string
id
required

Version ID.

string
label
required

A short name for the version, such as the release number.

string
latest_release
required

The newest catalog release on a newer major version than the theme’s, or null when there is none.

object
version
required

The release’s version.

string
preview
required

The preview of the build in use, or null when the theme does not use a build or is live.

object
state
required

off: not asked for in the last 24 hours. starting: asked for, not up yet. running: up.

string
Allowed values: off starting running
until
required

When the preview stops, as an ISO 8601 timestamp, or null when it is not running.

string format: date-time
nullable
url
required

The preview’s address.

string
thumbnail_url
required

The address of the theme’s screenshot, or null until one is taken.

string
nullable
created_at
required

When the theme was created, as an ISO 8601 timestamp.

string format: date-time
updated_at
required

When the theme was last updated, as an ISO 8601 timestamp.

string format: date-time
kind
required

Deprecated: use mode and current_version. hosted is a release, custom a build and external a link.

string
Allowed values: hosted custom external
deployed
required

Deprecated: use mode. Whether a build is in use.

boolean
current_deployment
required

Deprecated: use current_version. The build in use, or null.

object
created_at
required

When the deployment was created, as an ISO 8601 timestamp.

string format: date-time
build_finished_at
required

When the build ended, as an ISO 8601 timestamp, or null.

string format: date-time
nullable
store_theme_id
required

The theme the build was deployed to, which differs from this theme for a copy.

string
nullable
id
required

Deployment ID.

string
source_version
required

Deprecated: use current_version. The catalog release version the theme comes from.

string
preview_url
required

Deprecated: use preview. The preview’s address, or null.

string
nullable
id
required

Theme ID.

string
name
required

Theme name.

string
is_published
required

Whether this is the live theme, the one shoppers see.

boolean
source_theme_id
required

ID of the catalog theme this theme comes from, such as default.

string
has_settings
required

Whether the version in use has settings to edit.

boolean
versions_count
required

How many versions the theme has.

number

Example

{
"mode": "theme",
"current_version": {
"kind": "release"
},
"preview": {
"state": "off"
},
"kind": "hosted"
}

The request is malformed or failed validation.

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

The request conflicts with the resource’s current state.

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