Shopee Open Platform Shop module(9 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 api/v2/shop/...)。
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](for available scripts see the script list above) - Cost constraint: this tool consumes compute; on failure/empty results you must not automatically switch keywords, paginate, or make repeated probes; if you need to continue searching, 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/<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 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
--inlineto 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 to use jqorConvertFrom-Json to extract on demand from the saved json file, avoiding the entire JSON entering the 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
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
Shop module index:v2.shop.get_shop_info
Prerequisites (must 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/merchantIdstore selection, server injects token) → ZiNiaoshopee-proxy→ Shopee API - Information vs profile:
get_shop_inforeturns region/status/authorization expiration etc.;get_profilereturns store name/logo/description - Write operations:
update_profile(store name can only be changed once every 30 days),set_shop_holiday_mode(after enabling, buyers cannot place orders) - Warehouse:
get_warehouse_detailoptionalwarehouse_type(1=pickup warehouse, 2=return warehouse) - Region restrictions:
get_br_shop_onboarding_infoBrazil site only
Available scripts (Shop module 9 APIs)
| Script | API | Method |
|---|---|---|
get_shop_info.py |
get_shop_info | GET |
get_profile.py |
get_profile | GET |
update_profile.py |
update_profile | POST |
get_warehouse_detail.py |
get_warehouse_detail | GET |
get_shop_notification.py |
get_shop_notification | GET |
get_authorised_reseller_brand.py |
get_authorised_reseller_brand | GET |
get_br_shop_onboarding_info.py |
get_br_shop_onboarding_info | GET |
get_shop_holiday_mode.py |
get_shop_holiday_mode | GET |
set_shop_holiday_mode.py |
set_shop_holiday_mode | POST |
shop_api.py |
Generic entry (JSON contains api field) |
— |
Shared:_shopee_shop_common.py、_shop_endpoints.py、_shop_api_runner.py. For input, see references/apis/。
Interface description (by API)
Input parameters and response details are placed in references/apis/, and SKILL keeps only the index.
| API | Documentation |
|---|---|
get_authorised_reseller_brand |
references/apis/get-authorised-reseller-brand.md |
get_br_shop_onboarding_info |
references/apis/get-br-shop-onboarding-info.md |
get_profile |
references/apis/get-profile.md |
get_shop_holiday_mode |
references/apis/get-shop-holiday-mode.md |
get_shop_info |
references/apis/get-shop-info.md |
get_shop_notification |
references/apis/get-shop-notification.md |
get_warehouse_detail |
references/apis/get-warehouse-detail.md |
set_shop_holiday_mode |
references/apis/set-shop-holiday-mode.md |
update_profile |
references/apis/update-profile.md |
For module overview / Feedback, see references/api.md。
Usage Scenarios
1. View basic shop information
- auth skill locates
shopId get_shop_info.py:region、status(NORMAL/BANNED/FROZEN)、expire_time- Optional
get_profile.py: shop name, logo, description
2. Update shop profile
update_profile.py pass shop_name / shop_logo / description at least one item (logo must be a Shopee image URL)
3. Holiday mode
get_shop_holiday_mode.pycheck current statusset_shop_holiday_mode.pypassholiday_mode_on: true/false
4. Warehouse and notifications
- Warehouse:
get_warehouse_detail.py(optionalwarehouse_type=1|2) - Seller notifications:
get_shop_notification.py(page_sizemaximum 50,cursorpagination) - Authorized brands:
get_authorised_reseller_brand.py(requiredpage_no、page_size≤30)
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: pass
bodyor top-level body fields - Each script docstring contains the official documentation URL(
module=92)
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 - Product listing →
linkfox-shopee-store-product - Shop Category →
linkfox-shopee-store-shop-category - Account Health →
linkfox-shopee-store-account-health - Cross-border global products →
linkfox-shopee-store-global-product
Computing power consumption rules
Does not consume computing power.
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.