Shopee Open Platform Order module(22 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/order/...)。
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, do not automatically switch keywords, paginate, or repeatedly probe; if you need to continue searching, first explain to the user that additional consumption will be incurred.
Output strategy (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's task;writing to /tmp is prohibited, if the current directory is not writable, 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, length of the largest list field + first 3 samples) - Add
--inlineto force full printing 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 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 problem resolution:
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 similar meaning.
Official reference
Order module index:Shopee Open Platform — Order
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(partner_id/signhandled automatically by the proxy) - List → Details:
get_order_listgetorder_sn→get_order_detailpull all fields (≤50 per call) - Package flow:
search_package_list/get_package_detail/get_shipment_listused for pre-shipment package view - Write operations:
split_order、cancel_order、set_noteetc. are POST JSON body - Time window:
get_order_list/get_booking_listoftime_from/time_tomaximum 15 days
Available scripts (Order module 22 APIs)
| Script | API | Method |
|---|---|---|
get_order_list.py |
get_order_list | GET |
get_order_detail.py |
get_order_detail | GET |
get_shipment_list.py |
get_shipment_list | GET |
search_package_list.py |
search_package_list | POST |
get_package_detail.py |
get_package_detail | GET |
split_order.py |
split_order | POST |
unsplit_order.py |
unsplit_order | POST |
cancel_order.py |
cancel_order | POST |
handle_buyer_cancellation.py |
handle_buyer_cancellation | POST |
set_note.py |
set_note | POST |
get_pending_buyer_invoice_order_list.py |
get_pending_buyer_invoice_order_list | GET |
get_buyer_invoice_info.py |
get_buyer_invoice_info | POST |
upload_invoice_doc.py |
upload_invoice_doc | POST |
download_invoice_doc.py |
download_invoice_doc | GET |
handle_prescription_check.py |
handle_prescription_check | POST |
get_warehouse_filter_config.py |
get_warehouse_filter_config | GET |
get_booking_list.py |
get_booking_list | GET |
get_booking_detail.py |
get_booking_detail | GET |
generate_fbs_invoices.py |
generate_fbs_invoices | POST |
get_fbs_invoices_result.py |
get_fbs_invoices_result | POST |
download_fbs_invoices.py |
download_fbs_invoices | POST |
get_estimiate_cancel_value.py |
get_estimiate_cancel_value | POST |
order_api.py |
Generic entry (JSON contains api field) |
— |
Shared:_shopee_orders_common.py、_order_endpoints.py、_order_api_runner.py. See references/apis/。
Interface Description (by API)
Request parameters and response details are placed in references/apis/, the SKILL only keeps the index.
Module overview / Feedback see references/api.md。
Usage Scenarios
1. Query orders pending shipment
- auth skill locates
shopId get_order_list.py:order_status=READY_TO_SHIP,time_range_field=update_time, timestamp within 15 daysget_order_detail.py: pass inorder_sn_list
2. Package-dimension processing
search_package_list.py: passpagination.page_sizeand optionalfilter/sort(or overallbody)get_package_detail.py:package_number_list- Shipping logistics see Logistics module (not this skill)
3. Cancel / Note / Split order
- Cancel:
cancel_order.py(order_sn+cancel_reason) - Buyer cancellation request:
handle_buyer_cancellation.py(ACCEPT/REJECT) - Note:
set_note.py - Split/merge order:
split_order.py/unsplit_order.py
4. Select shop (high frequency)
| User context | Agent action |
|---|---|
| Only 1 authorized | Directly use shopId |
| Multiple + shop name | auth skill authorized_stores.py clarify |
| order_sn already given | Direct detail/write operation script |
Invocation principles
- First look at
developerProxy.httpStatus, then read*Responseto parse fields - GET: business parameters as top-level fields of the script JSON (runner assembles
queryString) - POST: pass
bodyobject, or pass top-level body fields per api.md upload_invoice_docofficial is multipart; if the gateway does not support it, the limitation must be stated in the documentation- Pagination:
get_order_listusecursor/next_cursor;search_package_listusepagination.cursor
FAQ
1005 path whitelist
Confirm path is api/v2/order/...。
Region restrictions
Invoice-type APIs limited to PH/BR;get_buyer_invoice_info limited to VN/TH/PH; FBS invoices limited to BR. See references/api.md。
token expired
Return to linkfox-shopee-store-auth to reauthorize.
Not Applicable
- Shop authorization →
linkfox-shopee-store-auth - Merchant information →
linkfox-shopee-store-merchant - Shop information and settings →
linkfox-shopee-store-shop - Product listing →
linkfox-shopee-store-product - Account Health →
linkfox-shopee-store-account-health - Cross-border global products →
linkfox-shopee-store-global-product - Logistics shipping →
linkfox-shopee-store-logistics - FirstMile →
linkfox-shopee-store-first-mile - Returns and refunds →
linkfox-shopee-store-returns - Payment settlement →
linkfox-shopee-store-payment - Product selection →
linkfox-youying-shopee-product-search
Compute power consumption rules
No compute power 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.