Skill
花漾TK CLI 技能
重要提示:每个命令都可以执行
--help查看详细用法、所有可用参数和示例。 例如huayoungtk-cli creator list --help、huayoungtk-cli shop sync --help。 当你不确定某个命令支持哪些参数时,优先使用--help查询。
本技能涵盖花漾TK CLI 的所有业务命令,供 AI Agent 操作花漾TK平台。
认证
首次使用前通过 API token 登录。Token 获取方式:打开花漾TK门户网站 → 设置 → 我的个人设置 → 开放龙虾(OpenClaw)配置 → 生成并复制授权 Key。
huayoungtk-cli auth login --token <api-token>
可选指定 endpoint(默认 https://api.szdamai.com):
huayoungtk-cli auth login --token <api-token> --endpoint https://api.szdamai.com
登录后检查连通性:
huayoungtk-cli auth check # 验证 token 是否有效
huayoungtk-cli auth status # 查看当前配置状态
配置存储在 ~/.huayoungtk-cli/config.json,单一 token,无多 Profile。
安全规则
- 禁止明文输出密钥 — 永远不要在对话中显示 API token 等敏感信息
- 写入操作需确认 — 在执行写入/删除操作前,先展示
--dry-run预览,获得用户确认 - 高风险操作审批 — 当 CLI 返回 exit code 10(confirmation_required)时:
- 向用户展示风险信息
- 获得明确同意后,追加
--yes标志重新执行 - 禁止自动跳过审批
输出格式
所有 CLI 输出遵循 JSON envelope 格式:
成功:
{"ok": true, "data": ...}失败:
{"ok": false, "error": {"type": "...", "message": "...", "hint": "..."}}stdout 是数据,stderr 是进度/提示信息
使用
--output或-o控制输出格式:json、ndjson使用
--jq通过 jq 表达式过滤输出
命令速览
huayoungtk-cli auth <login|logout|status|check> # 认证管理
huayoungtk-cli creator list [flags] # 列出团队达人
huayoungtk-cli creator get <--id|--handle|--cid> <value> # 获取达人详情
huayoungtk-cli creator note <--id|--handle|--cid> --remark # 修改达人备注
huayoungtk-cli creator tag <--id|--handle|--cid> --tag # 给达人打标签或取消标签
huayoungtk-cli creator status <--id|--handle|--cid> --shop-id <id> --status <value> # 修改达人合作状态
huayoungtk-cli creator shops <--id|--handle|--cid> # 查看达人合作的店铺列表
huayoungtk-cli creator capability <--id|--handle|--cid> # 评估达人带货能力(索样参考)
huayoungtk-cli creator videos <--id|--handle|--cid> # 查看达人带货视频列表
huayoungtk-cli creator lives <--id|--handle|--cid> # 查看达人带货直播列表
huayoungtk-cli shop list [flags] # 列出店铺
huayoungtk-cli shop get <--shop-id|--shop-name> <value> # 获取店铺详情
huayoungtk-cli shop sync --shop-id <id> --device-id <id> # 同步店铺信息(异步RPA)
huayoungtk-cli video list [flags] # 列出带货视频
huayoungtk-cli video get <--id|--media-id> <value> # 查看视频详情
huayoungtk-cli video note <--id|--media-id> --remark <text> # 修改视频备注
huayoungtk-cli video tag <--id|--media-id> --tag <name> # 给视频打标签或取消标签
huayoungtk-cli live list [flags] # 列出带货直播
huayoungtk-cli live get <--id|--media-id> <value> # 查看直播详情
huayoungtk-cli live note <--id|--media-id> --remark <text> # 修改直播备注
huayoungtk-cli buyer list [flags] # 列出买家
huayoungtk-cli buyer get <--id|--handle> <value> # 查看买家详情
huayoungtk-cli buyer note <--id|--handle> --remark <text> # 修改买家备注
huayoungtk-cli buyer tag <--id|--handle> --tag <name> # 给买家打标签或取消标签
huayoungtk-cli order list [flags] # 查询订单列表
huayoungtk-cli order get --order-no <orderNo> # 查看订单详情
huayoungtk-cli sample-request list [flags] # 查询达人索样列表
huayoungtk-cli sample-request get <--id|--apply-id> <value> # 获取索样详情
huayoungtk-cli sample-request videos <--id|--apply-id> <value> # 获取索样关联视频
huayoungtk-cli sample-request lives <--id|--apply-id> <value> # 获取索样关联直播
huayoungtk-cli sample-request archive <--id|--apply-id> <value> # 搁置/取消搁置索样
huayoungtk-cli sample-request approve <--id|--apply-id> <value> --device-id <id> # 同意索样(不可撤销)
huayoungtk-cli sample-request reject <--id|--apply-id> <value> --device-id <id> # 拒绝索样(不可撤销)
huayoungtk-cli device list [flags] # 列出可用设备
huayoungtk-cli job get --job-id <id> # 查看任务详情与状态
huayoungtk-cli job cancel --job-id <id> # 取消任务
huayoungtk-cli team info # 查看团队信息、套餐、配额
huayoungtk-cli config show # 查看配置
huayoungtk-cli doctor # 诊断环境问题
达人(Creator)
达人是 TikTok Shop 的 KOL/网红,可以带货商家的商品。
核心标识符
| 字段 | 说明 | 可变性 |
|---|---|---|
cid |
TikTok 官方唯一 Creator 标识 | 不可修改 |
handle |
TikTok @用户名(达人 ID) | 达人可自行修改 |
id |
系统数据库 ID | 内部使用 |
合作状态
| 状态 | 值 | 含义 |
|---|---|---|
| NotContacted | 0 | 未接触,尚未建联 |
| Sent | 1 | 已触达,已发送邀约/私信/邮件/即时消息 |
| Collaborating | 2 | 合作中,已建立合作但尚未出单 |
| HasOrder | 9 | 已出单,已产生带货订单 |
状态为全局最高状态:如果达人针对店铺 A 已出单,针对店铺 B 未接触,则全局状态为"已出单"。
MCN 类型
| 类型 | 值 | 含义 |
|---|---|---|
| None | -1 | 未知 |
| NoPartner | 0 | 独立达人 |
| BoundedPartner | 1 | 机构达人(MCN 签约) |
creator list — 列出团队达人
huayoungtk-cli creator list [flags]
默认返回 15 条记录。使用 --page-size 调整,--page 翻页。
| 参数 | 必填 | 说明 |
|---|---|---|
-q, --query |
否 | 按达人 handle、昵称、备注搜索 |
--status |
否 | 按合作状态过滤:NotContacted、Sent、Collaborating、HasOrder |
--region |
否 | 按国家代码过滤,多个用逗号分隔(如 TH,VN,PH) |
--handle |
否 | 精确匹配达人 handle |
--owner |
否 | 按跟进 BD 用户 ID 过滤 |
--sort |
否 | 排序,格式 field 或 field:asc/field:desc |
--page |
否 | 页码,默认 1 |
--page-size |
否 | 每页数量,默认 15 |
输出字段
| 字段 | 说明 |
|---|---|
id |
数据库 ID |
handle |
TikTok handle |
nickname |
昵称 |
cid |
TikTok 官方 Creator 标识(不可修改) |
creatorId |
达人业务 ID(达人可修改) |
region |
国家代码 |
status |
合作状态 |
followers |
粉丝数 |
totalGmv |
总 GMV |
totalItemsSold |
总售出件数 |
totalProducts |
已带货商品总数 |
orderCount |
订单数 |
roi |
ROI |
cancelRate |
退货率(近 60 天) |
mcnType |
MCN 类型 |
level |
达人等级 |
remark |
备注 |
示例
huayoungtk-cli creator list
huayoungtk-cli creator list -q "fashion"
huayoungtk-cli creator list --status HasOrder
huayoungtk-cli creator list --region TH --sort totalGmv:desc
huayoungtk-cli creator list --status Collaborating --jq '.creators[] | {handle, followers, totalGmv}'
creator get — 获取达人详情
huayoungtk-cli creator get <--id|--handle|--cid> <value>
三种查找方式(任选其一):
| 参数 | 说明 | 可靠性 |
|---|---|---|
--id |
数据库 ID | 最可靠 |
--handle |
TikTok handle | 可靠(handle 可能被达人修改) |
--cid |
TikTok 官方 Creator 标识 | 需精确匹配 |
关键字段
| 字段 | 中文 | 说明 |
|---|---|---|
cid |
Creator ID | TikTok 官方唯一标识,不可修改 |
followerCnt |
粉丝数 | 达人粉丝数量 |
totalGmv |
总 GMV | 所有店铺商品售出总金额 |
totalItemsSold |
总售出件数 | 所有店铺商品售出总量 |
totalCommission |
佣金总额 | 所有店铺佣金总额 |
roi |
ROI | 投入产出比 |
cancelRate |
退货率 | 近 60 天带货订单退货率 |
gmvPercent |
话语权 | 近 30 天本团队 GMV 占达人整体 GMV 的比例 |
creatorFulfillmentScore |
达人评分 | 综合评分 |
level |
达人等级 | 平台等级 |
contentType |
内容类型 | All / Video / LIVE |
contactMap |
联系方式 | 邮箱、WhatsApp、IM 等联系方式 |
tags |
标签 | 用户自定义标签 |
responsibleUsers |
跟进人 | 负责跟进该达人的 BD 列表 |
gmvMap |
GMV 分布 | 按渠道(video/live/showcase)的 GMV 分布 |
huayoungtk-cli creator get --id 363364238753849
huayoungtk-cli creator get --handle ashfarienaz
huayoungtk-cli creator get --cid 7493991083946247855
creator note — 修改达人备注
huayoungtk-cli creator note <--id|--handle|--cid> <value> --remark <text>
| 参数 | 必填 | 说明 |
|---|---|---|
--id / --handle / --cid |
三选一 | 达人标识 |
--remark |
是 | 备注文本,传空字符串清除备注 |
--dry-run |
否 | 预览 API 调用,不实际执行 |
huayoungtk-cli creator note --handle ashfarienaz --remark "转化率不错"
huayoungtk-cli creator note --handle ashfarienaz --remark "" # 清除备注
huayoungtk-cli creator note --handle ashfarienaz --remark "test" --dry-run # 预览
creator tag — 给达人打标签或取消标签
huayoungtk-cli creator tag <--id|--handle|--cid> <value> --tag <name> [--tag <name> ...]
标签不存在时会自动创建。
| 参数 | 必填 | 说明 |
|---|---|---|
--id / --handle / --cid |
三选一 | 达人标识 |
--tag |
是 | 标签名称(可重复指定多个) |
--remove |
否 | 取消标签(默认为打标签) |
--dry-run |
否 | 预览 API 调用,不实际执行 |
huayoungtk-cli creator tag --handle ashfarienaz --tag vip
huayoungtk-cli creator tag --handle ashfarienaz --tag vip --tag active # 多标签
huayoungtk-cli creator tag --handle ashfarienaz --tag vip --remove # 取消标签
creator status — 修改达人与店铺的合作状态
huayoungtk-cli creator status <--id|--handle|--cid> <value> --shop-id <id> --status <status>
修改达人与指定店铺的合作状态,全局状态会自动重算(取所有店铺中最高状态)。
| 参数 | 必填 | 说明 |
|---|---|---|
--id / --handle / --cid |
三选一 | 达人标识 |
--shop-id |
是 | 店铺 ID(通过 shop list 查看) |
--status |
是 | 目标状态:NotContacted(0)/Sent(1)/Collaborating(2)/HasOrder(9) |
--dry-run |
否 | 预览 API 调用,不实际执行 |
huayoungtk-cli creator status --handle ashfarienaz --shop-id 123456 --status Sent
huayoungtk-cli creator status --id 363364238753849 --shop-id 123456 --status 9
creator shops — 查看达人合作的店铺列表
huayoungtk-cli creator shops <--id|--handle|--cid> <value>
查看指定达人关联的所有店铺及其对应合作状态。达人的合作状态是店铺级别的,每个店铺有独立的合作状态。
| 参数 | 必填 | 说明 |
|---|---|---|
--id / --handle / --cid |
三选一 | 达人标识 |
输出字段
| 字段 | 中文 | 说明 |
|---|---|---|
shopId |
店铺ID | 店铺唯一标识 |
shopName |
店铺名称 | 合作店铺显示名称 |
shopCode |
店铺编码 | 店铺唯一业务编码 |
cooperationStatus |
合作状态 | 达人与该店铺的合作状态(未接触/已触达/合作中/已出单) |
huayoungtk-cli creator shops --handle ashfarienaz
huayoungtk-cli creator shops --id 363364238753849 --jq '.shops[] | select(.cooperationStatus == "已出单")'
creator capability — 评估达人带货能力
查看指定达人的公开市场带货能力数据,用于评估达人是否适合接收样品或建联。数据来源于 TikTok 公开市场统计(过去 30 天)。
huayoungtk-cli creator capability <--id|--handle|--cid> <value>
返回字段说明
| 字段 | 类型 | 中文 | 说明 |
|---|---|---|---|
| 整体指标 | |||
gmv |
number | GMV | 过去30天达人公开市场带货 GMV |
itemsSold |
number | 销量 | 过去30天达人公开市场带货商品销量 |
gpm |
number | GPM | 过去30天每千次观看(视频/直播)的 GMV |
gmvPerCustomer |
number | 客单价 | 过去30天每位顾客平均贡献的收入金额 |
estimatedPostRate |
number | 预计发文率 | 达人收到样品后预计发布短视频或直播的比例(%) |
averageCommissionRate |
number | 平均佣金率 | 达人公开市场平均佣金比例(%) |
products |
number | 商品数 | 达人公开市场带货商品数量 |
brandCollaborations |
number | 品牌合作数 | 达人公开市场合作品牌数量 |
productPriceMin |
number | 商品最低价 | 达人公开市场带货商品价格最低值 |
productPriceMax |
number | 商品最高价 | 达人公开市场带货商品价格最高值 |
| 视频指标 | |||
videoGpm |
number | 视频GPM | 达人短视频公开市场 GPM |
videos |
number | 视频数 | 达人公开市场带货短视频数量 |
averageVideoViews |
number | 平均视频观看数 | 达人带货短视频平均观看数 |
averageVideoEngagement |
number | 平均视频互动率 | 达人带货短视频平均互动率(%) |
averageVideoLikes |
number | 平均视频点赞数 | 达人带货短视频平均点赞数 |
averageVideoComments |
number | 平均视频评论数 | 达人带货短视频平均评论数 |
averageVideoShares |
number | 平均视频分享数 | 达人带货短视频平均分享数 |
| 直播指标 | |||
liveGpm |
number | 直播GPM | 达人直播公开市场 GPM |
liveVideos |
number | 直播数 | 达人公开市场带货直播数量 |
averageLiveViews |
number | 平均直播观看数 | 达人带货直播平均观看数 |
averageLiveEngagement |
number | 平均直播互动率 | 达人带货直播平均互动率(%) |
averageLiveLikes |
number | 平均直播点赞数 | 达人带货直播平均点赞数 |
averageLiveComments |
number | 平均直播评论数 | 达人带货直播平均评论数 |
averageLiveShares |
number | 平均直播分享数 | 达人带货直播平均分享数 |
| 渠道分布 | |||
gmvByContentChannel |
object | GMV按渠道 | 各渠道 GMV 占比。键:video_gmv(视频)、live_gmv(直播)、showcase_gmv(橱窗),其余键为商品类目ID |
使用建议
- 索样决策:结合
estimatedPostRate(发文率)和gpm(千播收入)评估达人收到样品后的产出潜力 - 视频达人:关注
videoGpm、averageVideoViews、averageVideoEngagement - 直播达人:关注
liveGpm、averageLiveViews、averageLiveEngagement - 价格匹配:对比
productPriceMin/Max与自家商品价格区间,判断达人受众是否匹配
huayoungtk-cli creator capability --handle sahabatpadienterprise
huayoungtk-cli creator capability --id 364060149284921 --jq '.capability | {gmv, estimatedPostRate, videoGpm}'
huayoungtk-cli creator capability --handle sahabatpadienterprise --jq '.capability.gmvByContentChannel'
creator videos — 查看达人带货视频
查看指定达人的带货视频列表,返回视频播放量、订单数、GMV、关联商品、跟进人等信息。
huayoungtk-cli creator videos <--id|--handle|--cid> <value> [flags]
| Flag | 说明 |
|---|---|
--tab-type |
Tab 分类(latest3day/promotable/autoSync/invisible/all) |
--tag |
标签名(可多次指定) |
--authorization-status |
授权状态(authorized/unauthorized) |
--from / --to |
发布时间范围 |
--sort |
排序(默认 id:desc) |
--page / --page-size |
分页(默认 20 条/页) |
输出字段同 video list 的单个视频项(id、mediaId、title、views、orders、soldAmount、shopNames、shopCodes、tags、owners 等)。
huayoungtk-cli creator videos --handle ashfarienaz
huayoungtk-cli creator videos --id 363364238753849 --page-size 10
huayoungtk-cli creator videos --handle ashfarienaz --authorization-status authorized
creator lives — 查看达人带货直播
查看指定达人的带货直播列表,返回每场直播的观看数、订单数、GMV、售出商品、跟进人等信息。
huayoungtk-cli creator lives <--id|--handle|--cid> <value> [flags]
| Flag | 说明 |
|---|---|
--from / --to |
开始时间范围 |
--last-days |
最近 N 天的直播 |
--sort |
排序(默认 startTime:desc) |
--page / --page-size |
分页(默认 20 条/页) |
输出字段同 live list 的单条直播(id、mediaId、startTime、endTime、views、orders、soldAmount、shopNames、shopCodes、owners 等)。
huayoungtk-cli creator lives --handle suphap2539
huayoungtk-cli creator lives --id 343719599407108 --last-days 30
huayoungtk-cli creator lives --handle suphap2539 --sort startTime:desc --page-size 5
店铺是花漾TK平台中的基本管理单元,代表一个 TikTok Shop。
核心字段
| 字段 | 类型 | 中文 | 说明 |
|---|---|---|---|
shopId |
int64 | 店铺ID | 店铺唯一标识 |
shopName |
string | 店铺名称 | 店铺显示名称 |
shopCode |
string | 店铺编码 | TikTok 官方店铺业务编码 |
type |
string | 店铺类型 | Local(本土店)或 Global(跨境店) |
site |
string | 国家站点 | 店铺所属国家站点 |
status |
string | 登录状态 | Online / Offline / Unknown |
browserType |
string | 浏览器类型 | 见下表 |
health |
string | 健康状态 | NotRestricted=正常 |
score |
number | 店铺得分 | 正值越高越好,0=未评分 |
dataStartDate |
string | 历史数据开始日期 | 首笔订单同步时间 |
lastUpdatedTime |
string | 最近更新 | 最近数据同步时间 |
note |
string | 备注 | 店铺描述信息 |
浏览器类型(browserType)
| 值 | 中文 | 说明 |
|---|---|---|
huayang |
花漾浏览器 | 默认值,支持 IP 绑定和浏览器指纹 |
extension |
浏览器插件 | 不支持打开浏览器会话和 RPA 自动化操作 |
both |
花漾+插件 | 兼具两者能力 |
origin_browser |
本地浏览器 | 不支持 IP 绑定和浏览器指纹 |
常见国家站点
Malaysia、Thailand、Vietnam、Philippines、Indonesia、United_States、United_Kingdom、Japan
shop list — 列出店铺
huayoungtk-cli shop list [flags]
默认行为:不加任何参数时,一次性返回所有店铺(内部使用 page-size=999)。
| Flag | 缩写 | 默认值 | 说明 |
|---|---|---|---|
--query |
-q |
搜索店铺名称或描述 | |
--type |
按店铺类型筛选(Local=本土店,Global=跨境店) | ||
--page |
1 | 页码 | |
--page-size |
999 | 每页数量(默认 999 = 返回全部) | |
--sort |
排序字段(createTime、name、type、lastSyncTime、healthStatus、healthScore) | ||
--jq |
jq 表达式过滤输出 | ||
--output |
-o |
json | 输出格式(json、ndjson) |
huayoungtk-cli shop list
huayoungtk-cli shop list --query "店铺名"
huayoungtk-cli shop list --type Local
huayoungtk-cli shop list --jq '.shops[] | select(.status == "Online") | {shopName, score, site}'
shop get — 获取店铺详情
huayoungtk-cli shop get <--shop-id|--shop-name> <value>
两个参数互斥,必须提供一个。
huayoungtk-cli shop get --shop-id <shop-id>
huayoungtk-cli shop get --shop-name "马来可用店铺"
shop sync — 同步店铺信息(异步 RPA)
店铺信息同步是异步 RPA 任务,CLI 只创建任务并返回 jobId。
huayoungtk-cli shop sync --shop-id <shopId> --device-id <deviceId>
huayoungtk-cli shop sync --shop-id <shopId> --device-id <deviceId> --sync product,order
通过 --sync 控制同步哪些数据(逗号分隔),不传则同步全部:
| 值 | 含义 |
|---|---|
product |
商品信息 |
order |
订单信息 |
sample-apply |
样品申请 |
creator |
达人信息 |
target-plan |
目标计划 |
同步操作完整流程
第 1 步 — 确认目标店铺
huayoungtk-cli shop list
第 2 步 — 查找可用设备
huayoungtk-cli device list --shop-id <shopId> --online
根据店铺的 browserType 自动返回对应类型的在线设备。如果返回空列表,告知用户"该店铺当前没有在线的可用设备"。
第 3 步 — 发起同步
huayoungtk-cli shop sync --shop-id <shopId> --device-id <deviceId>
第 4 步 — 告知用户任务已创建
返回:{"jobId": 363685658755072, "message": "店铺信息同步任务已创建"}
常见错误
| 错误信息 | 原因 | 处理 |
|---|---|---|
| "该店铺已经有一个未结束的店铺信息更新任务" | 已有待执行的同步任务 | 等待现有任务完成 |
| "任务池数量已经达到最大允许数量" | 团队任务池已满 | 等待其他任务完成 |
| "店铺不存在或已删除" | shopId 无效 | 重新确认 shopId |
带货视频(Video)
带货视频是达人在 TikTok 上发布的含有商品链接的视频。每个视频可以关联多个商品和多个店铺。
videoBasicInfo 字段
| 字段 | 中文 | 类型 | 说明 |
|---|---|---|---|
id |
视频ID | int64 | 系统内部唯一 ID |
mediaId |
媒体ID | string | TikTok 官方媒体唯一 ID |
title |
标题 | string | 视频标题 |
creatorId |
达人ID | int64 | 视频所属达人 ID |
creatorNickname |
达人昵称 | string | 视频所属达人昵称 |
creatorHandle |
达人Handle | string | 达人 TikTok handle |
authorizationType |
授权类型 | string | 视频授权类型(见下表) |
products |
带货商品 | array | 视频关联商品列表(含 productNo/productName/authorizationStatus) |
authCode |
投流码 | string | 视频授权投流码 |
shopNames |
合作店铺 | string | 关联店铺名称(逗号分隔) |
shopCodes |
店铺编码 | string | 关联店铺编码(逗号分隔) |
views |
播放量 | int | 视频播放数量 |
orders |
带货订单数 | int | 视频带来的订单数量 |
conversionRate |
千播转化率 | float | 千次播放对应的订单转化率 |
publishTime |
发布时间 | string | 视频发布时间 |
likes |
点赞量 | int | 视频点赞数量 |
comments |
评论量 | int | 视频评论数量 |
favorites |
收藏量 | int | 视频收藏数量 |
shares |
转发量 | int | 视频转发数量 |
soldItems |
商品售出数量 | int | 带货商品售出件数 |
soldAmount |
商品售出金额 | float | 带货商品销售金额 |
commission |
佣金 | float | 产生的达人佣金金额 |
tags |
标签 | string[] | 用户自定义视频标签 |
note |
备注 | string | 用户自定义备注信息 |
owners |
跟进人 | string[] | 负责该视频的 BD 人员昵称 |
updateTime |
更新时间 | string | 数据最近更新时间 |
visibleStatus |
可见状态 | string | 可见/不可见 |
授权类型(authorizationType)
| 值 | 中文 | 说明 |
|---|---|---|
| 9 | 联盟批量授权 | 通过联盟批量授权 |
| 2 | 投流码授权 | 通过投流码授权 |
| 8 | 店铺官方账号 | 店铺官方账号发布的视频 |
| 999 | 营销账号 | 营销账号发布的视频 |
| 5 | 商务中心 | 通过商务中心授权 |
| -1 | 未知 | 未知授权类型 |
商品授权状态(products.authorizationStatus)
| 值 | 中文 | 说明 |
|---|---|---|
| 1 | 已授权 | 商品已获得授权 |
| 0 | 未授权 | 商品未获得授权 |
video list — 列出带货视频
huayoungtk-cli video list [flags]
默认返回 20 条记录。使用 --page-size 调整,--page 翻页。
店铺名称和跟进人昵称会自动从 API 获取并填充,无需额外操作。
| 参数 | 必填 | 说明 |
|---|---|---|
-q, --query |
否 | 关键词搜索(视频标题/达人 ID/达人 handle) |
--media-id |
否 | 视频 mediaId 精确匹配 |
--handle |
否 | 达人 handle |
--creator-id |
否 | 达人数据库 ID |
--shop-id |
否 | 店铺 ID(可多次指定) |
--ad-code |
否 | 投流码 |
--tab-type |
否 | Tab 分类(latest3day/promotable/autoSync/invisible/all) |
--tag |
否 | 标签名(可多次指定,接受标签文本而非 ID) |
--authorization-status |
否 | 授权状态过滤(authorized/unauthorized) |
--from |
否 | 发布时间起始(如 2026-01-01) |
--to |
否 | 发布时间结束(如 2026-01-31) |
--sort |
否 | 排序字段[:方向](如 id、postTime:desc,默认 id:desc) |
--page |
否 | 页码,默认 1 |
--page-size |
否 | 每页数量,默认 20 |
Tab 类型说明
| 值 | 中文 | 说明 |
|---|---|---|
latest3day |
最近3天 | 最近 3 天内发布的视频 |
promotable |
值得投流 | 适合投流的视频 |
autoSync |
收藏的 | 用户收藏/监控的视频 |
invisible |
不可见的 | 被隐藏的视频 |
all |
所有 | 全部视频 |
示例
huayoungtk-cli video list
huayoungtk-cli video list --tab-type latest3day --page-size 5
huayoungtk-cli video list --query "test" --page-size 3
huayoungtk-cli video list --authorization-status authorized --page-size 3
huayoungtk-cli video list --tag "高转化" --page-size 3
huayoungtk-cli video list --shop-id 123456 --from 2026-01-01 --to 2026-01-31
huayoungtk-cli video list --sort postTime:desc --page-size 10
huayoungtk-cli video list --page-size 3 --jq '.videos[] | {title, views, orders, soldAmount}'
video get — 查看视频详情
huayoungtk-cli video get --id <id>
huayoungtk-cli video get --media-id <mediaId>
Flags:
| Flag | 必填 | 说明 |
|---|---|---|
--id |
二选一 | 视频数据库 ID |
--media-id |
二选一 | 视频 mediaId(TikTok 官方 ID) |
输出字段: 与 video list 的 videoBasicInfo 结构相同,返回单个对象(非数组)。
示例:
huayoungtk-cli video get --id 123456
huayoungtk-cli video get --media-id 7493991083946247855
huayoungtk-cli video get --id 123456 --jq .title
video note — 修改视频备注
修改指定视频的备注信息。通过 --id 或 --media-id 定位视频。
huayoungtk-cli video note <--id|--media-id> <value> --remark <text> [--dry-run]
| Flag | 说明 |
|---|---|
--id |
视频数据库 ID |
--media-id |
视频 mediaId(TikTok 官方 ID) |
--remark |
备注文本(必填,传空字符串清除备注) |
--dry-run |
预演模式,不实际执行 |
huayoungtk-cli video note --id 350995894763551 --remark "转化率不错"
huayoungtk-cli video note --media-id 7598119178112945416 --remark "需要跟进"
huayoungtk-cli video note --media-id 7598119178112945416 --remark ""
video tag — 给视频打标签或取消标签
给指定视频添加或移除标签。通过 --id 或 --media-id 定位视频。
huayoungtk-cli video tag <--id|--media-id> <value> --tag <name> [--tag <name2>] [--remove] [--dry-run]
| Flag | 说明 |
|---|---|
--id |
视频数据库 ID |
--media-id |
视频 mediaId(TikTok 官方 ID) |
--tag |
标签名称(可多次指定) |
--remove |
取消标签(默认为打标签) |
--dry-run |
预演模式,不实际执行 |
标签不存在时会自动创建。
huayoungtk-cli video tag --media-id 7598119178112945416 --tag "爆款视频"
huayoungtk-cli video tag --id 350995894763551 --tag "爆款视频" --tag "高转化"
huayoungtk-cli video tag --media-id 7598119178112945416 --tag "爆款视频" --remove
huayoungtk-cli video tag --id 350995894763551 --tag "爆款视频" --dry-run
带货直播(Live)
带货直播是达人在 TikTok Shop 进行的实时销售活动。每场直播可以关联多个商品和多个店铺。
liveBasicInfo 字段
| 字段 | 中文 | 类型 | 说明 |
|---|---|---|---|
mediaId |
媒体ID | string | TikTok 官方直播媒体唯一 ID |
title |
直播标题 | string | 直播名称 |
creatorId |
达人ID | int64 | 直播所属达人 ID |
creatorNickname |
达人昵称 | string | 直播所属达人昵称 |
creatorHandle |
达人Handle | string | 达人 TikTok handle |
startTime |
开始时间 | string | 直播开始时间 |
endTime |
结束时间 | string | 直播结束时间 |
shopNames |
合作店铺 | string | 关联店铺名称(逗号分隔) |
shopCodes |
店铺编码 | string | 关联店铺编码(逗号分隔) |
products |
带货商品 | array | 直播关联商品列表(含 productNo/productName) |
orders |
带货订单数 | int | 直播产生的订单数 |
soldAmount |
商品售出金额 | float | 直播带货销售金额 |
soldItems |
商品售出数量 | int | 直播带货售出件数 |
commission |
佣金 | float | 直播产生的达人佣金 |
views |
观看数 | int | 直播观看次数 |
likes |
点赞数 | int | 直播点赞数 |
comments |
评论数 | int | 直播评论数 |
note |
备注 | string | 用户自定义备注 |
owners |
跟进人 | string[] | 负责 BD 人员昵称列表 |
productItem
| 字段 | 类型 | 说明 |
|---|---|---|
productNo |
string | 商品编号 |
productName |
string | 商品名称 |
live list — 列出带货直播
huayoungtk-cli live list [flags]
默认返回 20 条记录。使用 --page-size 调整,--page 翻页。
店铺名称和跟进人昵称会自动从 API 获取并填充,无需额外操作。
| 参数 | 必填 | 说明 |
|---|---|---|
-q, --query |
否 | 模糊搜索(匹配 mediaId 和达人 handle 前缀) |
--media-id |
否 | 直播 mediaId(精确匹配) |
--handle |
否 | 达人 handle(精确匹配) |
--creator-id |
否 | 达人数据库 ID |
--shop-id |
否 | 店铺 ID(可多次指定) |
--from |
否 | 开始时间起始(如 2026-01-01) |
--to |
否 | 开始时间结束(如 2026-01-31) |
--last-days |
否 | 最近 N 天的直播 |
--sold-items-from |
否 | 售出件数 ≥ |
--sold-items-to |
否 | 售出件数 ≤ |
--gmv-from |
否 | GMV ≥ |
--gmv-to |
否 | GMV ≤ |
--commission-from |
否 | 佣金 ≥ |
--commission-to |
否 | 佣金 ≤ |
--product-no |
否 | 按商品编号筛选 |
--cooperation-id |
否 | 按合作单 ID 筛选 |
--sort |
否 | 排序字段[:方向](如 startTime、gmv:desc,默认 startTime:desc) |
--page |
否 | 页码,默认 1 |
--page-size |
否 | 每页数量,默认 20 |
示例
huayoungtk-cli live list
huayoungtk-cli live list --last-days 7 --page-size 5
huayoungtk-cli live list --handle creator_handle --page-size 3
huayoungtk-cli live list --shop-id 123 --gmv-from 100
huayoungtk-cli live list --product-no "SKU001"
huayoungtk-cli live list --sort gmv:desc --page-size 10
huayoungtk-cli live list --page-size 3 --jq '.lives[] | {mediaId, views, orders, soldAmount}'
live get — 查看直播详情
huayoungtk-cli live get <--id|--media-id> <value>
两种查找方式(任选其一):
| 参数 | 说明 | 可靠性 |
|---|---|---|
--id |
数据库 ID | 最可靠 |
--media-id |
直播 mediaId | 可靠 |
输出字段: 与 live list 的 liveBasicInfo 结构相同,返回单个对象(非数组)。
huayoungtk-cli live get --id 123456
huayoungtk-cli live get --media-id 7630462341809998613
huayoungtk-cli live get --id 123456 --jq .views
live note — 修改直播备注
修改指定直播的备注信息。通过 --id 或 --media-id 定位直播。
huayoungtk-cli live note <--id|--media-id> <value> --remark <text> [--dry-run]
| Flag | 说明 |
|---|---|
--id |
直播数据库 ID |
--media-id |
直播 mediaId(TikTok 官方 ID) |
--remark |
备注文本(必填,传空字符串清除备注) |
--dry-run |
预演模式,不实际执行 |
huayoungtk-cli live note --id 362773137588229 --remark "转化率不错"
huayoungtk-cli live note --media-id 7630462341809998613 --remark "需要跟进"
huayoungtk-cli live note --media-id 7630462341809998613 --remark ""
买家(Buyer)
买家是在 TikTok Shop 下单购买商品的用户。每个买家可以关联多个店铺和多种联系方式。
buyerBasicInfo 字段
| 字段 | 中文 | 类型 | 说明 |
|---|---|---|---|
id |
买家ID | int64 | 数据库主键 |
buyerId |
买家Handle | string | 买家唯一业务标识(TikTok 用户名) |
creatorId |
平台ID | string | TikTok 平台用户 ID |
alias |
昵称 | string | 买家昵称 |
status |
触达状态 | string | 未接触/已触达 |
country |
国家 | string | 买家所属国家代码 |
contacts |
联系方式 | array | 联系方式列表(含 type + value) |
friendships |
好友状态 | array | 各渠道好友关系(含 type + status + error) |
orderCount |
订单数 | int | 买家历史订单数量 |
totalSpent |
消费总额 | float | 买家历史订单总金额 |
unit |
货币单位 | string | 金额的货币单位 |
firstPurchaseTime |
首次购买时间 | string | 买家第一次购买时间 |
lastPurchaseTime |
最近购买时间 | string | 买家最近一次购买时间 |
purchasedShops |
购买过的店铺 | string[] | 买家历史购买过的店铺名称列表 |
note |
备注 | string | 用户自定义备注 |
tags |
标签 | string[] | 用户自定义标签 |
owner |
负责人 | string | 负责该买家的 BD 人员昵称 |
contactUrl |
联系链接 | string | 买家消息链接 |
updateTime |
更新时间 | string | 数据最近更新时间 |
createTime |
创建时间 | string | 买家记录创建时间 |
contacts 字段
联系方式数组,每项包含:
| 字段 | 类型 | 说明 |
|---|---|---|
type |
string | 联系方式类型(Phone/Email/Whatsapp/Line/Facebook/Zalo/Viber/iMessage/Instagram) |
value |
string | 联系方式内容 |
friendships 字段
各渠道好友状态数组,用于触达决策:
| 字段 | 类型 | 说明 |
|---|---|---|
type |
string | 渠道类型(whatsapp/line 等) |
status |
string | 好友状态(见下表) |
error |
string | 错误信息(如有) |
买家状态(status)
| 值 | 中文 | 说明 |
|---|---|---|
| 未接触 | NotContacted | 尚未触达的买家 |
| 已触达 | Sent | 已发送过消息的买家 |
好友状态(friendships.status)
| 值 | 中文 | 说明 |
|---|---|---|
| 好友 | Ready | 已成功添加好友 |
| 未注册 | NotFound | 对方未注册该平台 |
| 添加失败 | Error | 添加好友失败 |
| 未知 | Unknown | 状态未知 |
联系方式类型(contacts.type)
| 值 | 说明 |
|---|---|
| Phone | 电话号码 |
| 电子邮件 | |
| WhatsApp 账号 | |
| Line | Line 账号 |
| Facebook Messenger | |
| Zalo | Zalo 账号 |
| Viber | Viber 账号 |
| iMessage | iMessage 账号 |
| Instagram 账号 |
buyer list — 列出买家
huayoungtk-cli buyer list [flags]
默认返回 20 条记录。使用 --page-size 调整,--page 翻页。
店铺名称和负责人昵称会自动从 API 获取并填充,无需额外操作。
| 参数 | 必填 | 说明 |
|---|---|---|
-q, --query |
否 | 搜索(买家 ID/昵称/备注) |
--handle |
否 | 买家 handle |
--shop-id |
否 | 店铺 ID |
--tag |
否 | 标签名(可多次指定) |
--region |
否 | 国家/地区代码(可多次指定) |
--contact |
否 | 按联系方式搜索(手机/邮箱/IM) |
--has-contact |
否 | 仅显示有联系方式的买家 |
--no-contact |
否 | 仅显示无联系方式的买家 |
--order-count-from |
否 | 最少订单数 |
--order-count-to |
否 | 最多订单数 |
--amount-from |
否 | 最少消费金额 |
--amount-to |
否 | 最多消费金额 |
--last-buy-from |
否 | 最近购买时间起始(如 2026-01-01) |
--last-buy-to |
否 | 最近购买时间结束 |
--first-buy-from |
否 | 首次购买时间起始 |
--first-buy-to |
否 | 首次购买时间结束 |
--product-no |
否 | 商品编号 |
--sort |
否 | 排序字段[:方向](如 id、orderAmount:desc,默认 id:desc) |
--page |
否 | 页码,默认 1 |
--page-size |
否 | 每页数量,默认 20 |
示例
huayoungtk-cli buyer list
huayoungtk-cli buyer list --shop-id <shop-id> --page-size 5
huayoungtk-cli buyer list --has-contact --page-size 3
huayoungtk-cli buyer list --tag "VIP" --region TH --page-size 3
huayoungtk-cli buyer list --amount-from 100 --sort orderAmount:desc --page-size 10
huayoungtk-cli buyer list --page-size 3 --jq '.buyers[] | {buyerId, orderCount, totalSpent}'
buyer get — 查看买家详情
huayoungtk-cli buyer get --id <id>
huayoungtk-cli buyer get --handle <handle>
Flags:
| Flag | 必填 | 说明 |
|---|---|---|
--id |
二选一 | 买家数据库 ID |
--handle |
二选一 | 买家 handle(TikTok 用户名) |
输出字段: 与 buyer list 的 buyerBasicInfo 结构相同,返回单个对象(非数组)。
示例:
huayoungtk-cli buyer get --id 123456
huayoungtk-cli buyer get --handle some_buyer_handle
huayoungtk-cli buyer get --id 123456 --jq .contacts
buyer note — 修改买家备注
修改指定买家的备注信息。通过 --id 或 --handle 定位买家。
huayoungtk-cli buyer note <--id|--handle> <value> --remark <text> [--dry-run]
| Flag | 说明 |
|---|---|
--id |
买家数据库 ID |
--handle |
买家 handle(TikTok 用户名) |
--remark |
备注文本(必填,传空字符串清除备注) |
--dry-run |
预演模式,不实际执行 |
huayoungtk-cli buyer note --id 123456 --remark "VIP 买家"
huayoungtk-cli buyer note --handle some_buyer --remark "下周跟进"
huayoungtk-cli buyer note --id 123456 --remark ""
buyer tag — 给买家打标签或取消标签
给指定买家添加或移除标签。通过 --id 或 --handle 定位买家。
huayoungtk-cli buyer tag <--id|--handle> <value> --tag <name> [--tag <name2>] [--remove] [--dry-run]
| Flag | 说明 |
|---|---|
--id |
买家数据库 ID |
--handle |
买家 handle(TikTok 用户名) |
--tag |
标签名称(可多次指定) |
--remove |
取消标签(默认为打标签) |
--dry-run |
预演模式,不实际执行 |
标签不存在时会自动创建。
huayoungtk-cli buyer tag --id 123456 --tag "VIP"
huayoungtk-cli buyer tag --handle some_buyer --tag "VIP" --tag "复购"
huayoungtk-cli buyer tag --id 123456 --tag "VIP" --remove
订单(Order)
订单是 TikTok Shop 买家购买商品产生的交易记录。每笔订单可关联一个店铺、一个买家和多个商品明细。
订单状态
| 状态 | 说明 |
|---|---|
to_ship |
待发货 |
shipped |
已发货 |
pending |
待处理 |
completed |
已完成 |
cancellation |
已取消 |
fail_delivery |
发货失败 |
推广类型(trafficSource)
| 类型 | 值 | 说明 |
|---|---|---|
| 橱窗 | Showcase (1) |
商品橱窗展示 |
| 视频 | Video (2) |
达人带货视频 |
| 直播 | Livestream (3) |
达人直播 |
| 联盟商品页 | AffiliateProductPage (5) |
联盟商品页推广 |
| 外部流量 | ExternalTrafficProgram (6) |
外部流量计划 |
order list — 查询订单列表
huayoungtk-cli order get --order-no # 查看订单详情
huayoungtk-cli order list [flags]
不指定 --shop-id 时查询所有可访问店铺的订单。默认返回 50 条记录,使用 --page-size 调整,--page 翻页。
| 参数 | 必填 | 说明 |
|---|---|---|
--shop-id |
否 | 店铺 ID(不指定则查询所有可访问店铺) |
--status |
否 | 按订单状态筛选(to_ship|shipped|pending|completed|cancellation|fail_delivery) |
--order-no |
否 | 按订单号筛选(支持逗号分隔多个) |
-q, --query |
否 | 模糊搜索(订单号、备注) |
--buyer |
否 | 按买家 ID 前缀筛选 |
--product-id |
否 | 按商品编号筛选 |
--free-sample |
否 | 按样品单筛选(布尔 flag) |
--has-creator |
否 | 是否有带货达人(布尔 flag) |
--promotion-type |
否 | 按推广类型筛选(Showcase|Video|Livestream|AffiliateProductPage|ExternalTrafficProgram) |
--media-id |
否 | 按视频/直播 ID 筛选 |
--creator |
否 | 按达人 handle 前缀筛选 |
--time-from |
否 | 下单时间起始(如 2026-05-01) |
--time-to |
否 | 下单时间截止(如 2026-05-13) |
--last-days |
否 | 最近 N 天 |
--amount-min / --amount-max |
否 | 金额范围 |
--quantity-min / --quantity-max |
否 | 数量范围 |
--commission-min / --commission-max |
否 | 佣金范围 |
--commission-rate-min / --commission-rate-max |
否 | 佣金比例范围(小数,如 0.05 表示 5%) |
--sort |
否 | 排序字段[:方向](如 createTime、amount:desc、cosFee:asc) |
--page |
否 | 页码,默认 1 |
--page-size |
否 | 每页数量,默认 50 |
输出字段
| 字段 | 说明 |
|---|---|
orderId |
订单号 |
buyerId |
买家 ID |
shopName |
店铺名称 |
orderType |
订单类型("Sample" 或 "Real") |
quantity |
商品数量 |
paidAmount |
支付金额 |
creatorId |
达人 ID(从商品明细提取) |
creatorHandle |
达人 handle |
mediaId |
视频/直播 ID |
trafficSource |
推广类型 |
totalCommission |
总佣金 |
status |
订单状态 |
purchaseTime |
下单时间 |
note |
买家备注 |
updatedTime |
最近同步时间 |
items |
商品明细列表(含 productId/productName/quantity/paidAmount/commission 等) |
排序字段
id, shopId, amount, createTime, freeSample, status, quantity, cosFee
示例
huayoungtk-cli order list --shop-id <shop-id>
huayoungtk-cli order list --shop-id <shop-id> --status to_ship
huayoungtk-cli order list --last-days 7 --sort amount:desc
huayoungtk-cli order list --shop-id <shop-id> --has-creator
huayoungtk-cli order list --shop-id <shop-id> --promotion-type Video --sort cosFee:desc
huayoungtk-cli order list --shop-id <shop-id> --time-from 2026-05-01 --time-to 2026-05-13
huayoungtk-cli order list --shop-id <shop-id> --commission-min 1 --has-creator
huayoungtk-cli order list --shop-id <shop-id> --jq '.orders[] | {orderId, paidAmount, status}'
order get — 查看订单详情
huayoungtk-cli order get --order-no <orderNo>
通过订单号查看单笔订单的详细信息。返回比 order list 更多的字段(收货地址、联系方式、时间线等)。
| 参数 | 必填 | 说明 |
|---|---|---|
--order-no |
是 | 订单号 |
输出字段
除 order list 的所有字段外,额外包含:
| 字段 | 说明 |
|---|---|
buyerHandle |
买家 handle |
buyerNickname |
买家昵称 |
buyerRegion |
买家国家/地区 |
currency |
货币单位 |
location |
地区 |
phone |
手机号 |
shipAddress |
收货地址 |
contactUrl |
给买家发消息的 URL |
deliveryTime |
发货时间 |
completeTime |
完成时间 |
settlementTime |
结算时间 |
示例
huayoungtk-cli order get --order-no 583348573376382754
huayoungtk-cli order get --order-no 583348573376382754 --jq '.status'
huayoungtk-cli order get --order-no 583348573376382754 --jq '{orderId, status, buyerHandle, shipAddress}'
索样(Sample Request)
索样(Sample Request)是 TikTok Shop 达人向商家申请免费样品的流程。达人收到样品后通过视频或直播为商家带货。
索样状态
| 状态 | 含义 |
|---|---|
| ToReview | 待审核 |
| ReadyToShip | 已批准,待发货 |
| Shipped | 已发货 |
| InProgress | 已收货,待产出内容 |
| Completed | 已产出内容 |
| Cancelled | 已取消 |
| Reject | 已拒绝 |
| Expired | 已过期 |
| Overdue | 已逾期 |
预定义视图(table-type)
| 视图 | 含义 | 说明 |
|---|---|---|
| ReadyToShip | 待发货 | status=ReadyToShip |
| Shipped | 已发货 | status=Shipped |
| NeedOutput | 待产出 | status=InProgress,已签收无作品 |
| Completed | 已完成 | status=Completed |
| OutputLessThanN | 产出不足 | 有作品但数量不足 |
| Unfulfilled | 未履约 | 签收超30天无作品 |
| Cancelled | 已取消 | 包含 Cancelled+Reject+Expired |
| All | 全部 | 排除待审核 |
sample-request list — 查询索样列表
huayoungtk-cli sample-request list [flags]
默认返回 50 条记录。不指定 --shop-id 时查询所有可访问店铺的索样。
参数
| 参数 | 说明 |
|---|---|
--shop-id |
店铺 ID(不指定则查询所有可访问店铺) |
-q, --query |
模糊搜索(达人ID/索样ID/订单ID/商品ID/SPU) |
--status |
按索样状态筛选 |
--table-type |
预定义视图(更语义化的筛选) |
--handle |
达人 handle(前缀匹配) |
--apply-id |
索样申请 ID |
--order-no |
关联订单号 |
--product-id |
商品编号或 SPU |
--time-from |
申请时间起始(如 2026-05-01) |
--time-to |
申请时间截止(如 2026-05-13) |
--last-days |
最近 N 天 |
--commission-rate-min |
佣金比例下限(小数,如 0.15 表示 15%) |
--commission-rate-max |
佣金比例上限 |
--video-count-min/max |
视频数范围 |
--live-count-min/max |
直播数范围 |
--order-status |
订单状态筛选 |
--order-time-from/to |
订单创建时间范围 |
--order-signed-from/to |
订单签收时间范围 |
--order-rts-from/to |
订单待发货时间范围 |
--archived |
只显示已搁置的索样 |
--assignee |
跟进人用户 ID |
--sort |
排序字段[:方向] |
--page |
页码(默认 1) |
--page-size |
每页数量(默认 50) |
输出字段
| 字段 | 说明 |
|---|---|
id |
索样数据库 ID |
requestId |
索样申请 ID(applyId) |
orderId |
关联订单号 |
creatorHandle |
达人 handle |
creatorNickname |
达人昵称 |
productId |
商品编号 |
productName |
商品名称 |
sku |
SKU 信息 |
commissionRate |
佣金比例 |
status |
索样状态 |
archived |
是否搁置 |
requestTime |
申请时间 |
expireTime |
过期时间 |
assigneeUserId |
跟进人 |
otherShopSampleRequests |
其他店铺索样次数 |
otherShopSameProductRequests |
其他店铺同商品索样次数 |
currentShopSampleRequests |
本店铺索样次数 |
videoCount |
产出视频数 |
liveCount |
产出直播数 |
orderCount |
带货订单数 |
gmv |
带货金额 |
itemsSold |
售出件数 |
orderStatus |
订单状态 |
shopId |
店铺 ID |
updateTime |
更新时间 |
排序字段
applyTime, status, commissionRate, expiredTime, lastSyncTime, orderCreateTime, orderSignedTime, gmv, orderCount, videoCount, liveCount, videoGmv, liveGmv
示例
huayoungtk-cli sample-request list --shop-id <shop-id>
huayoungtk-cli sample-request list --shop-id <shop-id> --status ToReview
huayoungtk-cli sample-request list --shop-id <shop-id> --table-type NeedOutput
huayoungtk-cli sample-request list --shop-id <shop-id> -q "handle_or_id"
huayoungtk-cli sample-request list --last-days 7 --sort gmv:desc
huayoungtk-cli sample-request list --shop-id <shop-id> --product-id "PRODUCT123"
huayoungtk-cli sample-request list --shop-id <shop-id> --assignee 12345
huayoungtk-cli sample-request list --shop-id <shop-id> --jq '.sampleRequests[] | {requestId, status, gmv}'
sample-request get — 获取索样详情
huayoungtk-cli sample-request get <--id|--apply-id> <value>
获取指定索样请求的详细信息,包含关联的视频和直播。
| 参数 | 必填 | 说明 |
|---|---|---|
--id |
二选一 | 索样数据库 ID |
--apply-id |
二选一 | 索样申请 ID(TikTok 官方 ID) |
huayoungtk-cli sample-request get --id 362773137588229
huayoungtk-cli sample-request get --apply-id "xxx-xxx-xxx"
huayoungtk-cli sample-request get --id 362773137588229 --jq '{status, videoCount, videos: [.videos[].mediaId]}'
sample-request videos — 获取索样关联视频
huayoungtk-cli sample-request videos <--id|--apply-id> <value>
获取指定索样请求关联的视频和直播信息,用于检查达人索样后是否发布了带货视频/直播。
| 参数 | 必填 | 说明 |
|---|---|---|
--id |
二选一 | 索样数据库 ID |
--apply-id |
二选一 | 索样申请 ID(TikTok 官方 ID) |
huayoungtk-cli sample-request videos --id 362773137588229
huayoungtk-cli sample-request videos --apply-id "xxx-xxx-xxx"
huayoungtk-cli sample-request videos --id 362773137588229 --jq '.videos[] | {title, views, soldAmount}'
sample-request lives — 获取索样关联直播
huayoungtk-cli sample-request lives <--id|--apply-id> <value>
获取指定索样请求关联的直播信息。
| 参数 | 必填 | 说明 |
|---|---|---|
--id |
二选一 | 索样数据库 ID |
--apply-id |
二选一 | 索样申请 ID(TikTok 官方 ID) |
huayoungtk-cli sample-request lives --id 362773137588229
huayoungtk-cli sample-request lives --apply-id "xxx-xxx-xxx"
sample-request archive — 搁置或取消搁置索样
huayoungtk-cli sample-request archive <--id|--apply-id> <value> [--unarchive] [--dry-run]
将指定索样请求标记为搁置(归档)或取消搁置。仅对 ToReview(待审核)状态的索样生效,其他状态会被跳过。使用 sample-request list --archived 查看已搁置的索样。
| 参数 | 必填 | 说明 |
|---|---|---|
--id |
二选一 | 索样数据库 ID |
--apply-id |
二选一 | 索样申请 ID(TikTok 官方 ID) |
--unarchive |
否 | 取消搁置(默认操作为搁置) |
--dry-run |
否 | 预览操作,不实际执行 |
huayoungtk-cli sample-request archive --id 362773137588229
huayoungtk-cli sample-request archive --apply-id "xxx-xxx-xxx"
huayoungtk-cli sample-request archive --id 362773137588229 --unarchive
huayoungtk-cli sample-request archive --id 362773137588229 --dry-run
sample-request approve — 同意索样
huayoungtk-cli sample-request approve <--id|--apply-id> <value> --device-id <id> [--dry-run]
同意指定的索样请求,触发 RPA 浏览器自动化在 TikTok Shop 平台执行同意操作。同意后平台将向达人发送样品,此操作不可撤销。
测试时务必使用 --dry-run。
| 参数 | 必填 | 说明 |
|---|---|---|
--id |
二选一 | 索样数据库 ID |
--apply-id |
二选一 | 索样申请 ID(TikTok 官方 ID) |
--device-id |
非dry-run时必填 | 执行任务的设备 ID |
--dry-run |
否 | 预览操作,不实际执行 |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
action |
string | "同意" |
id |
int | 索样数据库 ID |
dryRun |
bool | 是否预览(仅 --dry-run 时出现) |
jobId |
int | RPA 任务 ID(仅实际执行时出现) |
huayoungtk-cli sample-request approve --id 362773137588229 --device-id abc123 --dry-run
huayoungtk-cli sample-request approve --apply-id "xxx-xxx-xxx" --device-id abc123
sample-request reject — 拒绝索样
huayoungtk-cli sample-request reject <--id|--apply-id> <value> --device-id <id> [--dry-run]
拒绝指定的索样请求,此操作不可撤销。测试时务必使用 --dry-run。
参数与输出字段同 approve,action 为 "拒绝"。
huayoungtk-cli sample-request reject --id 362773137588229 --device-id abc123 --dry-run
huayoungtk-cli sample-request reject --apply-id "xxx-xxx-xxx" --device-id abc123
设备是执行店铺任务(如同步店铺信息)的载体。花漾TK 通过 RPA 在设备上执行操作。
设备类型
| 值 | 中文 | 说明 |
|---|---|---|
App |
花漾客户端 | 桌面端花漾应用,可执行非插件店铺的 RPA 任务 |
TeamRpaExecutor |
团队RPA执行器 | 团队共享的 RPA 执行设备 |
Extension |
插件分身 | 仅可执行插件类型店铺(browserType=extension)的任务 |
设备与店铺对应规则
| 店铺 browserType | 可用设备类型 |
|---|---|
extension |
Extension |
huayang / both / origin_browser |
App, TeamRpaExecutor |
device list — 列出可用设备
huayoungtk-cli device list [flags]
| Flag | 默认值 | 说明 |
|---|---|---|
--shop-id |
按店铺ID筛选可用设备(自动匹配设备类型) | |
--online |
false | 只显示在线设备 |
--jq |
jq 表达式过滤输出 | |
--output |
-o |
json |
huayoungtk-cli device list
huayoungtk-cli device list --shop-id <shop-id> --online
huayoungtk-cli device list --jq '.devices[] | {deviceId, deviceType, online}'
团队信息(Team)
team info — 查看团队信息、套餐、配额
huayoungtk-cli team info
返回当前登录团队的基本信息、订阅状态和配额明细。
返回字段
| 字段 | 类型 | 说明 |
|---|---|---|
teamId |
int64 | 团队ID |
teamName |
string | 团队名称 |
teamStatus |
string | 团队状态(Ready=正常) |
subscription.product |
string | 已购套餐名称 |
subscription.version |
string | 套餐版本 |
subscription.valid |
bool | 套餐是否生效 |
subscription.expireTime |
string | 过期时间 |
quotas |
array | 配额列表 |
每项配额包含 name、quota(上限)、used、remaining、summary。配额为"不限制"表示无上限。
使用建议
- "团队还有多少配额" → 查看
quotas中对应项 - "套餐什么时候过期" → 查看
subscription.expireTime - "还能加多少成员/店铺" → 查看对应配额的
remaining
任务查询(Job)
job get — 查看任务详情与状态
huayoungtk-cli job get --job-id <id>
| 参数 | 必填 | 说明 |
|---|---|---|
--job-id |
是 | 任务 ID |
--alive |
否 | 默认 true 查活跃任务表;false 查历史任务表 |
任务状态
| 状态 | 值 | 含义 |
|---|---|---|
| Pending | 0 | 等待调度 |
| Scheduled | 1 | 已分配设备,等待执行 |
| Running | 2 | 正在执行中 |
| Succeed | 8 | 执行成功(终态) |
| Failed | 9 | 执行失败(终态) |
| Cancelled | 10 | 已取消(终态) |
状态值 >= 8 为终态,不再变化。
job cancel — 取消任务
huayoungtk-cli job cancel --job-id <id> --dry-run
huayoungtk-cli job cancel --job-id <id>
取消正在执行或等待中的 RPA 任务。取消后任务状态变为 Cancelled,关联的 RPA 执行也会被终止。
| 参数 | 必填 | 说明 |
|---|---|---|
--job-id |
是 | 任务 ID |
--dry-run |
否 | 预览操作,不实际执行 |
使用场景
- 轮询任务状态:创建任务后,定期调用直到 status >= 8
- 查看失败原因:任务失败时查看
description字段 - 查历史任务:活跃表查不到时尝试
--alive=false - 取消任务:任务卡住或不再需要时,用
job cancel终止
使用建议
- 用户询问"我有多少店铺" →
shop list查看total - 用户询问"哪些店铺在线" →
shop list --jq '.shops[] | select(.status == "Online")' - 用户询问"某国家有哪些店铺" →
shop list --jq '.shops[] | select(.site == "Malaysia")' - 用户要同步店铺 → 按完整流程操作(shop list → device list → shop sync),不要跳过 device list
shop sync是异步操作,只告知用户任务已创建- 用户要取消任务 →
job cancel --job-id <id> - 用户询问"团队配额" →
team info查看quotas - 用户询问"最近有哪些视频" →
video list --tab-type latest3day - 用户询问"哪些视频效果好" →
video list --sort conversionRate:desc - 用户询问"某达人的视频" →
video list --creator-id <id>或video list --handle <handle> - 用户询问"某店铺的视频" →
video list --shop-id <id> - 用户询问"某店铺有多少订单" →
order list --shop-id <id> --jq '.total' - 用户询问"待发货订单" →
order list --shop-id <id> --status to_ship - 用户询问"达人带来的订单" →
order list --shop-id <id> --has-creator - 用户询问"最近7天高金额订单" →
order list --last-days 7 --sort amount:desc - 用户询问"视频带来的订单" →
order list --shop-id <id> --promotion-type Video - 用户询问"最近的直播" →
live list --last-days 7 - 用户询问"哪场直播效果最好" →
live list --sort gmv:desc - 用户询问"某达人的直播" →
live list --creator-id <id>或live list --handle <handle> - 用户询问"某店铺的直播" →
live list --shop-id <id> - 用户询问"有多少索样待审核" →
sample-request list --shop-id <id> --status ToReview --jq '.total' - 用户询问"待发货的索样" →
sample-request list --shop-id <id> --table-type ReadyToShip - 用户询问"已签收但没产出内容的索样" →
sample-request list --shop-id <id> --table-type NeedOutput - 用户询问"索样效果如何" →
sample-request list --shop-id <id> --sort gmv:desc - 用户询问"未履约的索样" →
sample-request list --shop-id <id> --table-type Unfulfilled - 用户询问"某达人的索样记录" →
sample-request list --shop-id <id> -q <creator_handle> - 用户询问"索样后达人有没发视频" →
sample-request videos --id <id> - 用户询问"搁置某个索样" →
sample-request archive --id <id> - 用户询问"取消搁置索样" →
sample-request archive --id <id> --unarchive - 用户询问"同意索样"/"批准索样" →
sample-request approve --id <id> --device-id <deviceId> --dry-run(确认后去掉 --dry-run) - 用户询问"拒绝索样" →
sample-request reject --id <id> --device-id <deviceId> --dry-run(确认后去掉 --dry-run) - 用户询问"查看已搁置的索样" →
sample-request list --archived - 修改达人合作状态后,全局状态会自动重算
--cid通过模糊搜索匹配,建议优先使用--id或--handle