shop

Manage store settings, content, analytics, metafields, markets, languages, menus, and file uploads. Includes 1 shortcut and 95 API commands.

Shortcuts

+upload-file

Submit file upload tasks (accepts public URLs, not local files).

shell

shoplazza shop +upload-file [flags]

Flag	Type	Required	Description
--source-url	string	Yes	Public URL to upload (repeatable for multiple files)
--folder	string		Target folder: all_upload or product (default: all_upload)

shell

shoplazza shop +upload-file --source-url "https://example.com/image.jpg"
shoplazza shop +upload-file --source-url "https://a.com/1.jpg" --source-url "https://a.com/2.jpg"
shoplazza shop +upload-file --source-url "https://..." --folder product

API commands

All dynamic API commands share these flags:

Flag	Short	Description
--params		Path/query parameters as JSON
--data		Request body as JSON (inline, @file, or - for stdin); only on commands that take a request body
--jq	-q	jq expression to filter output
--dry-run		Preview the request without executing

shop info

shell

shoplazza shop info get
shoplazza shop info update --params '{"shop_id":"123"}' --data @shop.json

shop analytics

shell

shoplazza shop analytics overview --data '{"begin_time":"1767225600","end_time":"1769903999","indicator":["sales","orders"]}'
shoplazza shop analytics by-land-page --data '{"begin_time":"1767225600","end_time":"1769903999","dimensions":["land_url_path"]}'
shoplazza shop analytics by-sku --data '{"begin_time":"1767225600","end_time":"1769903999","sort_by":"sales_total","sort_direction":"desc"}'
shoplazza shop analytics by-spu --data '{"type":"product","begin_time":"1767225600","end_time":"1769903999"}'
shoplazza shop analytics by-utm --data '{"begin_time":"1767225600","end_time":"1769903999"}'
shoplazza shop analytics search-keyword --data '{"begin_time":"1767225600","end_time":"1769903999"}'
shoplazza shop analytics traffic-channel --data '{"begin_time":"1767225600","end_time":"1769903999","dimensions":["last_referrer_show"],"metrics":["uv","sales"]}'
shoplazza shop analytics traffic-channel-options

shop blogs

shell

shoplazza shop blogs list
shoplazza shop blogs get --params '{"id":"123"}'
shoplazza shop blogs create --data @blog.json
shoplazza shop blogs update --params '{"id":"123"}' --data @blog.json
shoplazza shop blogs delete --params '{"id":"123"}'
shoplazza shop blogs count

shop articles

shell

shoplazza shop articles list
shoplazza shop articles get --params '{"id":"456"}'
shoplazza shop articles create --data @article.json
shoplazza shop articles update --params '{"id":"456"}' --data @article.json
shoplazza shop articles delete --params '{"id":"456"}'
shoplazza shop articles count
shoplazza shop articles author

shop pages

shell

shoplazza shop pages list
shoplazza shop pages get --params '{"id":"123"}'
shoplazza shop pages create --data @page.json
shoplazza shop pages update --params '{"id":"123"}' --data @page.json
shoplazza shop pages delete --params '{"id":"123"}'
shoplazza shop pages batch-get --data '{"ids":[123,456]}'
shoplazza shop pages batch-delete --data '{"ids":[123,456]}'
shoplazza shop pages search --params '{"url":"/pages/about-us"}'
shoplazza shop pages count

shop files

shell

shoplazza shop files list
shoplazza shop files get --params '{"file_uri":"<file-uri>"}'
shoplazza shop files upload --data @file.json
shoplazza shop files task --params '{"task_id":"123"}'
shoplazza shop files delete --params '{"file_uri":"<file-uri>"}'

shop redirects

shell

shoplazza shop redirects list
shoplazza shop redirects get --params '{"id":"123"}'
shoplazza shop redirects create --data @redirect.json
shoplazza shop redirects update --params '{"id":"123"}' --data @redirect.json
shoplazza shop redirects delete --params '{"id":"123"}'
shoplazza shop redirects search --data '{"from_url":"/old-path"}'

shop carrier-services

shell

shoplazza shop carrier-services list
shoplazza shop carrier-services get --params '{"carrier_service_id":"123"}'
shoplazza shop carrier-services create --data @carrier.json
shoplazza shop carrier-services update --params '{"carrier_service_id":"123"}' --data @carrier.json
shoplazza shop carrier-services delete --params '{"carrier_service_id":"123"}'

shop metafields-definition

shell

shoplazza shop metafields-definition list --params '{"owner_resource":"product"}'
shoplazza shop metafields-definition get --params '{"id":"123"}'
shoplazza shop metafields-definition create --params '{"owner_resource":"product"}' --data @definition.json
shoplazza shop metafields-definition update --params '{"id":"123"}' --data @definition.json
shoplazza shop metafields-definition delete --params '{"id":"123"}'
shoplazza shop metafields-definition count --params '{"owner_resource":"product","definition_ids":[123]}'
shoplazza shop metafields-definition count-by-group

shop metafields-resource

shell

shoplazza shop metafields-resource list --params '{"owner_resource":"product","owner_id":"123"}'
shoplazza shop metafields-resource get --params '{"owner_resource":"product","owner_id":"123","id":"456"}'
shoplazza shop metafields-resource create --params '{"owner_resource":"product","owner_id":"123"}' --data @metafield.json
shoplazza shop metafields-resource update --params '{"owner_resource":"product","owner_id":"123","id":"456"}' --data @metafield.json
shoplazza shop metafields-resource delete --params '{"owner_resource":"product","owner_id":"123","id":"456"}'
shoplazza shop metafields-resource count --params '{"owner_resource":"product","owner_id":"123"}'

shop metafields-shop

shell

shoplazza shop metafields-shop list
shoplazza shop metafields-shop get --params '{"id":"123"}'
shoplazza shop metafields-shop create --data @metafield.json
shoplazza shop metafields-shop update --params '{"id":"123"}' --data @metafield.json
shoplazza shop metafields-shop delete --params '{"id":"123"}'
shoplazza shop metafields-shop count

shop markets

shell

shoplazza shop markets list
shoplazza shop markets get --params '{"id":"123"}'
shoplazza shop markets preview --data '{"countries":["JP"]}'
shoplazza shop markets create --data '{"name":"Japan","countries":["JP"]}'
shoplazza shop markets update --params '{"id":"123"}' --data @market.json
shoplazza shop markets delete --params '{"id":"123"}'
shoplazza shop markets update-status --params '{"id":"123"}' --data '{"status":"active"}'
shoplazza shop markets update-domain --params '{"id":"123"}' --data '{"domain_type":"sub_path","domain_value":"jp"}'
shoplazza shop markets update-price --params '{"id":"123"}' --data '{"currency":"JPY","price_adjust":0}'
shoplazza shop markets update-tax --params '{"id":"123"}' --data '{"product_tax_included":true}'
shoplazza shop markets update-default-language --params '{"id":"123"}' --data '{"language_code":"ja-JP"}'
shoplazza shop markets list-language --params '{"id":"123"}'
shoplazza shop markets list-product --params '{"id":"123"}'
shoplazza shop markets add-product --params '{"id":"123"}' --data '{"product_ids":["456"]}'
shoplazza shop markets delete-product --params '{"id":"123"}' --data '{"product_ids":["456"]}'
shoplazza shop markets update-product-price --params '{"id":"123"}' --data @product-prices.json

shop languages

shell

shoplazza shop languages list
shoplazza shop languages supported
shoplazza shop languages markets
shoplazza shop languages add --data '{"codes":["ja-JP"]}'
shoplazza shop languages enable --params '{"language_code":"ja-JP"}'
shoplazza shop languages disable --params '{"language_code":"ja-JP"}'
shoplazza shop languages publish --params '{"language_code":"ja-JP"}' --data '{"market_ids":["123"]}'
shoplazza shop languages delete --params '{"language_code":"ja-JP"}'

shop menu

shell

shoplazza shop menu list
shoplazza shop menu create --data '{"title":"Footer links"}'
shoplazza shop menu update --params '{"id":"123"}' --data @menu.json
shoplazza shop menu delete --params '{"id":"123"}'

Schema introspection

shell

shoplazza schema shop
shoplazza schema shop.pages.create