Skip to main content

Shoplazza CLI quick start

Get up and running with Shoplazza CLI in 3 minutes.

Step 1: Install​

shell
npm install -g shoplazza-cli

For other installation methods, see Install Shoplazza CLI.

Step 2: Authenticate​

Log in with your Shoplazza partner account and connect to a store:

shell
shoplazza auth login --store-domain my-store.myshoplaza.com --domain products,orders

The CLI prints an authorization URL. Open it in your browser and grant access; the CLI then stores your credentials encrypted in its config directory.

To verify your authentication status:

shell
shoplazza auth status

Step 3: Run your first command​

Search for products in your store:

shell
shoplazza products +search --keyword "shirt"

List orders in table format:

shell
shoplazza orders +search --format table

Check available API commands with schema introspection:

shell
shoplazza schema products

What's next​

For app developers​

Initialize a new app project:

shell
shoplazza app init --name "my-app"

Then follow the App development tutorial.

For theme developers​

Scaffold a new theme based on Nova 2023:

shell
shoplazza themes init --name my-theme

Theme commands need the themes scopes. If you logged in with other domains only, log in again and keep the earlier grants:

shell
shoplazza auth login --store-domain my-store.myshoplaza.com --domain themes --merge-scopes

Then preview it locally from the theme directory:

shell
cd my-theme
shoplazza themes serve

See the Theme CLI guide for more details.

Explore commands​

On this page