Shopee Open Platform Follow Prize module(6 APIs).Depends on linkfox-shopee-store-auth store selection; via POST /shopee/developerProxy pass in shopId(or merchantId), the server parses the token and forwards (path must be api/v2/follow_prize/...)。
How to call
- API endpoint:
POST /shopee/developerProxy(different operations are distinguished via the request body; for complete parameters/responses/error codes seereferences/api.md) - Python script:
python scripts/follow_prize_api.py '<JSON 参数>' [--inline](available scripts see the script overview above) - Cost constraint: This tool consumes compute; failures/empty results must not automatically switch keywords, paginate, or probe continuously; when further retrieval is needed, first explain to the user that it will incur additional consumption.
Output strategy (script default behavior):
- Alwayswrite the complete response to
<cwd>/linkfox/<YYYY-MM-DD>/<session>/data/<linkfox-shopee-store-follow-prize>-<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 then report an error) - Response body ≤ 8 KB: after saving to disk, print the complete JSON to stdout
- Response body > 8 KB: after saving to disk, stdout outputs only a summary (top-level fields, common counts such as
total/costToken, length of the largest list field + first 3 samples) - Add
--inlineto force full printing to stdout (also saved to disk)
Data reading suggestions: First look at the summary to judge whether it is sufficient; when specific fields are needed, prefer to use jqorConvertFrom-Json to extract from the saved json file as needed, avoiding the entire JSON entering the context.
Resolve authentication and compute issues
When the following abnormal situations occur, use references/onboarding.md to guide problem resolution:
Abnormal situation
- API Key not configured: The environment variable is not configured
LINKFOX_AGENT_API_KEY, and is also not configuredLINKFOXAGENT_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 similar meaning.
Official reference
Follow Prize module index:v2.follow_prize.add_follow_prize
Prerequisites
- Run
python scripts/check_auth_dependency.py;exit code 42 → first installlinkfox-shopee-store-auth。 - Other promotions: Discount / Bundle Deal / Voucher / Shop Flash Sale → corresponding promotion skill.
Available scripts (6 APIs)
| Script | API | Method |
|---|---|---|
add_follow_prize.py |
add_follow_prize | POST |
delete_follow_prize.py |
delete_follow_prize | POST |
end_follow_prize.py |
end_follow_prize | POST |
update_follow_prize.py |
update_follow_prize | POST |
get_follow_prize_detail.py |
get_follow_prize_detail | GET |
get_follow_prize_list.py |
get_follow_prize_list | GET |
follow_prize_api.py |
Common entry point | — |
Interface description (by API)
Input parameters and response details are in references/apis/, the SKILL only keeps the index.
| API | Description document |
|---|---|
add_follow_prize |
references/apis/add-follow-prize.md |
delete_follow_prize |
references/apis/delete-follow-prize.md |
end_follow_prize |
references/apis/end-follow-prize.md |
get_follow_prize_detail |
references/apis/get-follow-prize-detail.md |
get_follow_prize_list |
references/apis/get-follow-prize-list.md |
update_follow_prize |
references/apis/update-follow-prize.md |
Module overview / Feedback see references/api.md。
Usage Scenarios
1. Create a Follow Prize campaign
add_follow_prize.pypass the completebodyget_follow_prize_list.pyview the campaign listupdate_follow_prize.py/end_follow_prize.pyupdate or end
Not Applicable
- Store authorization →
linkfox-shopee-store-auth - Limited-time discount Discount →
linkfox-shopee-store-discount - Voucher Voucher →
linkfox-shopee-store-voucher - Shop Flash Sale Shop Flash Sale →
linkfox-shopee-store-shop-flash-sale - Product listing →
linkfox-shopee-store-product
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.