Skip to main content

shop

Manage store settings, content, analytics, metafields, and file uploads. Includes 1 shortcut and 64 API commands.

Shortcuts

+upload-file

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

shoplazza shop +upload-file [flags]
FlagTypeRequiredDescription
--source-urlstringYesPublic URL to upload (repeatable for multiple files)
--folderstringTarget folder: all_upload or product (default: all_upload)
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:

FlagShortDescription
--paramsPath/query parameters as JSON
--dataRequest body as JSON
--jq-qjq expression to filter output
--dry-runPreview the request without executing

shop info

shoplazza shop info get
shoplazza shop info update --data @shop.json

shop analytics

shoplazza shop analytics overview --params '{"start_at":"2026-01-01","end_at":"2026-01-31"}'
shoplazza shop analytics by-land-page --params '{"start_at":"2026-01-01","end_at":"2026-01-31"}'
shoplazza shop analytics by-sku --params '{"start_at":"2026-01-01","end_at":"2026-01-31"}'
shoplazza shop analytics by-spu --params '{"start_at":"2026-01-01","end_at":"2026-01-31"}'
shoplazza shop analytics by-utm --params '{"start_at":"2026-01-01","end_at":"2026-01-31"}'

shop blogs

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

shop articles

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

shop pages

shoplazza shop pages list
shoplazza shop pages get --params '{"page_id":"123"}'
shoplazza shop pages create --data @page.json
shoplazza shop pages update --params '{"page_id":"123"}' --data @page.json
shoplazza shop pages delete --params '{"page_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 '{"keyword":"about"}'
shoplazza shop pages count

shop files

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

shop redirects

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

shop carrier-services

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

shop metafields-definition

shoplazza shop metafields-definition list
shoplazza shop metafields-definition get --params '{"id":"123"}'
shoplazza shop metafields-definition create --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
shoplazza shop metafields-definition count-by-group

shop metafields-resource

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

shop metafields-shop

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

Schema introspection

shoplazza schema shop
shoplazza schema shop.pages.create