Skip to main content

customers

Manage customers and their addresses. Includes 3 shortcut commands and 11 API commands.

Shortcuts​

Search customers by email, phone, or signup date range. Returns one page; follow has_more/cursor for the rest.

shell
shoplazza customers +search [flags]
FlagTypeDescription
--emailstringFilter by email
--phonestringFilter by phone (matches the customer's primary contact)
--sincestringCreated-at lower bound (ISO date or unix timestamp)
--untilstringCreated-at upper bound (ISO date or unix timestamp)
--page-limitintPage size (1–250)
shell
shoplazza customers +search
shoplazza customers +search --email [email protected]
shoplazza customers +search --phone "+1234567890"
shoplazza customers +search --since 2026-01-01 --page-limit 50

+count​

Count all customers in the store. The count endpoint takes no filters; to count a filtered subset, use +search.

shell
shoplazza customers +count

+create​

Create a new customer.

shell
shoplazza customers +create [flags]
FlagTypeDescription
--emailstringEmail (exactly one of --email or --phone)
--phonestringPhone (exactly one of --email or --phone)
--first-namestringFirst name
--last-namestringLast name
--tagsstringTags (comma-separated)
--no-marketingboolOpt out of marketing (default: subscribed)
shell
shoplazza customers +create --email [email protected]
shoplazza customers +create --phone "+1234567890"
shoplazza customers +create --email [email protected] --first-name John --last-name Doe \
--tags "vip,wholesale"

API commands​

All dynamic API commands share these flags:

FlagShortDescription
--paramsPath/query parameters as JSON
--dataRequest body as JSON (inline, @file, or - for stdin); only on commands that take a request body
--jq-qjq expression to filter output
--dry-runPreview the request without executing

customers​

shell
shoplazza customers list
shoplazza customers get --params '{"customer_id":"123"}'
shoplazza customers create --data @customer.json
shoplazza customers update --params '{"customer_id":"123"}' --data @customer.json
shoplazza customers count

customers addresses​

shell
shoplazza customers addresses list --params '{"customer_id":"123"}'
shoplazza customers addresses get --params '{"customer_id":"123","address_id":"456"}'
shoplazza customers addresses create --params '{"customer_id":"123"}' --data @address.json
shoplazza customers addresses update --params '{"customer_id":"123","address_id":"456"}' --data @address.json
shoplazza customers addresses delete --params '{"customer_id":"123","address_id":"456"}'
shoplazza customers addresses set-default --params '{"customer_id":"123","address_id":"456"}'

Schema introspection​

shell
shoplazza schema customers
shoplazza schema customers.addresses.create