products

Manage products, variants, images, collections, inventory, and more. Includes 8 shortcut commands and 78 API commands.

Shortcuts

+search

Search products by keyword, status, vendor, collection, or tags.

shoplazza products +search [flags]

Flag	Type	Description
--keyword	string	Filter by product title or SKU
--published	string	Filter by publish status (true or false)
--vendor	string	Filter by vendor name
--collection-id	string	Filter by collection ID
--tags	string	Filter by tags (comma-separated)
--page-limit	int	Page size (1–250)
--fields	string	Return fields (comma-separated)

shoplazza products +search --keyword "T-shirt"
shoplazza products +search --published true --vendor "Nike"
shoplazza products +search --collection-id 123 --tags "summer,sale"
shoplazza products +search --page-limit 50 --fields "id,title,variants"

+count

Count products matching criteria.

shoplazza products +count [flags]

Flag	Type	Description
--published	string	Filter by publish status (true or false)
--vendor	string	Filter by vendor name

shoplazza products +count
shoplazza products +count --published true
shoplazza products +count --vendor "Nike"

+create

Create a new product with smart defaults.

shoplazza products +create [flags]

Flag	Type	Required	Description
--title	string	Yes	Product title
--price	string	Yes	Price (e.g. 29.99)
--image	string	Yes	Image URL
--compare-price	string		Compare-at price
--sku	string		SKU
--stock	int		Stock quantity (enables inventory tracking)
--stock-policy	string		Policy when stock is 0: continue, deny, or auto_unpublished (default: deny)
--tags	string		Tags (comma-separated)
--published	bool		Publish immediately (default: draft)
--collection-ids	string		Collection IDs to add to

shoplazza products +create --title "My Product" --price 29.99 --image "https://example.com/img.jpg"
shoplazza products +create --title "My Product" --price 29.99 --image "https://..." \
  --compare-price 39.99 --sku SKU001 --stock 100 --tags "new,featured" --published

+publish

Publish a product to the online store.

shoplazza products +publish --id <product-id>

Flag	Type	Required	Description
--id	string	Yes	Product ID

+unpublish

Remove a product from the online store.

shoplazza products +unpublish --id <product-id>

Flag	Type	Required	Description
--id	string	Yes	Product ID

+stock

Set or adjust product inventory.

shoplazza products +stock [flags]

Flag	Type	Required	Description
--variant-id	string	Yes	Variant ID
--set	int		Set absolute stock value (≥ 0; mutually exclusive with --adjust)
--adjust	int		Increase stock by this amount (> 0; mutually exclusive with --set)
--location-id	string		Location ID (defaults to default location)

# Set absolute value
shoplazza products +stock --variant-id <id> --set 100

# Increase stock
shoplazza products +stock --variant-id <id> --adjust 50

# Specify location
shoplazza products +stock --variant-id <id> --set 100 --location-id <id>

+set-price

Update variant pricing by SKU.

shoplazza products +set-price [flags]

Flag	Type	Required	Description
--sku	string	Yes	Variant SKU
--price	string	Yes	New price (e.g. 24.99)
--compare-price	string		New compare-at price
--product-id	string		Product ID (required when SKU is duplicated across products)

shoplazza products +set-price --sku SKU001 --price 24.99
shoplazza products +set-price --sku SKU001 --price 24.99 --compare-price 39.99

collections +create

Create a new collection.

shoplazza products collections +create [flags]

Flag	Type	Required	Description
--title	string	Yes	Collection title
--description	string		Collection description
--image	string		Cover image URL
--sort-order	string		Sort order: manual, best-selling, price-asc, price-desc, newest, popular, intelligent
--product-ids	string		Product IDs (comma-separated)

shoplazza products collections +create --title "Summer Sale"
shoplazza products collections +create --title "Best Sellers" \
  --description "Our most popular items" --image "https://..." \
  --sort-order best-selling --product-ids "id1,id2,id3"

API commands

All dynamic API commands share these flags:

Flag	Short	Description
--params		Path/query parameters as JSON
--data		Request body as JSON
--jq	-q	jq expression to filter output
--dry-run		Preview the request without executing

products

shoplazza products list
shoplazza products get --params '{"product_id":"123"}'
shoplazza products create --data @product.json
shoplazza products update --params '{"product_id":"123"}' --data '{"product":{"title":"Updated"}}'
shoplazza products delete --params '{"product_id":"123"}'
shoplazza products batch-delete --data '{"ids":["123","456"]}'
shoplazza products count

products variants

shoplazza products variants list --params '{"product_id":"123"}'
shoplazza products variants get --params '{"variant_id":"456"}'
shoplazza products variants create --params '{"product_id":"123"}' --data @variant.json
shoplazza products variants update --params '{"variant_id":"456"}' --data @variant.json
shoplazza products variants delete --params '{"product_id":"123","variant_id":"456"}'
shoplazza products variants count --params '{"product_id":"123"}'
shoplazza products variants list-by-sku --params '{"sku":"SKU001"}'
shoplazza products variants update-by-sku --params '{"sku":"SKU001"}' --data @variant.json

products images

shoplazza products images list --params '{"product_id":"123"}'
shoplazza products images get --params '{"product_id":"123","image_id":"789"}'
shoplazza products images create --params '{"product_id":"123"}' --data '{"image":{"src":"https://..."}}'
shoplazza products images update --params '{"product_id":"123","image_id":"789"}' --data @image.json
shoplazza products images delete --params '{"product_id":"123","image_id":"789"}'
shoplazza products images count --params '{"product_id":"123"}'

products collections

shoplazza products collections list
shoplazza products collections get --params '{"id":"123"}'
shoplazza products collections create --data @collection.json
shoplazza products collections update --params '{"id":"123"}' --data @collection.json
shoplazza products collections delete --params '{"id":"123"}'
shoplazza products collections count

products collects

shoplazza products collects list
shoplazza products collects get --params '{"id":"123"}'
shoplazza products collects create --data '{"collect":{"product_id":"123","collection_id":"456"}}'
shoplazza products collects delete --params '{"id":"123"}'
shoplazza products collects batch-create --data @collects.json
shoplazza products collects count

products inventory

shoplazza products inventory list-items
shoplazza products inventory get-item --params '{"inventory_item_id":"123"}'
shoplazza products inventory update-item --params '{"inventory_item_id":"123"}' --data @item.json
shoplazza products inventory list-by-variant --params '{"variant_id":"456"}'
shoplazza products inventory set-stock --data '{"variant_id":"123","available":100}'
shoplazza products inventory list-levels
shoplazza products inventory create-level --data @level.json
shoplazza products inventory update-level --data @level.json
shoplazza products inventory delete-level --data '{"inventory_item_id":"123","location_id":"456"}'

products locations

shoplazza products locations list
shoplazza products locations get --params '{"id":"123"}'
shoplazza products locations count
shoplazza products locations get-default
shoplazza products locations set-default --data '{"id":"123"}'
shoplazza products locations deactivate --data '{"id":"123"}'
shoplazza products locations edit-priority --data @priority.json
shoplazza products locations inventory-levels --params '{"location_id":"123"}'

products gift-cards

shoplazza products gift-cards list
shoplazza products gift-cards get --params '{"id":"123"}'
shoplazza products gift-cards create --data @gift-card.json
shoplazza products gift-cards update --params '{"id":"123"}' --data @gift-card.json
shoplazza products gift-cards disable --params '{"id":"123"}'
shoplazza products gift-cards batch-create --data @gift-cards.json

products categories

shoplazza products categories list

products comments

shoplazza products comments list --params '{"product_id":"123"}'
shoplazza products comments create --data @comment.json
shoplazza products comments batch-create --data @comments.json

products procurement

shoplazza products procurement list
shoplazza products procurement get --params '{"id":"123"}'
shoplazza products procurement create --data @procurement.json
shoplazza products procurement update --params '{"id":"123"}' --data @procurement.json
shoplazza products procurement receive --params '{"id":"123"}'
shoplazza products procurement cancel --params '{"id":"123"}'
shoplazza products procurement list-items --params '{"id":"123"}'
shoplazza products procurement batch-create-items --data @items.json
shoplazza products procurement batch-update-items --data @items.json
shoplazza products procurement batch-delete-items --data '{"ids":["123"]}'

products suppliers

shoplazza products suppliers list
shoplazza products suppliers get --params '{"id":"123"}'
shoplazza products suppliers create --data @supplier.json
shoplazza products suppliers update --params '{"id":"123"}' --data @supplier.json

Schema introspection

Explore all available product commands and their parameters:

# List all product commands
shoplazza schema products

# View parameters for a specific command
shoplazza schema products.list