跳到主要内容

三层命令体系

Shoplazza CLI 将命令组织为三层,每层提供不同的控制级别和便利性。

概览

第一层:快捷命令 → 人机友好,智能默认值
第二层:API 命令 → 1:1 API 映射,完整参数控制
第三层:原始 API → 逃生舱,100% 端点覆盖

第一层:快捷命令

+ 为前缀,专为高频操作设计。提供智能默认值、字段投影和简化的接口。

适用场景: 日常操作,便利性优先于完整参数控制。

shoplazza products +search --keyword "shirt" --format table
shoplazza orders +ship --id 12345
shoplazza discounts +percent-code

特征: + 前缀区分快捷命令和 API 命令;--fields 参数支持输出投影;为人类开发者和 AI Agent 双向设计。

第二层:API 命令

与 Shoplazza 平台 API 端点 1:1 映射,提供对请求参数和响应处理的完整控制。

适用场景: 需要精确控制 API 参数时,或没有对应快捷命令时。

shoplazza products list --params '{"page_size": 50, "status": "active"}'
shoplazza products create --data '{"product": {"title": "新商品", "price": "29.99"}}'
shoplazza orders list --jq '.orders[] | {id, status, total_price}'

特征: 235+ 命令从 OpenAPI 规范自动生成;--params 用于查询参数;--data 用于请求体。

第三层:原始 API

api rest 命令提供逃生舱,可直接调用任意 Shoplazza API 端点。

适用场景: 需要调用 API 命令尚未覆盖的端点时,或需要完整 HTTP 控制时。

shoplazza api rest GET /openapi/2026-01/products --params '{"page_size": 10}'
shoplazza api rest POST /openapi/2026-01/webhooks --data '{"webhook": {"topic": "orders/create", "address": "https://example.com/hook"}}'

如何选择

场景推荐层级
按关键词搜索商品快捷命令:products +search
创建包含 20+ 字段的商品API 命令:products create
调用全新的 API 端点原始 API:api rest
日常订单管理快捷命令:orders +ship, orders +refund
调试或探索 API原始 API:api rest + --dry-run

发现命令

shoplazza schema # 查看所有模块
shoplazza schema products # 查看模块下的命令
shoplazza schema products.list # 查看命令的完整 Schema