SuperAPI AI Directory

linkfox-shopee-store-account-health

Coding & development

View repository

Updated 10-16 00:00

About this skill

Shopee Account Health

Shopee Open Platform Account Health module(6 APIs, all GET).Depends on linkfox-shopee-store-auth for store selection; via POST /shopee/developerProxy pass in shopId(or merchantId), the server parses the token and forwards (path must be api/v2/account_health/...)。

How to call

  • API endpoints:POST /shopee/developerProxy(different operations are distinguished by the request body; for complete parameters/responses/error codes see references/api.md)
  • Python script:python scripts/<脚本名>.py '<JSON 参数>' [--inline](available scripts are listed in the script overview above)
  • Cost constraints: this tool consumes compute; on failure/empty results you must not automatically switch keywords, paginate, or repeatedly probe; if you need to continue searching, first explain to the user that it will incur additional consumption.

Output strategy (default script behavior):

  • Alwayswrite the complete response to <cwd>/linkfox/<YYYY-MM-DD>/<session>/data/linkfox-shopee-store-account-health-<timestamp>.json(<cwd> is the working directory when the script runs, which in Claude Code is the current project directory;<session> is taken from the environment variable SESSION_ID, automatically aggregated according to the user's task;writing to /tmp is prohibited, if the current directory is not writable then report an error)
  • Response body ≤ 8 KB: after writing to disk, print the complete JSON to stdout
  • Response body > 8 KB: after writing to disk, stdout outputs only a summary (top-level fields, common counts such as total/costToken, the length of the largest list field + the first 3 samples)
  • Add --inline to force full printing to stdout (also written to disk)

Data reading suggestions: first look at the summary to judge whether it is sufficient; when specific fields are needed, prefer using jqorConvertFrom-Json to extract on demand from the saved json file, avoiding bringing the entire JSON into context.

Resolve authentication and compute issues

When the following abnormal situations occur, use references/onboarding.md to guide resolving the issue:

Abnormal situations

  • API Key not configured: the environment variable is not configured with LINKFOX_AGENT_API_KEY, and LINKFOXAGENT_API_KEY。
  • Response 401 or 402 status code
  • Response indicates insufficient compute or balance: the message contains "insufficient compute balance/insufficient billing/insufficient balance/quota exceeded/insufficient balance/package expired/recharge required/please recharge", or content with a similar meaning.

Official reference

Account Health module index:v2.account_health.get_shop_performance


Prerequisites

  1. Run python scripts/check_auth_dependency.py;exit code 42 → first install linkfox-shopee-store-auth。
  2. Order details → linkfox-shopee-store-orders; product listing → linkfox-shopee-store-product。

Available scripts (6 APIs)

Script API Method
get_shop_performance.py get_shop_performance GET
get_metric_source_detail.py get_metric_source_detail GET
get_penalty_point_history.py get_penalty_point_history GET
get_punishment_history.py get_punishment_history GET
get_listings_with_issues.py get_listings_with_issues GET
get_late_orders.py get_late_orders GET
account_health_api.py Common entry point —

Shared:_shopee_account_health_common.py、_account_health_endpoints.py、_account_health_api_runner.py。

Interface description (by API)

Input parameters and response details are placed in references/apis/, the SKILL keeps only the index.

API Documentation
get_shop_performance references/apis/get-shop-performance.md
get_metric_source_detail references/apis/get-metric-source-detail.md
get_penalty_point_history references/apis/get-penalty-point-history.md
get_punishment_history references/apis/get-punishment-history.md
get_listings_with_issues references/apis/get-listings-with-issues.md
get_late_orders references/apis/get-late-orders.md

Module overview / Feedback see references/api.md。

Usage Scenarios

1. View store health overview

  1. auth skill locate shopId
  2. By get-shop-performance.md call get_shop_performance.py
  3. For failed metrics, by get-metric-source-detail.md pass metric_id drill down
  4. Use get_late_orders.py / get_listings_with_issues.py to locate the problematic order or listing

2. Check overdue orders (get_late_orders)

  1. auth skill locate shopId
  2. By get-late-orders.md pass parameters to call get_late_orders.py
  3. by late_by_days prioritize more urgent orders

3. Check penalty and point deduction records

  1. by get-penalty-point-history.md check point deductions
  2. by get-punishment-history.md check penalties (required punishment_status:1 in progress / 2 ended)

Not Applicable

  • Store authorization → linkfox-shopee-store-auth
  • Order processing → linkfox-shopee-store-orders
  • Product listing → linkfox-shopee-store-product
  • Store basic information → linkfox-shopee-store-shop

Computing power consumption rules

Does not consume computing power.

Feedback: see references/api.md。


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