跳到主要内容

订单

管理订单、履约、退款和物流。包含 5 个快捷命令和 38 个 API 命令。

快捷命令​

按关键词、客户邮箱、状态或日期范围搜索订单。只返回一页，其余结果按 has_more/cursor 继续翻页。

shell
shoplazza orders +search [flags]
参数类型说明
--keywordstring模糊匹配订单号、客户姓名或邮箱（已知邮箱时优先用 --email）
--emailstring按客户邮箱过滤（精确匹配）
--statusstring订单状态：opened、placed、finished、cancelled
--financial-statusstring财务状态：waiting、paying、authorized、partially_paid、paid、cancelled、failed、refunded
--fulfillment-statusstring发货状态：initialled、waiting、partially_shipped、shipped、finished、cancelled、returned
--customer-idstring按客户 ID 过滤
--sincestring开始时间（ISO 日期或 unix 时间戳）
--untilstring结束时间（ISO 日期或 unix 时间戳）
--page-limitint页面大小（1–250）
shell
shoplazza orders +search
shoplazza orders +search --keyword "John"
shoplazza orders +search --email [email protected]
shoplazza orders +search --status opened --financial-status paid
shoplazza orders +search --since 2026-01-01 --until 2026-06-30
shoplazza orders +search --customer-id <id> --page-limit 50

+count​

按条件统计订单数量。

shell
shoplazza orders +count [flags]
参数类型说明
--keywordstring模糊匹配订单号、客户姓名或邮箱
--emailstring按客户邮箱过滤（精确匹配）
--customer-idstring按客户 ID 过滤
--statusstring订单状态过滤
--financial-statusstring财务状态过滤
--fulfillment-statusstring发货状态过滤
--sincestring开始时间
--untilstring结束时间
shell
shoplazza orders +count
shoplazza orders +count --status opened --financial-status paid
shoplazza orders +count --since 2026-01-01 --until 2026-06-30
shoplazza orders +count --email [email protected]

+ship​

为订单创建履约发货。

shell
shoplazza orders +ship [flags]
参数类型必填说明
--order-idstring是订单 ID（在交互式终端中可不填，从列表中选择订单）
--trackingstring是物流单号
--companystring物流公司名称（如 DHL、UPS）
--company-codestring物流公司代码
--line-itemsstring行项目数量（格式：line-id:qty,...；默认全部）
--notifybool通知客户
shell
shoplazza orders +ship --order-id <id> --tracking 1234567890
shoplazza orders +ship --order-id <id> --tracking 1234567890 --company DHL --notify
shoplazza orders +ship --order-id <id> --tracking 1234567890 --line-items "line1:2,line2:1"

+refund​

为订单创建退款。在交互式终端中，CLI 会要求你重新输入订单 ID 确认后才执行。

shell
shoplazza orders +refund [flags]
参数类型必填说明
--order-idstring是订单 ID（在交互式终端中可不填，从列表中选择订单）
--amountstring是退款金额（如 29.99）
--payment-line-idstring支付行 ID（多支付行时必填）
--notestring退款备注
--return-itemsbool同时退还库存
shell
shoplazza orders +refund --order-id <id> --amount 29.99
shoplazza orders +refund --order-id <id> --amount 29.99 --note "客户要求" --return-items
shoplazza orders +refund --order-id <id> --amount 29.99 --payment-line-id <id>

+update-tracking​

更新履约的物流追踪信息。

shell
shoplazza orders +update-tracking [flags]
参数类型必填说明
--order-idstring是订单 ID（在交互式终端中可不填，从列表中选择订单）
--fulfillment-idstring是履约 ID
--trackingstring是新物流单号
--companystring物流公司名称
--tracking-urlstring自定义物流追踪 URL
--notifybool通知客户
shell
shoplazza orders +update-tracking --order-id <id> --fulfillment-id <id> --tracking NEW123
shoplazza orders +update-tracking --order-id <id> --fulfillment-id <id> --tracking NEW123 \
  --company UPS --tracking-url "https://..." --notify

API 命令​

所有动态 API 命令共享以下参数：

参数短参说明
--params路径/查询参数（JSON 格式）
--data请求体（JSON 格式，可内联、@file 或 - 读取 stdin）；仅在需要请求体的命令上提供
--jq-qjq 表达式过滤输出
--dry-run预览请求，不实际执行

orders​

shell
shoplazza orders list
shoplazza orders get --params '{"order_id":"123"}'
shoplazza orders get-by-number --params '{"number":"1001"}'
shoplazza orders create --data @order.json
shoplazza orders update --params '{"order_id":"123"}' --data @order.json
shoplazza orders delete --params '{"order_id":"123"}'
shoplazza orders cancel --params '{"order_id":"123"}'
shoplazza orders pay --params '{"order_id":"123"}'
shoplazza orders count

orders fulfillments​

shell
shoplazza orders fulfillments list --params '{"order_id":"123"}'
shoplazza orders fulfillments get --params '{"order_id":"123","fulfillment_id":"456"}'
shoplazza orders fulfillments create --params '{"order_id":"123"}' --data @fulfillment.json
shoplazza orders fulfillments update --params '{"order_id":"123","fulfillment_id":"456"}' --data @fulfillment.json
shoplazza orders fulfillments complete --params '{"order_id":"123","fulfillment_id":"456"}'
shoplazza orders fulfillments cancel --params '{"order_id":"123","fulfillment_id":"456"}'
shoplazza orders fulfillments count --params '{"order_id":"123"}'

orders refunds​

shell
shoplazza orders refunds list --params '{"order_ids":["123"]}'
shoplazza orders refunds list-by-order --params '{"order_id":"123"}'
shoplazza orders refunds create --params '{"order_id":"123"}' --data @refund.json
shoplazza orders refunds finish --params '{"order_id":"123"}' --data @refund-finish.json
shoplazza orders refunds count

orders post-sales​

shell
shoplazza orders post-sales list
shoplazza orders post-sales delete --params '{"post_sale_id":"123"}'

orders risks​

shell
shoplazza orders risks list --params '{"order_id":"123"}'
shoplazza orders risks get --params '{"order_id":"123","id":"456"}'
shoplazza orders risks create --params '{"order_id":"123"}' --data @risk.json
shoplazza orders risks update --params '{"order_id":"123","id":"456"}' --data @risk.json
shoplazza orders risks delete --params '{"order_id":"123","id":"456"}'

orders transactions​

shell
shoplazza orders transactions list --params '{"order_id":"123"}'
shoplazza orders transactions batch-list --params '{"order_ids":["123","456"]}'

orders shipping-schemas​

shell
shoplazza orders shipping-schemas get-general
shoplazza orders shipping-schemas save-general --data @schema.json
shoplazza orders shipping-schemas create-zone --data @zone.json
shoplazza orders shipping-schemas update-zone --params '{"id":"123"}' --data @zone.json
shoplazza orders shipping-schemas delete-zone --params '{"id":"123"}'
shoplazza orders shipping-schemas get-available-lines --data '{"order_id":"123","country_code":"US"}'

orders tracking-carriers​

shell
shoplazza orders tracking-carriers list
shoplazza orders tracking-carriers detect --params '{"tracking_number":"1234567890"}'

Schema 自省​

shell
shoplazza schema orders
shoplazza schema orders.fulfillments.create
在此页面