Shopee Open Platform Returns module(15 APIs).Depends on linkfox-shopee-store-auth for store selection; via POST /shopee/developerProxy pass in shopId(or merchantId), the server parses the token and forwards (path must be api/v2/returns/...)。
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 constraint: 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 consumption.
Output policy (default script 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 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, the length of the largest list field + the first 3 samples) - Add
--inlineto force full output to stdout (also saved to disk)
Data reading recommendations: first look at the summary to judge whether it is sufficient; when specific fields are needed, prefer using 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 situation
- 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 "算力余额不足/计费不足/余额不足/quota exceeded/insufficient balance/套餐到期/需充值/请充值", or content with a similar meaning.
Official reference
Returns module index:v2.returns.get_return_list
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 - Returns vs orders: for order queries see
linkfox-shopee-store-orders; this skill handlesreturns/refunds/disputes - Typical process:
get_return_list→get_return_detail→confirm/offer/dispute - Store-level API: usually pass
shopId
Available scripts (Returns module 15 APIs)
| Script | API | Method |
|---|---|---|
get_return_list.py |
get_return_list | GET |
get_return_detail.py |
get_return_detail | GET |
confirm.py |
confirm | POST |
dispute.py |
dispute | POST |
get_available_solutions.py |
get_available_solutions | GET |
offer.py |
offer | POST |
accept_offer.py |
accept_offer | POST |
convert_image.py |
convert_image | POST |
upload_proof.py |
upload_proof | POST |
query_proof.py |
query_proof | GET |
get_return_dispute_reason.py |
get_return_dispute_reason | GET |
cancel_dispute.py |
cancel_dispute | POST |
get_shipping_carrier.py |
get_shipping_carrier | GET |
upload_shipping_proof.py |
upload_shipping_proof | POST |
get_reverse_tracking_info.py |
get_reverse_tracking_info | GET |
returns_api.py |
Generic entry (JSON contains api field) |
— |
Shared:_shopee_returns_common.py、_returns_endpoints.py、_returns_api_runner.py。
Interface description (by API)
Input parameter and response details are placed in references/apis/, the SKILL only keeps the index.
| API | Documentation |
|---|---|
accept_offer |
references/apis/accept-offer.md |
cancel_dispute |
references/apis/cancel-dispute.md |
confirm |
references/apis/confirm.md |
convert_image |
references/apis/convert-image.md |
dispute |
references/apis/dispute.md |
get_available_solutions |
references/apis/get-available-solutions.md |
get_return_detail |
references/apis/get-return-detail.md |
get_return_dispute_reason |
references/apis/get-return-dispute-reason.md |
get_return_list |
references/apis/get-return-list.md |
get_reverse_tracking_info |
references/apis/get-reverse-tracking-info.md |
get_shipping_carrier |
references/apis/get-shipping-carrier.md |
offer |
references/apis/offer.md |
query_proof |
references/apis/query-proof.md |
upload_proof |
references/apis/upload-proof.md |
upload_shipping_proof |
references/apis/upload-shipping-proof.md |
Module overview / Feedback see references/api.md。
Usage Scenarios
1. Query return list and details
get_return_list.py:page_no、page_sizeget_return_detail.py:return_sn
2. Process returns
get_available_solutions.py:return_snconfirm.pyoroffer.py:POSTbody- If there is a dispute:
dispute.py/cancel_dispute.py
3. Evidence and reverse logistics
upload_proof.py/query_proof.pyget_reverse_tracking_info.py
Invocation principles
- First look at
developerProxy.httpStatus, then read the*Responsefield - GET: business parameters go at the top level of the JSON
- POST: complex interfaces pass
body - Each script docstring contains the official documentation URL(
module=102)
Not Applicable
- Store authorization →
linkfox-shopee-store-auth - Order query/cancel →
linkfox-shopee-store-orders - Forward logistics shipping →
linkfox-shopee-store-logistics - Product listing →
linkfox-shopee-store-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.