Shortcuts
Shortcuts are high-frequency commands prefixed with +, designed for both human developers and AI agents. They provide smart defaults and streamlined workflows. At an interactive terminal, a shortcut asks for any required flag you left out; scripts, CI, and agents get a required flag(s) not set error instead.
Syntax
shoplazza <topic> +<action> [flags]
Available shortcuts
Products (9 shortcuts)
| Command | Description |
|---|---|
products +search | Search products by title, vendor, collection, or published status |
products +count | Count products |
products +create | Create a single-variant product |
products +set-price | Set a variant's price by variant ID, SKU, or product ID |
products +set-variants | Edit a product's option matrix (values, dimensions, variant prices) in one request |
products +stock | Set or adjust variant inventory |
products +tag | Add, remove, or replace tags without clobbering the others |
products +publish | Publish to online store |
products +unpublish | Remove from online store |
Orders (5 shortcuts)
| Command | Description |
|---|---|
orders +search | Search orders |
orders +count | Count orders |
orders +ship | Create fulfillment |
orders +refund | Create refund |
orders +update-tracking | Update tracking info |
Discounts (8 shortcuts)
| Command | Description |
|---|---|
discounts +search | Search discounts |
discounts +rebate | Create automatic rebate |
discounts +flashsale | Create flash sale |
discounts +mn-discount | Create a quantity-tiered Nth-item-off discount |
discounts +percent-code | Create percentage code |
discounts +amount-code | Create fixed amount code |
discounts +bxgy-code | Create buy-X-get-Y code |
discounts +free-shipping-code | Create free shipping code |
Customers (3 shortcuts)
| Command | Description |
|---|---|
customers +search | Search customers |
customers +count | Count customers |
customers +create | Create a customer |
Shop (1 shortcut)
| Command | Description |
|---|---|
shop +upload-file | Submit a file-upload task that fetches public URLs into the media library (not local files) |
Themes (6 shortcuts)
| Command | Description |
|---|---|
themes +page | Read a template page: sections in render order and blocks with ready-to-copy targets |
themes +edit | Apply a batch of edit operations to a template page inside one edit session |
themes +card-schema | Read the settings and blocks schema of addable theme cards |
themes +preview | Print a storefront preview URL for a theme |
themes block +edit | Write a generated block file and place it on a template page |
themes block +get | Read a generated block: file info, reference count, and placements |
Theme development commands (themes init, serve, pull, push, package, share) are regular commands, not shortcuts — see theme.
Common flags
All shortcuts support these flags:
| Flag | Description |
|---|---|
--format <json|pretty|table|ndjson|csv> | Output format (global flag) |
--dry-run | Print the request that would be sent without executing it |
--jq <expr> / -q | Filter JSON output |
Search shortcuts also take --page-limit (page size, 1–250), and products +search takes --fields <f1,f2> to choose the fields the API returns.
Examples
shell
# Search with table output
shoplazza products +search --keyword "dress" --format table
# Search with field projection
shoplazza products +search --keyword "dress" --fields "id,title,price_min" --format table
# Create and filter output
shoplazza customers +create --email [email protected] --format json --jq '.data.customer.id'