Shopee Open Platform Public module(6 APIs).Depends on linkfox-shopee-store-auth as a prerequisite in the same series; some endpoints are Partner-level or OAuth-level, forwarded via POST /shopee/developerProxy (path must api/v2/public/...)。
How to call
- API endpoint:
POST /shopee/developerProxy(different operations are distinguished by the request body; for full parameters/responses/error codes seereferences/api.md) - Python script:
python scripts/<脚本名>.py '<JSON 参数>' [--inline](available scripts are listed in the script overview above) - Cost constraint: 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 additional consumption will be incurred.
Output strategy (default script behavior):
- Alwayswrite the full response to
<cwd>/linkfox/<YYYY-MM-DD>/<session>/data/<skill-name>-<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 variableSESSION_ID, automatically aggregated according to the user's task;writing to /tmp is prohibited, if the current directory is not writable, report an error) - Response body ≤ 8 KB: after writing to disk, print the full 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
--inlineto force full printing to stdout (also written to disk)
Data reading advice: first look at the summary to judge whether it is sufficient; when specific fields are needed, prefer 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 resolution:
Abnormal situations
- API Key not configured: the environment variable is not configured
LINKFOX_AGENT_API_KEY, andLINKFOXAGENT_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
Public module index:v2.public.get_shops_by_partner
Prerequisites
- Run
python scripts/check_auth_dependency.py;exit code 42 → first installlinkfox-shopee-store-auth。 - Daily authorization / authorized shops / read token → prefer
linkfox-shopee-store-auth(authorize_url.py/authorized_stores.py/store_tokens.py)。
Available scripts (6 APIs)
| Script | API | Method |
|---|---|---|
get_shops_by_partner.py |
get_shops_by_partner | GET |
get_merchants_by_partner.py |
get_merchants_by_partner | GET |
get_access_token.py |
get_access_token | POST |
refresh_access_token.py |
refresh_access_token | POST |
get_token_by_resend_code.py |
get_token_by_resend_code | POST |
get_shopee_ip_ranges.py |
get_shopee_ip_ranges | GET |
public_api.py |
General entry point | — |
Endpoint description (by API)
Input parameters and response details are in references/apis/, the SKILL keeps only the index.
| API | Documentation |
|---|---|
get_access_token |
references/apis/get-access-token.md |
get_merchants_by_partner |
references/apis/get-merchants-by-partner.md |
get_shopee_ip_ranges |
references/apis/get-shopee-ip-ranges.md |
get_shops_by_partner |
references/apis/get-shops-by-partner.md |
get_token_by_resend_code |
references/apis/get-token-by-resend-code.md |
refresh_access_token |
references/apis/refresh-access-token.md |
Module overview / Feedback see references/api.md。
Usage Scenarios
1. Query authorized shops under a Partner
get_shops_by_partner.py or get_merchants_by_partner.py
2. OAuth Token exchange (underlying open API)
get_access_token.py / refresh_access_token.py pass the full POST body
3. IP whitelist configuration
get_shopee_ip_ranges.py get the Shopee Open Platform IP ranges
Not Applicable
- User-side authorization flow →
linkfox-shopee-store-auth - Shop business APIs (orders/products/logistics, etc.) → corresponding business skill
- Push callback configuration →
linkfox-shopee-store-push
Compute 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.