Skip to main content

​
Editing Liquid Themes

All editing surfaces use the same Theme Control Plane:
  • dashboard editor
  • CLI
  • Dev API
  • MCP tools for AI clients
That means inspect, apply, validate, preview, publish, and rollback have the same backend semantics no matter which client you use.
1

Inspect

Learn the theme source shape before editing.
2

Search and read

Find the exact Liquid section, snippet, or settings file.
3

Apply a focused change

Change one logical thing at a time.
4

Validate

Confirm the Liquid package and settings are shippable.
5

Preview

Review a sandboxed storefront render.
6

Publish

Activate only after the preview is correct.

​
CLI Example

shoppex auth login --api-key shx_your_key
shoppex theme list
shoppex theme inspect --theme "$THEME_ID"
shoppex theme pull --theme "$THEME_ID" --out ./my-theme
cd ./my-theme
shoppex theme dev
shoppex theme push --preview
shoppex theme publish

​
Apply vs Accept

  • apply edits source directly.
  • accept approves a draft patch produced by the dashboard AI agent.
If you are editing locally or through your own automation, use apply or push. If you are reviewing a dashboard-generated variant, use accept.

​
Dev API Theme Endpoints

Use these when you build your own tooling: 
GET    /dev/v1/themes
POST   /dev/v1/themes/control/create
POST   /dev/v1/themes/{id}/ai/apply
GET    /dev/v1/themes/{id}/control/inspect
GET    /dev/v1/themes/{id}/control/diff
GET    /dev/v1/themes/{id}/control/search?q=hero
GET    /dev/v1/themes/{id}/control/files/{path}
POST   /dev/v1/themes/{id}/control/apply
POST   /dev/v1/themes/{id}/control/accept
POST   /dev/v1/themes/{id}/control/sections
POST   /dev/v1/themes/{id}/control/pages
POST   /dev/v1/themes/{id}/control/config
POST   /dev/v1/themes/{id}/control/validate
POST   /dev/v1/themes/{id}/control/preview
GET    /dev/v1/themes/{id}/control/preview/starts/{startId}
DELETE /dev/v1/themes/{id}/control/preview/{sessionId}
POST   /dev/v1/themes/{id}/control/publish
GET    /dev/v1/themes/{id}/control/publish/{jobId}/status
GET    /dev/v1/themes/{id}/control/settings
POST   /dev/v1/themes/{id}/control/settings
GET    /dev/v1/themes/{id}/export
POST   /dev/v1/themes/{id}/source
GET    /dev/v1/themes/{id}/control/backups
POST   /dev/v1/themes/{id}/control/rollback/{backupId}
GET    /dev/v1/themes/{id}/control/runs/latest
Full endpoint schemas are in the API Reference under the Themes group.

​
Auth Scopes

Use:
  • themes.read for inspect, list, search, read, diff, settings read, export, and runs
  • themes.write for apply, source upload, settings update, validate, preview, publish, rollback, and AI apply

​
Safety Rules

  • Always validate before preview.
  • Always preview before publish.
  • Use diff before publishing if more than one file changed.
  • Do not ship unsafe Liquid, dynamic partials, or executable theme code.
  • Do not hide missing context with Liquid fallback data.

​
Next Steps

AI Workflows

Use MCP and CLI safely with AI assistants.

Theme Package Format

Required source files and manifest rules.