qmai-cli-public 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/README.md +18 -1
  2. package/npm/install.js +128 -32
  3. package/package.json +2 -1
  4. package/skills/qmai-delivery/SKILL.md +52 -0
  5. package/skills/qmai-delivery/references/qmai-delivery-order.md +23 -0
  6. package/skills/qmai-delivery/references/qmai-delivery-status.md +19 -0
  7. package/skills/qmai-finance/SKILL.md +53 -0
  8. package/skills/qmai-finance/references/qmai-finance-statement.md +22 -0
  9. package/skills/qmai-finance/references/qmai-finance-stats.md +22 -0
  10. package/skills/qmai-inventory/SKILL.md +72 -0
  11. package/skills/qmai-inventory/references/qmai-inventory-master.md +29 -0
  12. package/skills/qmai-inventory/references/qmai-inventory-sales.md +25 -0
  13. package/skills/qmai-inventory/references/qmai-inventory-stock.md +29 -0
  14. package/skills/qmai-marketing/SKILL.md +80 -0
  15. package/skills/qmai-marketing/references/qmai-marketing-card-pricing.md +29 -0
  16. package/skills/qmai-marketing/references/qmai-marketing-coupon.md +27 -0
  17. package/skills/qmai-member/SKILL.md +175 -0
  18. package/skills/qmai-member/references/qmai-member-asset.md +35 -0
  19. package/skills/qmai-member/references/qmai-member-profile-tag.md +51 -0
  20. package/skills/qmai-order/SKILL.md +64 -0
  21. package/skills/qmai-order/references/qmai-order-query.md +26 -0
  22. package/skills/qmai-order/references/qmai-order-write.md +21 -0
  23. package/skills/qmai-product/SKILL.md +183 -0
  24. package/skills/qmai-product/references/qmai-product-advanced.md +92 -0
  25. package/skills/qmai-product/references/qmai-product-batch.md +113 -0
  26. package/skills/qmai-product/references/qmai-product-category.md +67 -0
  27. package/skills/qmai-product/references/qmai-product-crud.md +126 -0
  28. package/skills/qmai-queue/SKILL.md +38 -0
  29. package/skills/qmai-queue/references/qmai-queue-read.md +21 -0
  30. package/skills/qmai-shared/SKILL.md +155 -0
  31. package/skills/qmai-shared/references/qmai-shared-auth.md +54 -0
  32. package/skills/qmai-shared/references/qmai-shared-config.md +69 -0
  33. package/skills/qmai-store/SKILL.md +90 -0
  34. package/skills/qmai-store/references/qmai-store-read.md +45 -0
  35. package/skills/qmai-store/references/qmai-store-write.md +44 -0
@@ -0,0 +1,80 @@
1
+ ---
2
+ name: qmai-marketing
3
+ version: 1.1.0
4
+ description: "营销服务:券查询与发券、活动查询与撤销、礼品卡查询与写入、结算页算价"
5
+ metadata:
6
+ bins: [qmai]
7
+ help: "qmai marketing --help"
8
+ ---
9
+
10
+ > 前置条件: 请先阅读 ../qmai-shared/SKILL.md 了解认证和配置
11
+
12
+ ## 核心概念
13
+
14
+ - **coupon**: 券状态、券详情、券模板、不记名券、筛券、发券和模板启用
15
+ - **campaign**: 发券活动、撤销发券、兑换码下发/作废、兑换码状态、任务活动参与记录和任务领取
16
+ - **gift-card**: 卡信息、消费明细、卡模板、会员卡列表,以及单卡/批量余额扣减、冲正和发放
17
+ - **pricing**: 门店促销活动查询与结算页算价
18
+
19
+ ## 命令概览
20
+
21
+ ### 券管理
22
+ ```bash
23
+ qmai marketing coupon status --id CPN001
24
+ qmai marketing coupon detail --user-coupon-code CPN001
25
+ qmai marketing coupon template --id 1001
26
+ qmai marketing coupon template-enable --id 1001 --dry-run
27
+ qmai marketing coupon template-batch --ids 1001,1002
28
+ qmai marketing coupon anonymous --code ANON001
29
+ qmai marketing coupon template-by-third-code --seller-type 2 --third-biz-code EXT001
30
+ qmai marketing coupon choose --from-json choose-coupon.json
31
+ qmai marketing coupon grant-activity --from-json grant-activity.json --dry-run
32
+ qmai marketing coupon grant-activity-async --from-json grant-activity-async.json --dry-run
33
+ qmai marketing coupon grant-template --from-json grant-template.json --dry-run
34
+ ```
35
+
36
+ ### 活动管理
37
+ ```bash
38
+ qmai marketing campaign list --channel-id 1 --page 1 --page-size 20
39
+ qmai marketing campaign revoke-grant --from-json revoke-grant.json --dry-run
40
+ qmai marketing campaign exchange-dispatch --from-json exchange-dispatch.json --dry-run
41
+ qmai marketing campaign exchange-disable --from-json exchange-disable.json --dry-run
42
+ qmai marketing campaign exchange-status --code EXCHANGE001
43
+ qmai marketing campaign task-records --activity-ids 1001,1002 --customer-id 2001
44
+ qmai marketing campaign task-claim --from-json task-claim.json --dry-run
45
+ qmai marketing campaign recycle-coupons --from-json recycle-coupons.json --dry-run
46
+ ```
47
+
48
+ ### 卡管理
49
+ ```bash
50
+ qmai marketing gift-card info --card-no CARD001 --take-card-template 1
51
+ qmai marketing gift-card flow --card-no CARD001 --page 1 --page-size 20
52
+ qmai marketing gift-card template --id 3001
53
+ qmai marketing gift-card template-batch --ids 3001,3002
54
+ qmai marketing gift-card list --customer-id 2001 --shop-code S001
55
+ qmai marketing gift-card consume --from-json gift-card-consume.json --dry-run
56
+ qmai marketing gift-card consume-batch --from-json gift-card-consume-batch.json --dry-run
57
+ qmai marketing gift-card reverse --from-json gift-card-reverse.json --dry-run
58
+ qmai marketing gift-card reverse-batch --from-json gift-card-reverse-batch.json --dry-run
59
+ qmai marketing gift-card part-reverse --from-json gift-card-part-reverse.json --dry-run
60
+ qmai marketing gift-card issue --from-json gift-card-issue.json --dry-run
61
+ qmai marketing gift-card report-loss --from-json gift-card-report-loss.json --dry-run
62
+ qmai marketing gift-card relieve-loss --from-json gift-card-relieve-loss.json --dry-run
63
+ qmai marketing gift-card recycle --from-json gift-card-recycle.json --dry-run
64
+ qmai marketing gift-card exchange --from-json gift-card-exchange.json --dry-run
65
+ qmai marketing gift-card grant-template --from-json gift-card-grant-template.json --dry-run
66
+ ```
67
+
68
+ ### 营销计算
69
+ ```bash
70
+ qmai marketing pricing activities --from-json promotion-activities.json
71
+ qmai marketing pricing confirm --from-json confirm.json
72
+ ```
73
+
74
+ ## 注意事项(Agent 必读)
75
+
76
+ - `coupon choose`、发券命令和 `pricing activities/confirm` 入参复杂,统一用 `--from-json`
77
+ - `pricing confirm` 目前默认表格只展示价格摘要,若要看完整算价结果请加 `--format json`
78
+ - 活动实时发券、异步发券、模板发券、模板启用、撤销发券、兑换码下发/作废、任务领取、回收券,以及礼品卡扣减/冲正/挂失/回收/兑换/发放已经进入正式命令面
79
+ - 礼品卡写接口同样统一用 `--from-json`,建议先 `--dry-run`;其中 `part-reverse` 只能冲正统一消费接口,不能和全额冲正混用
80
+ - `campaign list`、`gift-card flow` 是显式分页,不会自动拉全量
@@ -0,0 +1,29 @@
1
+ # qmai-marketing card/pricing 参考
2
+
3
+ ```bash
4
+ qmai marketing campaign list --channel-id 1
5
+ qmai marketing campaign task-records --activity-ids 1001,1002 --customer-id 2001
6
+ qmai marketing gift-card info --card-no CARD001
7
+ qmai marketing gift-card flow --card-no CARD001 --page 1 --page-size 20
8
+ qmai marketing gift-card list --customer-id 2001 --shop-code S001
9
+ qmai marketing gift-card consume --from-json gift-card-consume.json --dry-run
10
+ qmai marketing gift-card consume-batch --from-json gift-card-consume-batch.json --dry-run
11
+ qmai marketing gift-card reverse --from-json gift-card-reverse.json --dry-run
12
+ qmai marketing gift-card reverse-batch --from-json gift-card-reverse-batch.json --dry-run
13
+ qmai marketing gift-card part-reverse --from-json gift-card-part-reverse.json --dry-run
14
+ qmai marketing gift-card issue --from-json gift-card-issue.json --dry-run
15
+ qmai marketing gift-card report-loss --from-json gift-card-report-loss.json --dry-run
16
+ qmai marketing gift-card relieve-loss --from-json gift-card-relieve-loss.json --dry-run
17
+ qmai marketing gift-card recycle --from-json gift-card-recycle.json --dry-run
18
+ qmai marketing gift-card exchange --from-json gift-card-exchange.json --dry-run
19
+ qmai marketing gift-card grant-template --from-json gift-card-grant-template.json --dry-run
20
+ qmai marketing pricing activities --from-json promotion-activities.json
21
+ qmai marketing pricing confirm --from-json confirm.json --format json
22
+ ```
23
+
24
+ ## 说明
25
+
26
+ - `pricing` 相关接口字段很多,建议先保留一份请求 JSON 模板
27
+ - `pricing confirm` 用表格模式看摘要,用 `json` 看完整算价细节
28
+ - 礼品卡冲正分为全额冲正和部分冲正两种,部分冲正要额外提供 `subBizId`
29
+ - 礼品卡挂失/取消挂失一次最多处理数量以开放平台文档为准,CLI 不放宽上限
@@ -0,0 +1,27 @@
1
+ # qmai-marketing coupon 参考
2
+
3
+ ```bash
4
+ qmai marketing coupon status --id CPN001
5
+ qmai marketing coupon detail --user-coupon-code CPN001
6
+ qmai marketing coupon template --id 1001
7
+ qmai marketing coupon template-enable --id 1001 --dry-run
8
+ qmai marketing coupon template-batch --ids 1001,1002
9
+ qmai marketing coupon anonymous --code ANON001
10
+ qmai marketing coupon template-by-third-code --seller-type 2 --third-biz-code EXT001
11
+ qmai marketing coupon choose --from-json choose-coupon.json
12
+ qmai marketing coupon grant-activity --from-json grant-activity.json --dry-run
13
+ qmai marketing coupon grant-activity-async --from-json grant-activity-async.json --dry-run
14
+ qmai marketing coupon grant-template --from-json grant-template.json --dry-run
15
+ qmai marketing campaign revoke-grant --from-json revoke-grant.json --dry-run
16
+ qmai marketing campaign exchange-dispatch --from-json exchange-dispatch.json --dry-run
17
+ qmai marketing campaign exchange-disable --from-json exchange-disable.json --dry-run
18
+ qmai marketing campaign task-claim --from-json task-claim.json --dry-run
19
+ qmai marketing campaign recycle-coupons --from-json recycle-coupons.json --dry-run
20
+ ```
21
+
22
+ ## 说明
23
+
24
+ - `choose-coupon.json` 直接按企迈文档请求结构组织
25
+ - 若只是查券模板,优先用 `template` / `template-batch`
26
+ - 发券与撤销发券都建议先 `--dry-run`,确认 `activityId`、`channelId`、`orderNo` 和会员标识结构
27
+ - 兑换码下发与作废一次最多处理的数量要按企迈文档约束,CLI 不额外放宽
@@ -0,0 +1,175 @@
1
+ ---
2
+ name: qmai-member
3
+ version: 1.2.0
4
+ description: "会员服务:资产查询与写入、手机号注册、会员更新、会员标签查询与打标"
5
+ metadata:
6
+ bins: [qmai]
7
+ help: "qmai member --help"
8
+ ---
9
+
10
+ > 前置条件: 请先阅读 ../qmai-shared/SKILL.md 了解认证和配置
11
+
12
+ ## 核心概念
13
+
14
+ - **customerId**: 会员主键,大多数会员接口都以它作为入参
15
+ - **会员资产**: 当前命令覆盖积分、储值余额、优惠券、优惠券明细、积分明细、余额明细、储值规则、资产膨胀状态,以及充值、扣减、冲正、消费、核销等写接口
16
+ - **会员信息**: 当前首批命令覆盖会员查询、会员基础信息、会员 ID 映射、等级与风险等级,以及手机号注册、基本信息更新
17
+ - **会员标签**: 当前首批命令覆盖标签列表、标签详情、品牌标签、标签组、标签 ID 列表和打标
18
+
19
+ ## 命令概览
20
+
21
+ ### 会员资产
22
+ ```bash
23
+ qmai member asset points --customer-id C001
24
+ qmai member asset balance --customer-id C001
25
+ qmai member asset coupons --customer-id C001
26
+ qmai member asset coupon-list --customer-id C001 --page 1 --page-size 20
27
+ qmai member asset balance-flow --customer-id C001 --page 1 --page-size 20
28
+ qmai member asset points-flow --customer-id C001 --page 1 --page-size 20
29
+ qmai member asset level-experience --customer-id C001
30
+ qmai member asset discount --customer-id C001
31
+ qmai member asset personal-asset --customer-id C001
32
+ qmai member asset deposit-rules --shop-code S001
33
+ qmai member asset inflate-status --customer-id C001
34
+ qmai member asset coupon-detail-list --customer-id C001 --store-id 1001
35
+ qmai member asset recharge --from-json recharge.json --dry-run
36
+ qmai member asset recharge-reverse --from-json recharge-reverse.json --dry-run
37
+ qmai member asset balance-debit --from-json balance-debit.json --dry-run
38
+ qmai member asset balance-reverse --from-json balance-reverse.json --dry-run
39
+ qmai member asset offline-balance-op --from-json offline-balance-op.json --dry-run
40
+ qmai member asset points-debit --from-json points-debit.json --dry-run
41
+ qmai member asset points-reverse --from-json points-reverse.json --dry-run
42
+ qmai member asset points-add --from-json points-add.json --dry-run
43
+ qmai member asset consume --from-json consume.json --dry-run
44
+ qmai member asset consume-reverse --from-json consume-reverse.json --dry-run
45
+ qmai member asset coupon-writeoff --from-json coupon-writeoff.json --dry-run
46
+ qmai member asset coupon-reverse --from-json coupon-reverse.json --dry-run
47
+ ```
48
+
49
+ ### 会员信息
50
+ ```bash
51
+ qmai member profile info --identifier-number 13800138000 --type 2
52
+ qmai member profile id-by-code --code 13800138000 --type 2
53
+ qmai member profile ids-by-phone --phones 13800138000,13900139000
54
+ qmai member profile base-info --customer-id C001
55
+ qmai member profile open-id --customer-id C001 --type 1
56
+ qmai member profile search --phone 13800138000
57
+ qmai member profile dynamic-code --customer-id 1001
58
+ qmai member profile risk-level --code 13800138000 --type 2
59
+ qmai member profile level --mobile-phone 13800138000
60
+ qmai member profile register-phone --mobile-phone 13800138000 --reg-app-type 1 --dry-run
61
+ qmai member profile register-third-id --from-json register-third-id.json --dry-run
62
+ qmai member profile send-captcha --from-json send-captcha.json --dry-run
63
+ qmai member profile check-captcha --from-json check-captcha.json --dry-run
64
+ qmai member profile blacklist-add --from-json blacklist-add.json --dry-run
65
+ qmai member profile blacklist-remove --from-json blacklist-remove.json --dry-run
66
+ qmai member profile blacklist-status --customer-id C001
67
+ qmai member profile freeze --customer-id C001 --reason "风险处理" --dry-run
68
+ qmai member profile unfreeze --customer-id C001 --dry-run
69
+ qmai member profile logoff --customer-id C001 --reason "用户申请注销" --dry-run
70
+ qmai member profile update-phone --customer-id 1001 --phone 13800138001 --reason "换绑手机号" --dry-run
71
+ qmai member profile freeze-record --customer-id C001
72
+ qmai member profile has-open-order --customer-id C001 --biz-type 5
73
+ qmai member profile wecom-info --customer-id 1001
74
+ qmai member profile sign-status --user-id 1001 --activity-id 2001
75
+ qmai member profile account-level --customer-id 1001
76
+ qmai member profile condition-query --customer-ids 1001,1002 --conditions 10,20,40,60
77
+ qmai member profile update --id C001 --nickname "新昵称" --dry-run
78
+ ```
79
+
80
+ ### 会员标签
81
+ ```bash
82
+ qmai member tag list --customer-id C001 --page 1 --page-size 20
83
+ qmai member tag detail --id 1001
84
+ qmai member tag brand-list
85
+ qmai member tag ids --customer-id C001
86
+ qmai member tag groups --label-attributed 2
87
+ qmai member tag group-labels --label-group-id 1001
88
+ qmai member tag create --label-code VIP_TAG --label-name "会员标签" --dry-run
89
+ qmai member tag delete --label-code VIP_TAG --dry-run
90
+ qmai member tag clear-members --label-code VIP_TAG --customer-ids C001,C002 --dry-run
91
+ qmai member tag delete-customer-label --customer-id C001 --panorama-label-id 1001 --dry-run
92
+ qmai member tag settings
93
+ qmai member tag mark --customer-ids C001,C002 --label-code VIP_TAG --mark-date "2026-04-07 12:00:00" --dry-run
94
+ ```
95
+
96
+ ## 开放平台 API 端点
97
+
98
+ | 操作 | 端点 |
99
+ | --- | --- |
100
+ | 会员积分查询 | POST /v3/crm/points/getCustomerPoints |
101
+ | 查询会员优惠券 | POST /v3/crm/coupon/getCustomerCoupons |
102
+ | 查询会员储值余额扣减明细 | POST /v3/crm/account/getDecreaseBalanceBiz |
103
+ | 查询会员储值余额明细 | POST /v3/crm/account/queryAccountFlow |
104
+ | 查询会员实时折扣 | POST /v3/crm/customer/getLevelConsumeDiscount |
105
+ | 查询会员等级和经验值 | POST /v3/crm/customer/getLevelExperience |
106
+ | 查询会员储值余额 | POST /v3/crm/customer/getCustomerBalance |
107
+ | 查询会员优惠券列表 | POST /v3/crm/coupon/getCustomerCouponList |
108
+ | 查询会员积分明细 | POST /v3/crm/customer/getCrmPointsFlow |
109
+ | 查询用户资产 | POST /v3/crm/customerInfo/personalAsset |
110
+ | 查询门店储值规则 | POST /v3/marketing/deposit/getStoreOrShopDepositList |
111
+ | 查询资产膨胀状态 | POST /v3/crm/customer/assetInflateDetail |
112
+ | 优惠券列表明细 | POST /v3/newPattern/crmCenter/get/customer-coupons/get_my_coupons_v2 |
113
+ | 会员储值充值 | POST /v3/bsns/customerBalance/userRecharge |
114
+ | 会员充值冲正 | POST /v3/bsns/customerBalance/userRechargeReverse |
115
+ | 会员储值余额扣减 | POST /v3/crm/account/decreaseBalance |
116
+ | 会员储值余额冲正 | POST /v3/crm/account/decreaseBalanceReverse |
117
+ | 储值账户充值扣减 | POST /v3/newPattern/crmCenter/post/customer-account/v2/offline-operation-balance |
118
+ | 会员积分扣减 | POST /v3/crm/points/reducePoints |
119
+ | 会员积分冲正 | POST /v3/crm/points/reversePoints |
120
+ | 会员积分发放 | POST /v3/crm/points/addCustomerPoints |
121
+ | 会员资产消费 | POST /v3/crm/customer/customerConsume |
122
+ | 会员资产冲正 | POST /v3/crm/customer/consumeReverse |
123
+ | 优惠券核销 | POST /v3/crm/coupon/writeOffCoupon |
124
+ | 优惠券冲正 | POST /v3/crm/coupon/couponReverse |
125
+ | 会员信息查询 | POST /v3/crm/customer/getCustomerInfo |
126
+ | 通过会员标识查询会员ID | POST /v3/crm/customer/getCustomerIdByCode |
127
+ | 通过手机号批量查询会员ID | POST /v3/crm/customer/getCustomerIdByPhone |
128
+ | 通过会员ID获取微信支付宝用户唯一标识 | POST /v3/crm/customer/getCustomerOpenId |
129
+ | 通过手机号注册会员 | POST /v3/crm/customer/phoneRegister |
130
+ | 查询会员的动态码 | POST /v3/crm/customer/getCustomerCode |
131
+ | 通过三方ID注册会员 | POST /v3/crm/customer/customerRegister |
132
+ | 发送短信验证码 | POST /v3/message/commonSendSmsCaptcha |
133
+ | 校验短信验证码 | POST /v3/message/commonCheckSmsCaptcha |
134
+ | 设置黑名单 | POST /v3/crm/customer/batchAddBlackList |
135
+ | 取消黑名单 | POST /v3/crm/customer/batchCancelBlackList |
136
+ | 黑名单校验 | POST /v3/crm/customer/queryMemberBlack |
137
+ | 冻结用户 | POST /v3/crm/customer/logoffFreeze |
138
+ | 冻结用户-撤销 | POST /v3/crm/customer/logoffUnfreeze |
139
+ | 会员注销 | POST /v3/crm/customer/logOff |
140
+ | 会员换绑手机号 | POST /v3/crm/customer/updatePhone |
141
+ | 查询用户冻结记录 | POST /v3/crm/customer/queryFreezeRecord |
142
+ | 查询用户是否存在未完成订单 | POST /v3/newPattern/accountCenter/post/account/can-logoff |
143
+ | 查询会员企微信息 | POST /v3/crm/customer/weComCustomerInfo |
144
+ | 查询会员签到状态 | POST /v3/crm/customer/queryActivitySign |
145
+ | 查询会员储值等级 | POST /v3/newPattern/crmCenter/get/customer-account-card/query-account-level |
146
+ | 按需查询会员信息 | POST /v3/newPattern/crmCenter/post/customer-condition/query |
147
+ | 更新会员基本信息 | POST /v3/crm/customer/updateMember |
148
+ | 会员基础信息查询 | POST /v3/crm/customer/getBaseInfo |
149
+ | 会员查询 | POST /v3/crm/customer/allCustomerInfo |
150
+ | 查询会员风险等级 | POST /v3/crm/customer/riskLevel |
151
+ | 查询会员等级 | POST /v3/crm/customer/member/detail |
152
+ | 通过会员ID查询用户标签 | POST /v3/cdp/panoramaLabel/pageByCustomerId |
153
+ | 查询标签详情 | POST /v3/cdp/panoramaLabel/detail |
154
+ | 查询静态用户标签列表(根据标签组ID) | POST /v3/cdp/panoramaLabel/list |
155
+ | 查询静态用户标签列表(根据标签类别) | POST /v3/cdp/panoramaLabel/listGroup |
156
+ | 创建会员标签 | POST /v3/cdp/panoramaLabel/panoramaLabelCreate |
157
+ | 删除会员标签 | POST /v3/cdp/panoramaLabel/panoramaLabelDelete |
158
+ | 清除会员标签下的会员 | POST /v3/cdp/panoramaLabel/panoramaLabelDelete |
159
+ | 清除会员的指定标签 | POST /v3/cdp/panoramaLabel/deleteCustomerLabel |
160
+ | 给指定会员打标签 | POST /v3/cdp/panoramaLabel/panoramaLabelMark |
161
+ | 查询标签设置 | POST /v3/crm/customer/brandInfo |
162
+ | 查询品牌下标签列表 | POST /v3/cdp/panoramaLabel/panoramaLabelList |
163
+ | 查询会员的标签id | POST /v3/newPattern/cdpCenter/get/panorama-label/list-by-customerId |
164
+
165
+ ## 注意事项(Agent 必读)
166
+
167
+ - 当前 `qmai member` 已补资产写接口、手机号注册、会员更新和会员打标,但冻结、注销、短信验证码等接口仍未进入正式命令面
168
+ - 大多数会员接口不依赖 `shopCode`,但仍要求 profile 中已完成开放平台认证
169
+ - 分页命令当前是显式分页,`coupon-list`、`coupon-detail-list`、`balance-flow`、`points-flow`、`tag list`、`tag group-labels` 不会自动拉全量
170
+ - `personal-asset` 对应文档带有 C 端属性,CLI 目前只做查询封装,不默认承诺和小程序端完全一致
171
+ - 风险等级和 ID 映射类接口都依赖 `code + type` 组合,类型值要按企迈文档填写
172
+ - 资产写接口统一使用 `--from-json`,先 `--dry-run` 预览再执行,避免在 flag 层散落大量不稳定字段
173
+ - 标签写接口优先使用明确 flag,不走 `--from-json`;单次清除/打标人数上限仍以企迈文档为准
174
+ - 三方注册和短信验证码相关接口统一使用 `--from-json`,避免手机号、渠道、验证码事件配置散落在 flag 中
175
+ - `4.2.7 查询会员是否开启密码校验` 的文档未给出明确业务响应字段,当前仍保留在矩阵中但未暴露命令
@@ -0,0 +1,35 @@
1
+ # qmai-member asset 参考
2
+
3
+ ## 建议使用顺序
4
+
5
+ 1. 先用 `balance` / `points` 看会员当前资产
6
+ 2. 再用 `balance-flow` / `points-flow` 查资产变化轨迹
7
+ 3. 需要看券时再用 `coupons` 或 `coupon-list`
8
+ 4. 资产写操作统一先走 `--dry-run`,确认 JSON 结构后再正式执行
9
+
10
+ ## 示例
11
+
12
+ ```bash
13
+ qmai member asset points --customer-id C001
14
+ qmai member asset balance --customer-id C001
15
+ qmai member asset coupons --customer-id C001 --use-status 1
16
+ qmai member asset coupon-list --customer-id C001 --coupon-type 2 --page 1 --page-size 20
17
+ qmai member asset coupon-detail-list --customer-id C001 --store-id 1001 --use-status 0 --page 1 --page-size 20
18
+ qmai member asset balance-flow --customer-id C001 --start-time 2026-04-01 00:00:00 --end-time 2026-04-07 23:59:59
19
+ qmai member asset points-flow --customer-id C001 --change-types REWARD,CONSUME --page 1 --page-size 20
20
+ qmai member asset deposit-rules --shop-code S001
21
+ qmai member asset inflate-status --customer-id C001
22
+ qmai member asset recharge --from-json recharge.json --dry-run
23
+ qmai member asset recharge-reverse --from-json recharge-reverse.json --dry-run
24
+ qmai member asset offline-balance-op --from-json offline-balance-op.json --dry-run
25
+ qmai member asset balance-debit --from-json balance-debit.json --dry-run
26
+ qmai member asset points-add --from-json points-add.json --dry-run
27
+ qmai member asset consume --from-json consume.json --dry-run
28
+ qmai member asset coupon-writeoff --from-json coupon-writeoff.json --dry-run
29
+ ```
30
+
31
+ ## 输出说明
32
+
33
+ - 表格模式默认显示核心字段,适合巡检
34
+ - `--format json` 输出完整响应结构,适合排查字段缺失和对照文档
35
+ - 写接口默认只回显提交结果,复杂入参请放在 JSON 文件中维护
@@ -0,0 +1,51 @@
1
+ # qmai-member profile/tag 参考
2
+
3
+ ## 常见查询
4
+
5
+ ```bash
6
+ qmai member profile info --identifier-number 13800138000 --type 2
7
+ qmai member profile id-by-code --code 13800138000 --type 2
8
+ qmai member profile ids-by-phone --phones 13800138000,13900139000
9
+ qmai member profile open-id --customer-id C001 --type 1
10
+ qmai member profile search --phone 13800138000 --page 1 --page-size 20
11
+ qmai member profile dynamic-code --customer-id 1001
12
+ qmai member profile risk-level --code 13800138000 --type 2
13
+ qmai member profile register-phone --mobile-phone 13800138000 --reg-app-type 1 --username 张三 --dry-run
14
+ qmai member profile register-third-id --from-json register-third-id.json --dry-run
15
+ qmai member profile send-captcha --from-json send-captcha.json --dry-run
16
+ qmai member profile check-captcha --from-json check-captcha.json --dry-run
17
+ qmai member profile blacklist-add --from-json blacklist-add.json --dry-run
18
+ qmai member profile blacklist-remove --from-json blacklist-remove.json --dry-run
19
+ qmai member profile blacklist-status --customer-id C001
20
+ qmai member profile freeze --customer-id C001 --reason "风险处理" --dry-run
21
+ qmai member profile unfreeze --customer-id C001 --dry-run
22
+ qmai member profile logoff --customer-id C001 --reason "用户申请注销" --dry-run
23
+ qmai member profile update-phone --customer-id 1001 --phone 13800138001 --reason "换绑手机号" --dry-run
24
+ qmai member profile freeze-record --customer-id C001
25
+ qmai member profile has-open-order --customer-id C001 --biz-type 5
26
+ qmai member profile wecom-info --customer-id 1001
27
+ qmai member profile sign-status --user-id 1001 --activity-id 2001
28
+ qmai member profile account-level --customer-id 1001
29
+ qmai member profile condition-query --customer-ids 1001,1002 --conditions 10,20,40,60
30
+ qmai member profile update --id C001 --nickname 新昵称 --qm-from wechat --dry-run
31
+ qmai member tag list --customer-id C001 --page 1 --page-size 20
32
+ qmai member tag detail --id 1001
33
+ qmai member tag brand-list
34
+ qmai member tag groups --label-attributed 2
35
+ qmai member tag group-labels --label-group-id 1001 --page 1 --page-size 20
36
+ qmai member tag create --label-code VIP_TAG --label-name "会员标签" --dry-run
37
+ qmai member tag delete --label-code VIP_TAG --dry-run
38
+ qmai member tag clear-members --label-code VIP_TAG --customer-ids C001,C002 --dry-run
39
+ qmai member tag delete-customer-label --customer-id C001 --panorama-label-id 1001 --dry-run
40
+ qmai member tag settings
41
+ qmai member tag mark --customer-ids C001,C002 --label-code VIP_TAG --mark-date "2026-04-07 12:00:00" --dry-run
42
+ qmai member tag ids --customer-id C001
43
+ ```
44
+
45
+ ## 约束
46
+
47
+ - `profile info` 至少传一个查询条件
48
+ - `id-by-code` 和 `risk-level` 都必须带 `--type`
49
+ - `open-id` 的 `--type` 不传时按企迈默认值处理
50
+ - `tag list` 是分页查询,不会自动取全量
51
+ - `register-phone`、`register-third-id`、短信验证码、标签写接口和 `tag mark` 都建议先用 `--dry-run`
@@ -0,0 +1,64 @@
1
+ ---
2
+ name: qmai-order
3
+ version: 1.1.0
4
+ description: "订单服务:订单查询、评价回复、订单上报、批量订单同步、制作单查询"
5
+ metadata:
6
+ bins: [qmai]
7
+ help: "qmai order --help"
8
+ ---
9
+
10
+ > 前置条件: 请先阅读 ../qmai-shared/SKILL.md 了解认证和配置
11
+
12
+ ## 核心概念
13
+
14
+ - **query**: 订单列表、订单详情、储值单、订单状态、制作单和新老用户下单判断
15
+ - **review**: 门店回复用户评价
16
+ - **report**: 订单上报、退款上报、批量已完成订单同步、批量已退款订单同步
17
+
18
+ ## 命令概览
19
+
20
+ ### 订单查询
21
+ ```bash
22
+ qmai order query user-orders --order-at-start "2026-04-01 00:00:00" --order-at-end "2026-04-07 23:59:59" --size 20 --user-id 1001
23
+ qmai order query detail --biz-type 5 --order-no O20260407001
24
+ qmai order query recharge-orders --shop-code S001 --start-time 20260401 --end-time 20260407 --page 1 --page-size 20
25
+ qmai order query recharge-refunds --shop-code S001 --start-time 20260401 --end-time 20260407 --page 1 --page-size 20
26
+ qmai order query status --order-no O20260407001
27
+ qmai order query member-ordered --biz-type 5 --user-id 1001
28
+ qmai order query production-records --user-id 1001 --order-no O20260407001
29
+ ```
30
+
31
+ ### 评价与上报
32
+ ```bash
33
+ qmai order review reply --order-no O20260407001 --reply-at "2026-04-07 18:00:00" --seller-reply-info "感谢反馈" --dry-run
34
+ qmai order report upload --from-json order-upload.json
35
+ qmai order report refund-up --from-json refund-up.json
36
+ qmai order report completed-batch --from-json completed-batch.json --dry-run
37
+ qmai order report refunded-batch --from-json refunded-batch.json --dry-run
38
+ ```
39
+
40
+ ## 开放平台 API 端点
41
+
42
+ | 操作 | 端点 |
43
+ | --- | --- |
44
+ | 查询用户订单列表 | POST /v3/order/getUserOrderList |
45
+ | 查询订单详情 | POST /v3/order/getDetail |
46
+ | 查询门店储值消费订单 | POST /v3/order/standard/recharge/order |
47
+ | 查询门店储值消费退款单 | POST /v3/order/standard/recharge/refundOrder |
48
+ | 查询订单状态 | POST /v3/order/status |
49
+ | 查询用户是否下过订单 | POST /v3/order/checkMemberOrder |
50
+ | 回复订单评价 | POST /v3/order/comment/storeReplyUserComment |
51
+ | 订单上报 | POST /v3/bsns/order/orderUpload |
52
+ | 退款订单上报 | POST /v3/cy/order/refundOrderUp |
53
+ | 提交已完成订单 | POST /v3/bsns/order/orderBatchUpload |
54
+ | 提交已退款订单 | POST /v3/bsns/order/refundOrderBatchUpload |
55
+ | 查询商品制作单列表 | POST /v3/newPattern/orderCenter/post/order/item/production/record/list |
56
+
57
+ ## 注意事项(Agent 必读)
58
+
59
+ - `report upload`、`report refund-up`、`report completed-batch`、`report refunded-batch` 的请求体较复杂,统一使用 `--from-json`
60
+ - `review reply` 为写操作,默认建议先用 `--dry-run`
61
+ - `query user-orders` 当前按接口原生条件查询,不会自动翻页补全历史区间内的全部订单
62
+ - `member-ordered` 返回值 `0` 表示新用户,`1` 表示非新用户
63
+ - 订单详情接口依赖 `bizType`,通常 `5=新饮食`、`4=新休闲`
64
+ - 售后、履约、配送骑手、退款审核等接口仍未进入正式命令面
@@ -0,0 +1,26 @@
1
+ # qmai-order 查询参考
2
+
3
+ ## 适用场景
4
+
5
+ - 按用户查询订单列表
6
+ - 查看单笔订单详情和状态
7
+ - 拉取储值消费订单和退款单
8
+ - 判断会员是否属于“下过单用户”
9
+ - 查询制作单记录
10
+
11
+ ## 推荐命令
12
+
13
+ ```bash
14
+ qmai order query user-orders --order-at-start "2026-04-01 00:00:00" --order-at-end "2026-04-07 23:59:59" --size 20 --user-id 1001
15
+ qmai order query detail --biz-type 5 --order-no O20260407001
16
+ qmai order query status --order-no O20260407001
17
+ qmai order query member-ordered --biz-type 5 --user-id 1001
18
+ qmai order query production-records --user-id 1001 --order-no O20260407001
19
+ ```
20
+
21
+ ## 排查建议
22
+
23
+ - 查询不到订单时,先核对时间范围格式是否符合接口要求
24
+ - `detail` 查不到时,先确认 `biz-type` 是否与该订单所属业务一致
25
+ - 储值订单接口时间参数使用 `yyyyMMdd`,不要误传完整时间戳
26
+ - 若需要完整原始字段,优先加 `--format json`
@@ -0,0 +1,21 @@
1
+ # qmai-order 写操作参考
2
+
3
+ ## 适用场景
4
+
5
+ - 订单评价回复
6
+ - 第三方订单上报
7
+ - 第三方退款单上报
8
+
9
+ ## 推荐命令
10
+
11
+ ```bash
12
+ qmai order review reply --order-no O20260407001 --reply-at "2026-04-07 18:00:00" --seller-reply-info "感谢反馈" --dry-run
13
+ qmai order report upload --from-json order-upload.json
14
+ qmai order report refund-up --from-json refund-up.json
15
+ ```
16
+
17
+ ## 风险控制
18
+
19
+ - `review reply` 先用 `--dry-run` 校验参数,再执行真实回复
20
+ - `order upload` 和 `refund-up` 先保留原始 JSON 文件,便于重试和审计
21
+ - 上报类接口成功返回的是受理结果,不代表下游业务已经全部完成