schema

Explore available APIs, commands, and their parameters through schema introspection.

Usage

shoplazza schema [path] [flags]

Flags

Flag	Type	Description
`--view <section>`	string	Filter output: `all`, `request`, or `response` (default: `all`)

Examples

List all available modules

shoplazza schema

Returns a list of all service modules (products, orders, customers, etc.).

List commands in a module

shoplazza schema products

Returns all available commands under the products module.

View command details

shoplazza schema products.list

Returns the full schema for the products list command:

HTTP method and path
Query parameters with types
Request body structure
Response schema

Filter to request or response only

# Show only request parameters
shoplazza schema products.create --view request

# Show only response schema
shoplazza schema products.list --view response

Use cases

Discover APIs — Browse available commands before writing scripts
Check parameters — Verify required fields before making API calls
Debug requests — Understand expected request/response formats
AI agent integration — Agents can introspect the schema to discover capabilities dynamically

Usage​

Flags​

Examples​

List all available modules​

List commands in a module​

View command details​

Filter to request or response only​

Use cases​