Shopee Open Platform Product module(57 APIs).Depends on linkfox-shopee-store-auth selecting a store; via POST /shopee/developerProxy pass in shopId(or merchantId), and the server parses the token and forwards (path must api/v2/product/...)。
How to call
- API endpoint:
POST /shopee/developerProxy(different operations are distinguished by the request body; for complete parameters/responses/error codes seereferences/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, page through, or repeatedly probe; if you need to continue searching, first explain to the user that it will incur additional cost.
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, and an error will be reported 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, the length of the largest list field + first 3 samples) - Add
--inlineto force full output to stdout (also written to disk)
Data reading suggestions: first look at the summary to determine whether it is sufficient; when specific fields are needed, prefer jqorConvertFrom-Json to extract as needed from the saved JSON file, avoiding putting the entire JSON into the context.
Resolving 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
LINKFOX_AGENT_API_KEYis not configured, nor isLINKFOXAGENT_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/plan expired/recharge required/please recharge", or content with a similar meaning.
Official reference
Product module index:v2.product.get_category
Prerequisites (must be read first)
- Run
python scripts/check_auth_dependency.py;exit code 42 → first installlinkfox-shopee-store-authand authorize the store. - Do notimplement authorization/token logic within this skill.
Core Concepts
- Forwarding chain:
developerProxy(shopId/merchantIdselect a store, server injects token) → ZiNiaoshopee-proxy→ Shopee API - Listing process:
get_category→get_attribute_tree→add_item(for complex bodies it is recommended to pass thebodyfield) - Daily operations:
get_item_list/get_item_base_infoquery products;update_price/update_stockchange price and inventory;unlist_itemlist/unlist - SKU:
init_tier_variation/get_model_list/add_model, etc. - Product selection data(not store listing) →
linkfox-youying-shopee-product-search(does not depend on auth)
Available scripts (57 APIs in the Product module)
| Group | Script |
|---|---|
| Categories/Attributes/Brands | get_category.py、get_attribute_tree.py、get_brand_list.py、category_recommend.py、get_recommend_attribute.py、search_attribute_value_list.py |
| Product CRUD | get_item_list.py、get_item_base_info.py、get_item_extra_info.py、add_item.py、update_item.py、delete_item.py、unlist_item.py、search_item.py |
| SKU/Price/Stock | get_model_list.py、init_tier_variation.py、update_tier_variation.py、add_model.py、update_model.py、delete_model.py、update_price.py、update_stock.py |
| Promotion/Reviews | boost_item.py、get_boosted_list.py、get_item_promotion.py、get_comment.py、reply_comment.py |
| Extensions | Kit/SSP/Direct/Mart/Outlet, size chart, violations, vehicle compatibility, content diagnostics, etc. — see references/api.md full list |
| General entry | product_api.py(JSON contains api field) |
Shared:_shopee_product_common.py、_product_endpoints.py、_product_api_runner.py。
API description (by API)
Request parameters and response details are in references/apis/, SKILL only keeps the index.
Module overview / Feedback see references/api.md。
Usage Scenarios
1. Query categories and publish
get_category.pyGet category treeget_attribute_tree.pypasscategory_idto get required attributesadd_item.pypass completebody(including category_id, item_name, price, image, attribute_list, etc.)
2. Query products and update stock
get_item_list.py:offset、page_size、item_statusget_item_base_info.py:item_id_listupdate_stock.py/update_price.py:POSTbody
3. Listing/delisting and promotion
unlist_item.py: batch listing/delistingboost_item.py: pin to top (max 5)
Calling principles
- First look at
developerProxy.httpStatus, then read the*Responsefield - GET: business parameters go at the top level of JSON (runner assembles queryString)
- POST: for complex APIs pass
body; for simple APIs you can pass top-level body fields orbody - Each script docstring contains the official documentation URL(
module=89)
Not Applicable
- Shop authorization →
linkfox-shopee-store-auth - Merchant information →
linkfox-shopee-store-merchant - Orders →
linkfox-shopee-store-orders - Logistics shipping →
linkfox-shopee-store-logistics - Returns and refunds →
linkfox-shopee-store-returns - On-platform ads →
linkfox-shopee-store-ads - Payment settlement →
linkfox-shopee-store-payment - Affiliate marketing AMS →
linkfox-shopee-store-ams - Shop video →
linkfox-shopee-store-video - Shop information →
linkfox-shopee-store-shop - Cross-border global products →
linkfox-shopee-store-global-product - Discount promotions →
linkfox-shopee-store-discount - Bundle Deal →
linkfox-shopee-store-bundle-deal - Add-On Deal →
linkfox-shopee-store-add-on-deal - Shop Voucher →
linkfox-shopee-store-voucher - Shop Flash Sale →
linkfox-shopee-store-shop-flash-sale - Follow Prize →
linkfox-shopee-store-follow-prize - Top Picks →
linkfox-shopee-store-top-picks - Shop Category →
linkfox-shopee-store-shop-category - Account Health →
linkfox-shopee-store-account-health - Cross-site product selection data →
linkfox-youying-shopee-product-search - Image/video upload (MediaSpace
api/v2/media_space/...)→linkfox-shopee-store-media-space - Image/video upload (Media
api/v2/media/...)→linkfox-shopee-store-media
Compute consumption rules
No compute is consumed.
Feedback:
Auto-detect and report feedback via the Feedback API when any of the following apply:
- The functionality or purpose described in this skill does not match actual behavior
- The skill's results do not match the user's intent
- The user expresses dissatisfaction or praise about this skill
- Anything you believe could be improved
Call the feedback API as specified in references/api.md. Do not interrupt the user's flow.
For more high-quality, professional cross-border e-commerce skills, visit LinkFox Skills.