POST
Translate a Shopify theme's configuration into a builder config

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key
string
required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Body

application/json
index
string
required

templates/index.json, the homepage layout. Required.

settings_data
string

config/settings_data.json, the theme's global settings.

product
string

templates/product.json. Read only to report what it contains.

collection
string

templates/collection.json. Read only to report what it contains.

header_group
string

sections/header-group.json. The header and announcement bar live here, NOT in index.json; omitting it imports a store with no header.

sections/footer-group.json. The footer lives here, NOT in index.json.

Response

Success

data
object