linkfox-shopee-store-top-picks

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Shopee 精选商品 Top Picks

Shopee Top Picks

Shopee Open Platform Top Picks 模块(4 个 API)。依赖
linkfox-shopee-store-auth
选店;经
POST /shopee/developerProxy
传入
shopId
(或
merchantId
),由服务端解析 token 转发(
path
api/v2/top_picks/...
)。
Shopee Open Platform Top Picks Module (4 APIs). Depends on
linkfox-shopee-store-auth
for store selection; pass
shopId
(or
merchantId
) via
POST /shopee/developerProxy
, and the server parses the token to forward the request (the
path
must be
api/v2/top_picks/...
).

调用方式

Calling Methods

  • API 端点
    POST /shopee/developerProxy
    (不同操作通过请求体区分;完整参数/响应/错误码见
    references/api.md
  • Python 脚本
    python scripts/<脚本名>.py '<JSON 参数>' [--inline]
    (可用脚本见上文脚本一览)
  • 成本约束:本工具会消耗积分;失败/空结果不得自动换关键词、翻页或连续试探;需要继续检索时先向用户说明会产生额外消耗。
输出策略(脚本默认行为)
  • 始终将完整响应写入
    <cwd>/linkfox/<YYYY-MM-DD>/<session>/data/<skill-name>-<timestamp>.json
    <cwd>
    为脚本执行时的工作目录,在 Claude Code 里即当前项目目录;
    <session>
    取自环境变量
    SESSION_ID
    ,按用户任务自动聚合;禁止写入 /tmp,当前目录不可写则报错)
  • 响应体 ≤ 8 KB:落盘后把完整 JSON 打印到 stdout
  • 响应体 > 8 KB:落盘后 stdout 只输出摘要(顶层字段、常见计数如
    total
    /
    costToken
    、最大列表字段的长度 + 前 3 条样本)
  • --inline
    强制全量打印到 stdout(同样落盘)
读数据建议:先看摘要判断是否足够;需要具体字段时优先用
jq
ConvertFrom-Json
从保存的 json 文件按需抽取,避免整份 JSON 进入上下文。
  • API Endpoint:
    POST /shopee/developerProxy
    (Different operations are distinguished by request body; see
    references/api.md
    for complete parameters/responses/error codes)
  • Python Script:
    python scripts/<script-name>.py '<JSON parameters>' [--inline]
    (Available scripts are listed in the script overview above)
  • Cost Constraints: This tool consumes points; do not automatically switch keywords, paginate, or continuously retry for failed/empty results; inform the user that additional costs will be incurred before continuing the retrieval.
Output Strategy (Default Script Behavior):
  • Always write the complete response to
    <cwd>/linkfox/<YYYY-MM-DD>/<session>/data/<skill-name>-<timestamp>.json
    (
    <cwd>
    is the working directory where the script is executed, which is the current project directory in Claude Code;
    <session>
    is retrieved from the environment variable
    SESSION_ID
    and automatically aggregated by user tasks; Writing to /tmp is prohibited, report an error if the current directory is not writable)
  • Response body ≤ 8 KB: Print the complete JSON to stdout after saving to disk
  • Response body > 8 KB: Print only a summary to stdout after saving to disk (top-level fields, common counts such as
    total
    /
    costToken
    , length of the largest list field + first 3 samples)
  • Add
    --inline
    to force full printing to stdout (still saves to disk)
Data Reading Suggestion: Check the summary first to see if it is sufficient; when specific fields are needed, use
jq
or
ConvertFrom-Json
to extract from the saved JSON file on demand, avoiding loading the entire JSON into the context.

解决认证和积分问题

Resolving Authentication and Point Issues

发生以下异常情况时,采用 references/onboarding.md 引导解决问题:
For the following abnormal situations, guide users to resolve them by following references/onboarding.md:

异常情况

Abnormal Situations

  • 未配置API Key:环境变量未配置
    LINKFOX_AGENT_API_KEY
    ,也未配置
    LINKFOXAGENT_API_KEY
  • 响应401或402状态码
  • 响应提示积分或余额不足:消息含"积分余额不足/计费不足/余额不足/quota exceeded/insufficient balance/套餐到期/需充值/请充值",或类似含义的内容。
  • API Key Not Configured: The environment variables
    LINKFOX_AGENT_API_KEY
    and
    LINKFOXAGENT_API_KEY
    are not configured.
  • Response returns 401 or 402 status code
  • Response indicates insufficient points or balance: The message contains "insufficient points balance/insufficient billing/insufficient balance/quota exceeded/insufficient balance/package expired/need to recharge/please recharge" or similar meanings.

官方参考

Official References

Top Picks 模块索引:v2.top_picks.get_top_picks_list

Top Picks Module Index: v2.top_picks.get_top_picks_list

Prerequisites

Prerequisites

  1. 运行
    python scripts/check_auth_dependency.py
    ;exit code 42 → 先安装
    linkfox-shopee-store-auth
  2. 促销类活动(Discount / Voucher / Flash Sale 等)→ 对应促销 skill。
  1. Run
    python scripts/check_auth_dependency.py
    ; if the exit code is 42 → install
    linkfox-shopee-store-auth
    first.
  2. Promotional activities (Discount / Voucher / Flash Sale, etc.) → use the corresponding promotion skill.

可用脚本(4 个 API)

Available Scripts (4 APIs)

脚本APIMethod
get_top_picks_list.py
get_top_picks_listGET
add_top_picks.py
add_top_picksPOST
update_top_picks.py
update_top_picksPOST
delete_top_picks.py
delete_top_picksPOST
top_picks_api.py
通用入口
ScriptAPIMethod
get_top_picks_list.py
get_top_picks_listGET
add_top_picks.py
add_top_picksPOST
update_top_picks.py
update_top_picksPOST
delete_top_picks.py
delete_top_picksPOST
top_picks_api.py
General Entry

接口说明(按 API)

Interface Description (By API)

入参与响应细节放在
references/apis/
,SKILL 只保留索引。
API说明文档
add_top_picks
references/apis/add-top-picks.md
delete_top_picks
references/apis/delete-top-picks.md
get_top_picks_list
references/apis/get-top-picks-list.md
update_top_picks
references/apis/update-top-picks.md
模块总览 / Feedback 见 references/api.md
Details of input parameters and responses are stored in
references/apis/
, only the index is retained in the SKILL.
APIDocumentation
add_top_picks
references/apis/add-top-picks.md
delete_top_picks
references/apis/delete-top-picks.md
get_top_picks_list
references/apis/get-top-picks-list.md
update_top_picks
references/apis/update-top-picks.md
Module overview / Feedback can be found in references/api.md.

Usage Scenarios

Usage Scenarios

1. 管理精选商品集合

1. Manage Top Picks Collections

  1. get_top_picks_list.py
    查看现有集合
  2. add_top_picks.py
    创建新集合
  3. update_top_picks.py
    /
    delete_top_picks.py
    更新或删除
  1. Use
    get_top_picks_list.py
    to view existing collections
  2. Use
    add_top_picks.py
    to create new collections
  3. Use
    update_top_picks.py
    /
    delete_top_picks.py
    to update or delete collections

Not Applicable

Not Applicable

  • 店铺授权 →
    linkfox-shopee-store-auth
  • 商品 listing →
    linkfox-shopee-store-product
  • 店铺分类 Shop Category →
    linkfox-shopee-store-shop-category
  • 促销 Discount / Voucher / Follow Prize 等 → 对应促销 skill
  • Store authorization →
    linkfox-shopee-store-auth
  • Product listing →
    linkfox-shopee-store-product
  • Shop Category →
    linkfox-shopee-store-shop-category
  • Promotions such as Discount / Voucher / Follow Prize → use the corresponding promotion skill

积分消耗规则

Point Consumption Rules

不消耗积分。
Feedback:
references/api.md

For more high-quality, professional cross-border e-commerce skills, visit LinkFox Skills.
No points are consumed.
Feedback: See
references/api.md
.

For more high-quality, professional cross-border e-commerce skills, visit LinkFox Skills.