Shopee Open Platform Add-On Deal module(14 APIs).Depends on linkfox-shopee-store-auth to select a store; via POST /shopee/developerProxy pass in shopId(or merchantId), the server parses the token and forwards (path must be api/v2/add_on_deal/...)。
How to call
- API endpoint:
POST /shopee/developerProxy(different operations are distinguished by request body; for complete parameters/responses/error codes seereferences/api.md) - Python script:
python scripts/<脚本名>.py '<JSON 参数>' [--inline](available scripts see the script list above) - Cost constraints: This tool consumes compute; on failure/empty results do not automatically switch keywords, page, or repeatedly probe; if you need to continue searching, first explain to the user that additional consumption will be incurred.
Output strategy (script default behavior):
- Alwayswrite the complete response to
<cwd>/linkfox/<YYYY-MM-DD>/<session>/data/linkfox-shopee-store-add-on-deal-<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 task;writing to /tmp is prohibited, error if the current directory is not writable) - 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, length of the largest list field + first 3 samples) - Add
--inlineto force full printing to stdout (also written to disk)
Data reading advice: first look at the summary to determine whether it is sufficient; when specific fields are needed, prefer to use 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: environment variable not configured
LINKFOX_AGENT_API_KEY, and also not configuredLINKFOXAGENT_API_KEY。 - Response 401 or 402 status code
- Response indicates insufficient compute or balance: 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
Add-On Deal module index:v2.add_on_deal.add_add_on_deal
Prerequisites
- Run
python scripts/check_auth_dependency.py;exit code 42 → first installlinkfox-shopee-store-auth。 - Limited-time discount →
linkfox-shopee-store-discount; bundle deal →linkfox-shopee-store-bundle-deal;Voucher →linkfox-shopee-store-voucher。
Available scripts (14 APIs)
| Script | API | Method |
|---|---|---|
add_add_on_deal.py |
add_add_on_deal | POST |
add_add_on_deal_main_item.py |
add_add_on_deal_main_item | POST |
add_add_on_deal_sub_item.py |
add_add_on_deal_sub_item | POST |
delete_add_on_deal.py |
delete_add_on_deal | POST |
delete_add_on_deal_main_item.py |
delete_add_on_deal_main_item | POST |
delete_add_on_deal_sub_item.py |
delete_add_on_deal_sub_item | POST |
get_add_on_deal_list.py |
get_add_on_deal_list | GET |
get_add_on_deal.py |
get_add_on_deal | GET |
get_add_on_deal_main_item.py |
get_add_on_deal_main_item | GET |
get_add_on_deal_sub_item.py |
get_add_on_deal_sub_item | GET |
update_add_on_deal.py |
update_add_on_deal | POST |
update_add_on_deal_main_item.py |
update_add_on_deal_main_item | POST |
update_add_on_deal_sub_item.py |
update_add_on_deal_sub_item | POST |
end_add_on_deal.py |
end_add_on_deal | POST |
add_on_deal_api.py |
Common entry | — |
Interface description (by API)
Input parameters and response details are in references/apis/, the SKILL keeps only the index.
| API | Documentation |
|---|---|
add_add_on_deal |
references/apis/add-add-on-deal.md |
add_add_on_deal_main_item |
references/apis/add-add-on-deal-main-item.md |
add_add_on_deal_sub_item |
references/apis/add-add-on-deal-sub-item.md |
delete_add_on_deal |
references/apis/delete-add-on-deal.md |
delete_add_on_deal_main_item |
references/apis/delete-add-on-deal-main-item.md |
delete_add_on_deal_sub_item |
references/apis/delete-add-on-deal-sub-item.md |
end_add_on_deal |
references/apis/end-add-on-deal.md |
get_add_on_deal |
references/apis/get-add-on-deal.md |
get_add_on_deal_list |
references/apis/get-add-on-deal-list.md |
get_add_on_deal_main_item |
references/apis/get-add-on-deal-main-item.md |
get_add_on_deal_sub_item |
references/apis/get-add-on-deal-sub-item.md |
update_add_on_deal |
references/apis/update-add-on-deal.md |
update_add_on_deal_main_item |
references/apis/update-add-on-deal-main-item.md |
update_add_on_deal_sub_item |
references/apis/update-add-on-deal-sub-item.md |
Module overview / Feedback see references/api.md。
Usage Scenarios
1. Create Add-On Deal
add_add_on_deal.pypass the completebodyadd_add_on_deal_main_item.py/add_add_on_deal_sub_item.pyadd the main product and add-on productsget_add_on_deal_list.pyconfirm status
Not Applicable
- Store authorization →
linkfox-shopee-store-auth - Limited-time discount Discount →
linkfox-shopee-store-discount - Bundle Deal →
linkfox-shopee-store-bundle-deal - Product listing →
linkfox-shopee-store-product
Compute consumption rules
Does not consume compute.
Feedback: see references/api.md。
For more high-quality, professional cross-border e-commerce skills, visit LinkFox Skills.