Command reference

This reference lists all Shoplazza CLI commands organized by topic.

Command syntax

shoplazza [topic] [command] [flags]

Three-layer command system

Shoplazza CLI provides three layers of commands for progressive depth of control:

Layer	Syntax	When to use
Shortcuts	shoplazza <topic> +<action>	Day-to-day operations with smart defaults
API commands	shoplazza <topic> <action>	Full control over API parameters
Raw API	shoplazza api rest <METHOD> <PATH>	Any endpoint not covered above

For details, see Three-layer command system.

Command groups

The groups follow shoplazza --help: store & business, development, and setup & tooling.

Store & business

Store data (shortcuts + API commands)

Topic	Shortcuts	API commands	Reference
Products	+search, +create, +set-price, +stock, +publish, +unpublish, +count, +set-variants, +tag	79	products
Orders	+search, +count, +ship, +refund, +update-tracking	38	orders
Discounts	+search, +rebate, +flashsale, +mn-discount, +percent-code, +amount-code, +bxgy-code, +free-shipping-code	15	discounts
Customers	+search, +create, +count	11	customers
Shop	+upload-file	95	shop
Themes (API)	+page, +edit, +card-schema, +preview, block +edit, block +get	56	themes-api
Billing	—	14	billing
Webhook	—	6	webhook

shoplazza schema <topic> lists a topic's API commands.

Platform features

Command	Description
billing one-time	One-time charge management
billing recurring	Recurring subscription management
billing usage	Usage-based billing
billing transactions	Transaction queries
webhook create	Register event webhooks
webhook list	List registered webhooks
webhook get	Get a webhook
webhook update	Update a webhook
webhook delete	Delete a webhook
webhook count	Count webhooks

Raw API

Command	Description
api rest	Raw HTTP requests to any endpoint

Development

App development

Command	Description
app init	Initialize or link an app project
app list	List apps in your account
app info	Show app metadata
app dev	Start local development server
app deploy	Deploy app to production
app config link	Link app configuration
app config use	Switch app configuration
app config push	Push the [dashboard] settings to the Partner dashboard
app extension create	Scaffold a new extension
app versions	List deployed versions
app function compile	Compile function extension to WASM
app function release	Compile and publish function extension
app function list	List function extensions

Theme development

Command	Description
themes init	Scaffold a new theme
themes serve	Preview theme with live reload
themes pull	Download theme from store
themes push	Upload theme to store
themes package	Package theme as ZIP
themes share	Share theme preview link
themes env list	List the environments in shoplazza.theme.toml
themes env show	Show one environment's settings
themes env check	Validate environments offline
themes env add	Add an environment
themes env set	Change fields of an environment
themes env remove	Remove an environment

Store theme operations (themes list, themes +page, themes +edit, …) are in the Themes (API) row of the store data table above.

Extensions

checkout is an alias of checkout-extension, and te of theme-extension.

Command	Description
checkout-extension init	Scaffold checkout extension project
checkout-extension create	Add extension to existing project
checkout-extension dev	Local dev server on :8888
checkout-extension build	Build extension with Vite
checkout-extension push	Upload new version
checkout-extension preview	Generate a preview URL for a version
checkout-extension deploy	Activate a version
checkout-extension undeploy	Deactivate an extension
checkout-extension list	List checkout extensions
checkout-extension versions	List an extension's versions
theme-extension create	Scaffold theme extension
theme-extension serve	Dev server with live sync
theme-extension build	Build a new version
theme-extension deploy	Enable a version in store
theme-extension connect	Link extension to an app
theme-extension release	Publish version in bound app
theme-extension list	List the store's theme extensions
theme-extension versions	List an extension's versions

Setup & tooling

Authentication & configuration

Command	Description
auth login	Log in via OAuth 2.0
auth logout	Remove all profiles and stored credentials
auth status	Show current authentication state
auth scopes	Show supported and granted OAuth scopes
auth store use	Switch to a different store
profile add	Add a profile for a store
profile list	List configured profiles
profile info	Show a profile's details
profile use	Switch the current profile
profile update	Change a profile's scopes
profile rename	Rename a profile
profile remove	Remove a profile

Utilities

Command	Description
schema	Inspect available APIs and parameters
skills list	List the Agent Skills embedded in the CLI
skills read	Print a skill or one of its reference files
update	Update CLI to latest version and refresh API metadata
completion	Generate shell completion scripts
doctor check	Run diagnostic checks
--version / -v	Display CLI version
--help / -h	Show command help

Global flags

These flags are available on all commands:

Flag	Description
--format <json|pretty|table|ndjson|csv>	Output format (default: pretty at an interactive terminal, json when piped, in CI, or with --no-input; SHOPLAZZA_CLI_FORMAT overrides the default)
--no-input	Never prompt; fail fast on missing input (scripts and agents)
--profile <name>	Profile to use for this invocation
--help / -h	Show command help

--version / -v works on the root command (shoplazza --version). API commands, shortcuts, and api rest also take --jq <expression> / -q (filter JSON output; at an interactive terminal add --format json) and --dry-run (preview the request without executing).

For details, see Global flags.