@tikomni/skills 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.skill-package-allowlist.txt +4 -0
- package/LICENSE +21 -0
- package/README.md +167 -0
- package/README.zh-CN.md +167 -0
- package/bin/tikomni-skills.js +127 -0
- package/env.example +160 -0
- package/lib/installer.js +176 -0
- package/package.json +44 -0
- package/skills/creator-analysis/SKILL.md +71 -0
- package/skills/creator-analysis/agents/openai.yaml +4 -0
- package/skills/creator-analysis/env.example +36 -0
- package/skills/creator-analysis/references/api-capability-index.md +92 -0
- package/skills/creator-analysis/references/api-contracts/asr-api.md +130 -0
- package/skills/creator-analysis/references/api-contracts/bilibili-app-api.md +776 -0
- package/skills/creator-analysis/references/api-contracts/bilibili-web-api.md +2017 -0
- package/skills/creator-analysis/references/api-contracts/demo-api.md +717 -0
- package/skills/creator-analysis/references/api-contracts/douyin-app-v3-api.md +3594 -0
- package/skills/creator-analysis/references/api-contracts/douyin-billboard-api.md +2274 -0
- package/skills/creator-analysis/references/api-contracts/douyin-creator-api.md +1575 -0
- package/skills/creator-analysis/references/api-contracts/douyin-creator-v2-api.md +3254 -0
- package/skills/creator-analysis/references/api-contracts/douyin-search-api.md +4118 -0
- package/skills/creator-analysis/references/api-contracts/douyin-web-api.md +5544 -0
- package/skills/creator-analysis/references/api-contracts/douyin-xingtu-api.md +1916 -0
- package/skills/creator-analysis/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
- package/skills/creator-analysis/references/api-contracts/health-check.md +69 -0
- package/skills/creator-analysis/references/api-contracts/hybrid-parsing.md +78 -0
- package/skills/creator-analysis/references/api-contracts/instagram-v1-api.md +2256 -0
- package/skills/creator-analysis/references/api-contracts/instagram-v2-api.md +2011 -0
- package/skills/creator-analysis/references/api-contracts/instagram-v3-api.md +2630 -0
- package/skills/creator-analysis/references/api-contracts/ios-shortcut.md +44 -0
- package/skills/creator-analysis/references/api-contracts/kuaishou-app-api.md +1518 -0
- package/skills/creator-analysis/references/api-contracts/kuaishou-web-api.md +1242 -0
- package/skills/creator-analysis/references/api-contracts/lemon8-app-api.md +1088 -0
- package/skills/creator-analysis/references/api-contracts/linkedin-web-api.md +1949 -0
- package/skills/creator-analysis/references/api-contracts/media-ingest-api.md +126 -0
- package/skills/creator-analysis/references/api-contracts/pipixia-app-api.md +1142 -0
- package/skills/creator-analysis/references/api-contracts/reddit-app-api.md +2025 -0
- package/skills/creator-analysis/references/api-contracts/sora2-api.md +2266 -0
- package/skills/creator-analysis/references/api-contracts/temp-mail-api.md +208 -0
- package/skills/creator-analysis/references/api-contracts/threads-web-api.md +897 -0
- package/skills/creator-analysis/references/api-contracts/tikhub-downloader-api.md +134 -0
- package/skills/creator-analysis/references/api-contracts/tikhub-user-api.md +494 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-ads-api.md +5947 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-analytics-api.md +968 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-app-v3-api.md +5735 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-creator-api.md +1951 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-interaction-api.md +742 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-shop-web-api.md +1890 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-web-api.md +4448 -0
- package/skills/creator-analysis/references/api-contracts/toutiao-app-api.md +342 -0
- package/skills/creator-analysis/references/api-contracts/toutiao-web-api.md +143 -0
- package/skills/creator-analysis/references/api-contracts/twitter-web-api.md +989 -0
- package/skills/creator-analysis/references/api-contracts/wechat-channels-api.md +809 -0
- package/skills/creator-analysis/references/api-contracts/wechat-media-platform-web-api.md +677 -0
- package/skills/creator-analysis/references/api-contracts/weibo-app-api.md +1547 -0
- package/skills/creator-analysis/references/api-contracts/weibo-web-api.md +798 -0
- package/skills/creator-analysis/references/api-contracts/weibo-web-v2-api.md +2459 -0
- package/skills/creator-analysis/references/api-contracts/xiaohongshu-app-api.md +1291 -0
- package/skills/creator-analysis/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
- package/skills/creator-analysis/references/api-contracts/xiaohongshu-web-api.md +1324 -0
- package/skills/creator-analysis/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
- package/skills/creator-analysis/references/api-contracts/xigua-app-v2-api.md +489 -0
- package/skills/creator-analysis/references/api-contracts/youtube-web-api.md +2636 -0
- package/skills/creator-analysis/references/api-contracts/youtube-web-v2-api.md +2660 -0
- package/skills/creator-analysis/references/api-contracts/zhihu-web-api.md +2315 -0
- package/skills/creator-analysis/references/api-tags/asr-api.md +100 -0
- package/skills/creator-analysis/references/api-tags/bilibili-app-api.md +482 -0
- package/skills/creator-analysis/references/api-tags/bilibili-web-api.md +1267 -0
- package/skills/creator-analysis/references/api-tags/demo-api.md +365 -0
- package/skills/creator-analysis/references/api-tags/douyin-app-v3-api.md +2012 -0
- package/skills/creator-analysis/references/api-tags/douyin-billboard-api.md +1428 -0
- package/skills/creator-analysis/references/api-tags/douyin-creator-api.md +694 -0
- package/skills/creator-analysis/references/api-tags/douyin-creator-v2-api.md +694 -0
- package/skills/creator-analysis/references/api-tags/douyin-search-api.md +1059 -0
- package/skills/creator-analysis/references/api-tags/douyin-web-api.md +3314 -0
- package/skills/creator-analysis/references/api-tags/douyin-xingtu-api.md +935 -0
- package/skills/creator-analysis/references/api-tags/douyin-xingtu-v2-api.md +925 -0
- package/skills/creator-analysis/references/api-tags/health-check.md +40 -0
- package/skills/creator-analysis/references/api-tags/hybrid-parsing.md +57 -0
- package/skills/creator-analysis/references/api-tags/instagram-v1-api.md +1224 -0
- package/skills/creator-analysis/references/api-tags/instagram-v2-api.md +1147 -0
- package/skills/creator-analysis/references/api-tags/instagram-v3-api.md +1123 -0
- package/skills/creator-analysis/references/api-tags/ios-shortcut.md +45 -0
- package/skills/creator-analysis/references/api-tags/kuaishou-app-api.md +846 -0
- package/skills/creator-analysis/references/api-tags/kuaishou-web-api.md +551 -0
- package/skills/creator-analysis/references/api-tags/lemon8-app-api.md +687 -0
- package/skills/creator-analysis/references/api-tags/linkedin-web-api.md +1105 -0
- package/skills/creator-analysis/references/api-tags/media-ingest-api.md +112 -0
- package/skills/creator-analysis/references/api-tags/pipixia-app-api.md +721 -0
- package/skills/creator-analysis/references/api-tags/reddit-app-api.md +1057 -0
- package/skills/creator-analysis/references/api-tags/sora2-api.md +737 -0
- package/skills/creator-analysis/references/api-tags/temp-mail-api.md +136 -0
- package/skills/creator-analysis/references/api-tags/threads-web-api.md +472 -0
- package/skills/creator-analysis/references/api-tags/tikhub-downloader-api.md +65 -0
- package/skills/creator-analysis/references/api-tags/tikhub-user-api.md +253 -0
- package/skills/creator-analysis/references/api-tags/tiktok-ads-api.md +1393 -0
- package/skills/creator-analysis/references/api-tags/tiktok-analytics-api.md +179 -0
- package/skills/creator-analysis/references/api-tags/tiktok-app-v3-api.md +3264 -0
- package/skills/creator-analysis/references/api-tags/tiktok-creator-api.md +709 -0
- package/skills/creator-analysis/references/api-tags/tiktok-interaction-api.md +366 -0
- package/skills/creator-analysis/references/api-tags/tiktok-shop-web-api.md +663 -0
- package/skills/creator-analysis/references/api-tags/tiktok-web-api.md +2516 -0
- package/skills/creator-analysis/references/api-tags/toutiao-app-api.md +220 -0
- package/skills/creator-analysis/references/api-tags/toutiao-web-api.md +96 -0
- package/skills/creator-analysis/references/api-tags/twitter-web-api.md +562 -0
- package/skills/creator-analysis/references/api-tags/wechat-channels-api.md +405 -0
- package/skills/creator-analysis/references/api-tags/wechat-media-platform-web-api.md +431 -0
- package/skills/creator-analysis/references/api-tags/weibo-app-api.md +851 -0
- package/skills/creator-analysis/references/api-tags/weibo-web-api.md +470 -0
- package/skills/creator-analysis/references/api-tags/weibo-web-v2-api.md +1405 -0
- package/skills/creator-analysis/references/api-tags/xiaohongshu-app-api.md +534 -0
- package/skills/creator-analysis/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
- package/skills/creator-analysis/references/api-tags/xiaohongshu-web-api.md +757 -0
- package/skills/creator-analysis/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
- package/skills/creator-analysis/references/api-tags/xigua-app-v2-api.md +308 -0
- package/skills/creator-analysis/references/api-tags/youtube-web-api.md +934 -0
- package/skills/creator-analysis/references/api-tags/youtube-web-v2-api.md +717 -0
- package/skills/creator-analysis/references/api-tags/zhihu-web-api.md +1384 -0
- package/skills/creator-analysis/references/asr-orchestration.md +33 -0
- package/skills/creator-analysis/references/config-templates/defaults.yaml +60 -0
- package/skills/creator-analysis/references/contracts/creator-card-fields.md +23 -0
- package/skills/creator-analysis/references/contracts/work-card-fields.md +32 -0
- package/skills/creator-analysis/references/platform-guides/douyin.md +49 -0
- package/skills/creator-analysis/references/platform-guides/generic.md +46 -0
- package/skills/creator-analysis/references/platform-guides/xiaohongshu.md +54 -0
- package/skills/creator-analysis/references/prompt-contracts/asr-clean.md +28 -0
- package/skills/creator-analysis/references/prompt-contracts/author-analysis-v2.md +46 -0
- package/skills/creator-analysis/references/prompt-contracts/author-analysis.md +49 -0
- package/skills/creator-analysis/references/prompt-contracts/cta.md +24 -0
- package/skills/creator-analysis/references/prompt-contracts/hook.md +25 -0
- package/skills/creator-analysis/references/prompt-contracts/insight.md +47 -0
- package/skills/creator-analysis/references/prompt-contracts/sampled-work-batch-explanations.md +30 -0
- package/skills/creator-analysis/references/prompt-contracts/structure.md +25 -0
- package/skills/creator-analysis/references/prompt-contracts/style.md +27 -0
- package/skills/creator-analysis/references/prompt-contracts/summary.md +29 -0
- package/skills/creator-analysis/references/prompt-contracts/topic.md +29 -0
- package/skills/creator-analysis/references/schemas/author-analysis-input-v1.schema.json +325 -0
- package/skills/creator-analysis/references/schemas/author-analysis-v2.schema.json +158 -0
- package/skills/creator-analysis/references/schemas/sampled-work-batch-explanations.schema.json +41 -0
- package/skills/creator-analysis/references/service-guides/asr-u2-u3-fallback.md +75 -0
- package/skills/creator-analysis/references/workflow.md +18 -0
- package/skills/creator-analysis/scripts/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/adapters/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/adapters/platform_adapters.py +299 -0
- package/skills/creator-analysis/scripts/author_home/analyzers/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/analyzers/author_analysis_v2_support.py +1122 -0
- package/skills/creator-analysis/scripts/author_home/analyzers/prompt_first_analyzers.py +260 -0
- package/skills/creator-analysis/scripts/author_home/analyzers/sampled_work_batch_explainer.py +260 -0
- package/skills/creator-analysis/scripts/author_home/asr/__init__.py +5 -0
- package/skills/creator-analysis/scripts/author_home/asr/home_asr.py +961 -0
- package/skills/creator-analysis/scripts/author_home/builders/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/builders/home_builders.py +149 -0
- package/skills/creator-analysis/scripts/author_home/collectors/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/collectors/homepage_collectors.py +636 -0
- package/skills/creator-analysis/scripts/author_home/orchestrator/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/orchestrator/run_author_analysis.py +491 -0
- package/skills/creator-analysis/scripts/author_home/orchestrator/work_analysis_artifacts.py +553 -0
- package/skills/creator-analysis/scripts/author_home/schema.py +417 -0
- package/skills/creator-analysis/scripts/core/__init__.py +0 -0
- package/skills/creator-analysis/scripts/core/analysis_pipeline.py +133 -0
- package/skills/creator-analysis/scripts/core/bootstrap_env.py +35 -0
- package/skills/creator-analysis/scripts/core/config_loader.py +418 -0
- package/skills/creator-analysis/scripts/core/extract_pipeline.py +173 -0
- package/skills/creator-analysis/scripts/core/progress_report.py +111 -0
- package/skills/creator-analysis/scripts/core/storage_router.py +253 -0
- package/skills/creator-analysis/scripts/core/tikomni_common.py +588 -0
- package/skills/creator-analysis/scripts/pipeline/__init__.py +0 -0
- package/skills/creator-analysis/scripts/pipeline/asr/__init__.py +0 -0
- package/skills/creator-analysis/scripts/pipeline/asr/asr_pipeline.py +1189 -0
- package/skills/creator-analysis/scripts/pipeline/asr/poll_u2_task.py +95 -0
- package/skills/creator-analysis/scripts/platform/__init__.py +0 -0
- package/skills/creator-analysis/scripts/platform/douyin/__init__.py +0 -0
- package/skills/creator-analysis/scripts/platform/douyin/douyin_video_type_matrix.py +224 -0
- package/skills/creator-analysis/scripts/platform/douyin/run_douyin_single_video.py +1208 -0
- package/skills/creator-analysis/scripts/platform/douyin/select_low_quality_video_url.py +200 -0
- package/skills/creator-analysis/scripts/platform/xiaohongshu/__init__.py +0 -0
- package/skills/creator-analysis/scripts/platform/xiaohongshu/run_xiaohongshu_extract.py +2128 -0
- package/skills/creator-analysis/scripts/writers/__init__.py +0 -0
- package/skills/creator-analysis/scripts/writers/write_author_homepage_samples.py +106 -0
- package/skills/creator-analysis/scripts/writers/write_benchmark_card.py +1402 -0
- package/skills/meta-capability/SKILL.md +69 -0
- package/skills/meta-capability/agents/openai.yaml +4 -0
- package/skills/meta-capability/env.example +42 -0
- package/skills/meta-capability/references/api-capability-index.md +92 -0
- package/skills/meta-capability/references/api-contracts/asr-api.md +130 -0
- package/skills/meta-capability/references/api-contracts/bilibili-app-api.md +776 -0
- package/skills/meta-capability/references/api-contracts/bilibili-web-api.md +2017 -0
- package/skills/meta-capability/references/api-contracts/demo-api.md +717 -0
- package/skills/meta-capability/references/api-contracts/douyin-app-v3-api.md +3594 -0
- package/skills/meta-capability/references/api-contracts/douyin-billboard-api.md +2274 -0
- package/skills/meta-capability/references/api-contracts/douyin-creator-api.md +1575 -0
- package/skills/meta-capability/references/api-contracts/douyin-creator-v2-api.md +3254 -0
- package/skills/meta-capability/references/api-contracts/douyin-search-api.md +4118 -0
- package/skills/meta-capability/references/api-contracts/douyin-web-api.md +5544 -0
- package/skills/meta-capability/references/api-contracts/douyin-xingtu-api.md +1916 -0
- package/skills/meta-capability/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
- package/skills/meta-capability/references/api-contracts/health-check.md +69 -0
- package/skills/meta-capability/references/api-contracts/hybrid-parsing.md +78 -0
- package/skills/meta-capability/references/api-contracts/instagram-v1-api.md +2256 -0
- package/skills/meta-capability/references/api-contracts/instagram-v2-api.md +2011 -0
- package/skills/meta-capability/references/api-contracts/instagram-v3-api.md +2630 -0
- package/skills/meta-capability/references/api-contracts/ios-shortcut.md +44 -0
- package/skills/meta-capability/references/api-contracts/kuaishou-app-api.md +1518 -0
- package/skills/meta-capability/references/api-contracts/kuaishou-web-api.md +1242 -0
- package/skills/meta-capability/references/api-contracts/lemon8-app-api.md +1088 -0
- package/skills/meta-capability/references/api-contracts/linkedin-web-api.md +1949 -0
- package/skills/meta-capability/references/api-contracts/media-ingest-api.md +126 -0
- package/skills/meta-capability/references/api-contracts/pipixia-app-api.md +1142 -0
- package/skills/meta-capability/references/api-contracts/reddit-app-api.md +2025 -0
- package/skills/meta-capability/references/api-contracts/sora2-api.md +2266 -0
- package/skills/meta-capability/references/api-contracts/temp-mail-api.md +208 -0
- package/skills/meta-capability/references/api-contracts/threads-web-api.md +897 -0
- package/skills/meta-capability/references/api-contracts/tikhub-downloader-api.md +134 -0
- package/skills/meta-capability/references/api-contracts/tikhub-user-api.md +494 -0
- package/skills/meta-capability/references/api-contracts/tiktok-ads-api.md +5947 -0
- package/skills/meta-capability/references/api-contracts/tiktok-analytics-api.md +968 -0
- package/skills/meta-capability/references/api-contracts/tiktok-app-v3-api.md +5735 -0
- package/skills/meta-capability/references/api-contracts/tiktok-creator-api.md +1951 -0
- package/skills/meta-capability/references/api-contracts/tiktok-interaction-api.md +742 -0
- package/skills/meta-capability/references/api-contracts/tiktok-shop-web-api.md +1890 -0
- package/skills/meta-capability/references/api-contracts/tiktok-web-api.md +4448 -0
- package/skills/meta-capability/references/api-contracts/toutiao-app-api.md +342 -0
- package/skills/meta-capability/references/api-contracts/toutiao-web-api.md +143 -0
- package/skills/meta-capability/references/api-contracts/twitter-web-api.md +989 -0
- package/skills/meta-capability/references/api-contracts/wechat-channels-api.md +809 -0
- package/skills/meta-capability/references/api-contracts/wechat-media-platform-web-api.md +677 -0
- package/skills/meta-capability/references/api-contracts/weibo-app-api.md +1547 -0
- package/skills/meta-capability/references/api-contracts/weibo-web-api.md +798 -0
- package/skills/meta-capability/references/api-contracts/weibo-web-v2-api.md +2459 -0
- package/skills/meta-capability/references/api-contracts/xiaohongshu-app-api.md +1291 -0
- package/skills/meta-capability/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
- package/skills/meta-capability/references/api-contracts/xiaohongshu-web-api.md +1324 -0
- package/skills/meta-capability/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
- package/skills/meta-capability/references/api-contracts/xigua-app-v2-api.md +489 -0
- package/skills/meta-capability/references/api-contracts/youtube-web-api.md +2636 -0
- package/skills/meta-capability/references/api-contracts/youtube-web-v2-api.md +2660 -0
- package/skills/meta-capability/references/api-contracts/zhihu-web-api.md +2315 -0
- package/skills/meta-capability/references/api-tags/asr-api.md +100 -0
- package/skills/meta-capability/references/api-tags/bilibili-app-api.md +482 -0
- package/skills/meta-capability/references/api-tags/bilibili-web-api.md +1267 -0
- package/skills/meta-capability/references/api-tags/demo-api.md +365 -0
- package/skills/meta-capability/references/api-tags/douyin-app-v3-api.md +2012 -0
- package/skills/meta-capability/references/api-tags/douyin-billboard-api.md +1428 -0
- package/skills/meta-capability/references/api-tags/douyin-creator-api.md +694 -0
- package/skills/meta-capability/references/api-tags/douyin-creator-v2-api.md +694 -0
- package/skills/meta-capability/references/api-tags/douyin-search-api.md +1059 -0
- package/skills/meta-capability/references/api-tags/douyin-web-api.md +3314 -0
- package/skills/meta-capability/references/api-tags/douyin-xingtu-api.md +935 -0
- package/skills/meta-capability/references/api-tags/douyin-xingtu-v2-api.md +925 -0
- package/skills/meta-capability/references/api-tags/health-check.md +40 -0
- package/skills/meta-capability/references/api-tags/hybrid-parsing.md +57 -0
- package/skills/meta-capability/references/api-tags/instagram-v1-api.md +1224 -0
- package/skills/meta-capability/references/api-tags/instagram-v2-api.md +1147 -0
- package/skills/meta-capability/references/api-tags/instagram-v3-api.md +1123 -0
- package/skills/meta-capability/references/api-tags/ios-shortcut.md +45 -0
- package/skills/meta-capability/references/api-tags/kuaishou-app-api.md +846 -0
- package/skills/meta-capability/references/api-tags/kuaishou-web-api.md +551 -0
- package/skills/meta-capability/references/api-tags/lemon8-app-api.md +687 -0
- package/skills/meta-capability/references/api-tags/linkedin-web-api.md +1105 -0
- package/skills/meta-capability/references/api-tags/media-ingest-api.md +112 -0
- package/skills/meta-capability/references/api-tags/pipixia-app-api.md +721 -0
- package/skills/meta-capability/references/api-tags/reddit-app-api.md +1057 -0
- package/skills/meta-capability/references/api-tags/sora2-api.md +737 -0
- package/skills/meta-capability/references/api-tags/temp-mail-api.md +136 -0
- package/skills/meta-capability/references/api-tags/threads-web-api.md +472 -0
- package/skills/meta-capability/references/api-tags/tikhub-downloader-api.md +65 -0
- package/skills/meta-capability/references/api-tags/tikhub-user-api.md +253 -0
- package/skills/meta-capability/references/api-tags/tiktok-ads-api.md +1393 -0
- package/skills/meta-capability/references/api-tags/tiktok-analytics-api.md +179 -0
- package/skills/meta-capability/references/api-tags/tiktok-app-v3-api.md +3264 -0
- package/skills/meta-capability/references/api-tags/tiktok-creator-api.md +709 -0
- package/skills/meta-capability/references/api-tags/tiktok-interaction-api.md +366 -0
- package/skills/meta-capability/references/api-tags/tiktok-shop-web-api.md +663 -0
- package/skills/meta-capability/references/api-tags/tiktok-web-api.md +2516 -0
- package/skills/meta-capability/references/api-tags/toutiao-app-api.md +220 -0
- package/skills/meta-capability/references/api-tags/toutiao-web-api.md +96 -0
- package/skills/meta-capability/references/api-tags/twitter-web-api.md +562 -0
- package/skills/meta-capability/references/api-tags/wechat-channels-api.md +405 -0
- package/skills/meta-capability/references/api-tags/wechat-media-platform-web-api.md +431 -0
- package/skills/meta-capability/references/api-tags/weibo-app-api.md +851 -0
- package/skills/meta-capability/references/api-tags/weibo-web-api.md +470 -0
- package/skills/meta-capability/references/api-tags/weibo-web-v2-api.md +1405 -0
- package/skills/meta-capability/references/api-tags/xiaohongshu-app-api.md +534 -0
- package/skills/meta-capability/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
- package/skills/meta-capability/references/api-tags/xiaohongshu-web-api.md +757 -0
- package/skills/meta-capability/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
- package/skills/meta-capability/references/api-tags/xigua-app-v2-api.md +308 -0
- package/skills/meta-capability/references/api-tags/youtube-web-api.md +934 -0
- package/skills/meta-capability/references/api-tags/youtube-web-v2-api.md +717 -0
- package/skills/meta-capability/references/api-tags/zhihu-web-api.md +1384 -0
- package/skills/meta-capability/references/config-templates/defaults.yaml +18 -0
- package/skills/meta-capability/references/dispatch.md +27 -0
- package/skills/meta-capability/references/execution-guidelines.md +25 -0
- package/skills/meta-capability/references/implemented-route-map.md +177 -0
- package/skills/meta-capability/references/service-guides/asr-u2-u3-fallback.md +75 -0
- package/skills/meta-capability/scripts/__init__.py +1 -0
- package/skills/meta-capability/scripts/call_route.py +141 -0
- package/skills/meta-capability/scripts/core/__init__.py +1 -0
- package/skills/meta-capability/scripts/core/bootstrap_env.py +32 -0
- package/skills/meta-capability/scripts/core/config_loader.py +204 -0
- package/skills/meta-capability/scripts/core/tikomni_common.py +443 -0
- package/skills/meta-capability/scripts/test_auth.py +98 -0
- package/skills/single-work-analysis/SKILL.md +62 -0
- package/skills/single-work-analysis/agents/openai.yaml +4 -0
- package/skills/single-work-analysis/env.example +36 -0
- package/skills/single-work-analysis/references/api-capability-index.md +92 -0
- package/skills/single-work-analysis/references/api-contracts/asr-api.md +130 -0
- package/skills/single-work-analysis/references/api-contracts/bilibili-app-api.md +776 -0
- package/skills/single-work-analysis/references/api-contracts/bilibili-web-api.md +2017 -0
- package/skills/single-work-analysis/references/api-contracts/demo-api.md +717 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-app-v3-api.md +3594 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-billboard-api.md +2274 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-creator-api.md +1575 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-creator-v2-api.md +3254 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-search-api.md +4118 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-web-api.md +5544 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-xingtu-api.md +1916 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
- package/skills/single-work-analysis/references/api-contracts/health-check.md +69 -0
- package/skills/single-work-analysis/references/api-contracts/hybrid-parsing.md +78 -0
- package/skills/single-work-analysis/references/api-contracts/instagram-v1-api.md +2256 -0
- package/skills/single-work-analysis/references/api-contracts/instagram-v2-api.md +2011 -0
- package/skills/single-work-analysis/references/api-contracts/instagram-v3-api.md +2630 -0
- package/skills/single-work-analysis/references/api-contracts/ios-shortcut.md +44 -0
- package/skills/single-work-analysis/references/api-contracts/kuaishou-app-api.md +1518 -0
- package/skills/single-work-analysis/references/api-contracts/kuaishou-web-api.md +1242 -0
- package/skills/single-work-analysis/references/api-contracts/lemon8-app-api.md +1088 -0
- package/skills/single-work-analysis/references/api-contracts/linkedin-web-api.md +1949 -0
- package/skills/single-work-analysis/references/api-contracts/media-ingest-api.md +126 -0
- package/skills/single-work-analysis/references/api-contracts/pipixia-app-api.md +1142 -0
- package/skills/single-work-analysis/references/api-contracts/reddit-app-api.md +2025 -0
- package/skills/single-work-analysis/references/api-contracts/sora2-api.md +2266 -0
- package/skills/single-work-analysis/references/api-contracts/temp-mail-api.md +208 -0
- package/skills/single-work-analysis/references/api-contracts/threads-web-api.md +897 -0
- package/skills/single-work-analysis/references/api-contracts/tikhub-downloader-api.md +134 -0
- package/skills/single-work-analysis/references/api-contracts/tikhub-user-api.md +494 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-ads-api.md +5947 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-analytics-api.md +968 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-app-v3-api.md +5735 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-creator-api.md +1951 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-interaction-api.md +742 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-shop-web-api.md +1890 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-web-api.md +4448 -0
- package/skills/single-work-analysis/references/api-contracts/toutiao-app-api.md +342 -0
- package/skills/single-work-analysis/references/api-contracts/toutiao-web-api.md +143 -0
- package/skills/single-work-analysis/references/api-contracts/twitter-web-api.md +989 -0
- package/skills/single-work-analysis/references/api-contracts/wechat-channels-api.md +809 -0
- package/skills/single-work-analysis/references/api-contracts/wechat-media-platform-web-api.md +677 -0
- package/skills/single-work-analysis/references/api-contracts/weibo-app-api.md +1547 -0
- package/skills/single-work-analysis/references/api-contracts/weibo-web-api.md +798 -0
- package/skills/single-work-analysis/references/api-contracts/weibo-web-v2-api.md +2459 -0
- package/skills/single-work-analysis/references/api-contracts/xiaohongshu-app-api.md +1291 -0
- package/skills/single-work-analysis/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
- package/skills/single-work-analysis/references/api-contracts/xiaohongshu-web-api.md +1324 -0
- package/skills/single-work-analysis/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
- package/skills/single-work-analysis/references/api-contracts/xigua-app-v2-api.md +489 -0
- package/skills/single-work-analysis/references/api-contracts/youtube-web-api.md +2636 -0
- package/skills/single-work-analysis/references/api-contracts/youtube-web-v2-api.md +2660 -0
- package/skills/single-work-analysis/references/api-contracts/zhihu-web-api.md +2315 -0
- package/skills/single-work-analysis/references/api-tags/asr-api.md +100 -0
- package/skills/single-work-analysis/references/api-tags/bilibili-app-api.md +482 -0
- package/skills/single-work-analysis/references/api-tags/bilibili-web-api.md +1267 -0
- package/skills/single-work-analysis/references/api-tags/demo-api.md +365 -0
- package/skills/single-work-analysis/references/api-tags/douyin-app-v3-api.md +2012 -0
- package/skills/single-work-analysis/references/api-tags/douyin-billboard-api.md +1428 -0
- package/skills/single-work-analysis/references/api-tags/douyin-creator-api.md +694 -0
- package/skills/single-work-analysis/references/api-tags/douyin-creator-v2-api.md +694 -0
- package/skills/single-work-analysis/references/api-tags/douyin-search-api.md +1059 -0
- package/skills/single-work-analysis/references/api-tags/douyin-web-api.md +3314 -0
- package/skills/single-work-analysis/references/api-tags/douyin-xingtu-api.md +935 -0
- package/skills/single-work-analysis/references/api-tags/douyin-xingtu-v2-api.md +925 -0
- package/skills/single-work-analysis/references/api-tags/health-check.md +40 -0
- package/skills/single-work-analysis/references/api-tags/hybrid-parsing.md +57 -0
- package/skills/single-work-analysis/references/api-tags/instagram-v1-api.md +1224 -0
- package/skills/single-work-analysis/references/api-tags/instagram-v2-api.md +1147 -0
- package/skills/single-work-analysis/references/api-tags/instagram-v3-api.md +1123 -0
- package/skills/single-work-analysis/references/api-tags/ios-shortcut.md +45 -0
- package/skills/single-work-analysis/references/api-tags/kuaishou-app-api.md +846 -0
- package/skills/single-work-analysis/references/api-tags/kuaishou-web-api.md +551 -0
- package/skills/single-work-analysis/references/api-tags/lemon8-app-api.md +687 -0
- package/skills/single-work-analysis/references/api-tags/linkedin-web-api.md +1105 -0
- package/skills/single-work-analysis/references/api-tags/media-ingest-api.md +112 -0
- package/skills/single-work-analysis/references/api-tags/pipixia-app-api.md +721 -0
- package/skills/single-work-analysis/references/api-tags/reddit-app-api.md +1057 -0
- package/skills/single-work-analysis/references/api-tags/sora2-api.md +737 -0
- package/skills/single-work-analysis/references/api-tags/temp-mail-api.md +136 -0
- package/skills/single-work-analysis/references/api-tags/threads-web-api.md +472 -0
- package/skills/single-work-analysis/references/api-tags/tikhub-downloader-api.md +65 -0
- package/skills/single-work-analysis/references/api-tags/tikhub-user-api.md +253 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-ads-api.md +1393 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-analytics-api.md +179 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-app-v3-api.md +3264 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-creator-api.md +709 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-interaction-api.md +366 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-shop-web-api.md +663 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-web-api.md +2516 -0
- package/skills/single-work-analysis/references/api-tags/toutiao-app-api.md +220 -0
- package/skills/single-work-analysis/references/api-tags/toutiao-web-api.md +96 -0
- package/skills/single-work-analysis/references/api-tags/twitter-web-api.md +562 -0
- package/skills/single-work-analysis/references/api-tags/wechat-channels-api.md +405 -0
- package/skills/single-work-analysis/references/api-tags/wechat-media-platform-web-api.md +431 -0
- package/skills/single-work-analysis/references/api-tags/weibo-app-api.md +851 -0
- package/skills/single-work-analysis/references/api-tags/weibo-web-api.md +470 -0
- package/skills/single-work-analysis/references/api-tags/weibo-web-v2-api.md +1405 -0
- package/skills/single-work-analysis/references/api-tags/xiaohongshu-app-api.md +534 -0
- package/skills/single-work-analysis/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
- package/skills/single-work-analysis/references/api-tags/xiaohongshu-web-api.md +757 -0
- package/skills/single-work-analysis/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
- package/skills/single-work-analysis/references/api-tags/xigua-app-v2-api.md +308 -0
- package/skills/single-work-analysis/references/api-tags/youtube-web-api.md +934 -0
- package/skills/single-work-analysis/references/api-tags/youtube-web-v2-api.md +717 -0
- package/skills/single-work-analysis/references/api-tags/zhihu-web-api.md +1384 -0
- package/skills/single-work-analysis/references/asr-and-fallback.md +20 -0
- package/skills/single-work-analysis/references/config-templates/defaults.yaml +58 -0
- package/skills/single-work-analysis/references/contracts/work-card-fields.md +41 -0
- package/skills/single-work-analysis/references/platform-guides/douyin.md +47 -0
- package/skills/single-work-analysis/references/platform-guides/generic.md +43 -0
- package/skills/single-work-analysis/references/platform-guides/xiaohongshu.md +54 -0
- package/skills/single-work-analysis/references/prompt-contracts/asr-clean.md +28 -0
- package/skills/single-work-analysis/references/prompt-contracts/cta.md +24 -0
- package/skills/single-work-analysis/references/prompt-contracts/hook.md +25 -0
- package/skills/single-work-analysis/references/prompt-contracts/insight.md +47 -0
- package/skills/single-work-analysis/references/prompt-contracts/structure.md +25 -0
- package/skills/single-work-analysis/references/prompt-contracts/style.md +27 -0
- package/skills/single-work-analysis/references/prompt-contracts/summary.md +29 -0
- package/skills/single-work-analysis/references/prompt-contracts/topic.md +29 -0
- package/skills/single-work-analysis/references/schemas/work-card.schema.json +39 -0
- package/skills/single-work-analysis/references/service-guides/asr-u2-u3-fallback.md +75 -0
- package/skills/single-work-analysis/scripts/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/core/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/core/analysis_pipeline.py +133 -0
- package/skills/single-work-analysis/scripts/core/bootstrap_env.py +35 -0
- package/skills/single-work-analysis/scripts/core/config_loader.py +418 -0
- package/skills/single-work-analysis/scripts/core/extract_pipeline.py +173 -0
- package/skills/single-work-analysis/scripts/core/progress_report.py +111 -0
- package/skills/single-work-analysis/scripts/core/storage_router.py +253 -0
- package/skills/single-work-analysis/scripts/core/tikomni_common.py +588 -0
- package/skills/single-work-analysis/scripts/pipeline/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/pipeline/asr/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/pipeline/asr/asr_pipeline.py +1189 -0
- package/skills/single-work-analysis/scripts/pipeline/asr/poll_u2_task.py +95 -0
- package/skills/single-work-analysis/scripts/platform/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/platform/douyin/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/platform/douyin/douyin_video_type_matrix.py +224 -0
- package/skills/single-work-analysis/scripts/platform/douyin/run_douyin_single_video.py +1233 -0
- package/skills/single-work-analysis/scripts/platform/douyin/select_low_quality_video_url.py +200 -0
- package/skills/single-work-analysis/scripts/platform/xiaohongshu/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/platform/xiaohongshu/run_xiaohongshu_extract.py +2156 -0
- package/skills/single-work-analysis/scripts/writers/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/writers/write_benchmark_card.py +1402 -0
|
@@ -0,0 +1,1890 @@
|
|
|
1
|
+
# TikTok-Shop-Web-API Full Contract
|
|
2
|
+
|
|
3
|
+
- Back to index: [`api-capability-index.md`](../api-capability-index.md)
|
|
4
|
+
- Back to route summary: [`api-tags/tiktok-shop-web-api.md`](../api-tags/tiktok-shop-web-api.md)
|
|
5
|
+
- Current contract file: `api-contracts/tiktok-shop-web-api.md`
|
|
6
|
+
- Source: `https://app.tikomni.com/openapi/tikomni-openapi.full.with-u2.public.latest.json`
|
|
7
|
+
- Fetched at: `2026-03-08T06:54:04+00:00`
|
|
8
|
+
- Route count: `15`
|
|
9
|
+
- Default auth: Header `Authorization` Bearer
|
|
10
|
+
- Read this file only when you need precise auth notes, parameter descriptions, defaults, examples, or success-response fields.
|
|
11
|
+
- Tag description: **(TikTok电商网页版数据接口/TikTok-Shop-Web-API data endpoints)**
|
|
12
|
+
|
|
13
|
+
## Route Contracts
|
|
14
|
+
|
|
15
|
+
<a id="get-api-u1-v1-tiktok-shop-web-fetch-hot-selling-products-list"></a>
|
|
16
|
+
### `GET /api/u1/v1/tiktok/shop/web/fetch_hot_selling_products_list`
|
|
17
|
+
|
|
18
|
+
- Summary: 获取热卖商品列表/Get hot selling products list
|
|
19
|
+
- Capabilities: trends / rankings / commerce
|
|
20
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
21
|
+
- operationId: `fetch_hot_selling_products_list_api_v1_tiktok_shop_web_fetch_hot_selling_products_list_get`
|
|
22
|
+
|
|
23
|
+
#### Notes
|
|
24
|
+
|
|
25
|
+
> # [中文]
|
|
26
|
+
> ### 用途:
|
|
27
|
+
> - 获取TikTok Shop的热卖商品列表
|
|
28
|
+
> - 返回当前最受欢迎的商品
|
|
29
|
+
> ### 参数:
|
|
30
|
+
> - region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)
|
|
31
|
+
> - count: 返回商品数量,默认100 (可选)
|
|
32
|
+
> ### 返回数据结构:
|
|
33
|
+
> ```json
|
|
34
|
+
> {
|
|
35
|
+
> "code": 0,
|
|
36
|
+
> "message": "success",
|
|
37
|
+
> "data": {
|
|
38
|
+
> "products": [ // 热卖商品列表(最多1000个)
|
|
39
|
+
> {
|
|
40
|
+
> "product_id": "xxx",
|
|
41
|
+
> "title": "商品标题",
|
|
42
|
+
> "image": "商品图片",
|
|
43
|
+
> "price": {}, // 价格信息
|
|
44
|
+
> "rating": {}, // 评分信息
|
|
45
|
+
> "sales": {}, // 销量信息
|
|
46
|
+
> "rank": 1 // 热卖排名
|
|
47
|
+
> }
|
|
48
|
+
> ]
|
|
49
|
+
> }
|
|
50
|
+
> }
|
|
51
|
+
> ```
|
|
52
|
+
>
|
|
53
|
+
> # [English]
|
|
54
|
+
> ### Purpose:
|
|
55
|
+
> - Get TikTok Shop hot selling products list
|
|
56
|
+
> - Returns currently most popular products
|
|
57
|
+
> ### Parameters:
|
|
58
|
+
> - region: Region code (US/GB/SG/MY/PH/TH/VN/ID)
|
|
59
|
+
> - count: Number of products to return, default 100 (optional)
|
|
60
|
+
> ### Response Structure:
|
|
61
|
+
> ```json
|
|
62
|
+
> {
|
|
63
|
+
> "code": 0,
|
|
64
|
+
> "message": "success",
|
|
65
|
+
> "data": {
|
|
66
|
+
> "products": [ // Hot selling products (up to 1000)
|
|
67
|
+
> {
|
|
68
|
+
> "product_id": "xxx",
|
|
69
|
+
> "title": "Product title",
|
|
70
|
+
> "image": "Product image",
|
|
71
|
+
> "price": {}, // Price info
|
|
72
|
+
> "rating": {}, // Rating info
|
|
73
|
+
> "sales": {}, // Sales info
|
|
74
|
+
> "rank": 1 // Hot selling rank
|
|
75
|
+
> }
|
|
76
|
+
> ]
|
|
77
|
+
> }
|
|
78
|
+
> }
|
|
79
|
+
> ```
|
|
80
|
+
>
|
|
81
|
+
> # [示例/Example]
|
|
82
|
+
> region = "US"
|
|
83
|
+
|
|
84
|
+
#### Parameters
|
|
85
|
+
|
|
86
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
87
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
88
|
+
| region | query | string | No | 地区代码/Region code | US | US | None |
|
|
89
|
+
| count | query | integer | No | 返回商品数量/Number of products to return | 100 | 100 | None |
|
|
90
|
+
|
|
91
|
+
#### Request Body
|
|
92
|
+
|
|
93
|
+
None
|
|
94
|
+
|
|
95
|
+
#### Success Response
|
|
96
|
+
|
|
97
|
+
##### `200 application/json`
|
|
98
|
+
|
|
99
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
100
|
+
|
|
101
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
102
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
103
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
104
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
105
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
106
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
107
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
108
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
109
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
110
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
111
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
112
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
113
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
114
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
115
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
116
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
117
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
118
|
+
|
|
119
|
+
<a id="get-api-u1-v1-tiktok-shop-web-fetch-product-detail"></a>
|
|
120
|
+
### `GET /api/u1/v1/tiktok/shop/web/fetch_product_detail`
|
|
121
|
+
|
|
122
|
+
- Summary: 获取商品详情V1(桌面端-数据完整)/Get product detail V1(Full data)
|
|
123
|
+
- Capabilities: details / commerce
|
|
124
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
125
|
+
- operationId: `fetch_product_detail_api_v1_tiktok_shop_web_fetch_product_detail_get`
|
|
126
|
+
|
|
127
|
+
#### Notes
|
|
128
|
+
|
|
129
|
+
> # [中文]
|
|
130
|
+
> ### 用途:
|
|
131
|
+
> - 获取TikTok Shop商品的详细信息
|
|
132
|
+
> - 包含商品基本信息、价格、库存、评价、推荐商品等完整数据
|
|
133
|
+
> - 某些特殊地区的商品可能无法获取到数据(如:泰国),如果遇到此情况请尝试使用 `fetch_product_detail_v3` 接口
|
|
134
|
+
> ### 参数:
|
|
135
|
+
> - seller_id: 卖家ID (可传空字符串)
|
|
136
|
+
> - product_id: 商品ID (必填)
|
|
137
|
+
> - region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)
|
|
138
|
+
> ### 重要提示:
|
|
139
|
+
> - 由于接口风控原因,请务必将请求timeout设置为30秒
|
|
140
|
+
> - 如遇到400错误代码,请重试请求3次
|
|
141
|
+
> ### 返回数据结构:
|
|
142
|
+
> ```json
|
|
143
|
+
> {
|
|
144
|
+
> "code": 0,
|
|
145
|
+
> "message": "success",
|
|
146
|
+
> "data": {
|
|
147
|
+
> "global_fe_config": {}, // 全局前端配置
|
|
148
|
+
> "components_map": [], // 组件映射列表
|
|
149
|
+
> "global_data": { // 全局数据
|
|
150
|
+
> "product_info": {}, // 商品信息
|
|
151
|
+
> "seller_info": {}, // 卖家信息
|
|
152
|
+
> "shipping_info": {}, // 物流信息
|
|
153
|
+
> "review_info": {} // 评价信息
|
|
154
|
+
> }
|
|
155
|
+
> }
|
|
156
|
+
> }
|
|
157
|
+
> ```
|
|
158
|
+
>
|
|
159
|
+
> # [English]
|
|
160
|
+
> ### Purpose:
|
|
161
|
+
> - Get detailed information of TikTok Shop products
|
|
162
|
+
> - Contains complete data including basic info, price, stock, reviews, recommendations
|
|
163
|
+
> - Some products from specific regions may not be accessible (e.g., Thailand); if so, try using `fetch_product_detail_v3`
|
|
164
|
+
> ### Parameters:
|
|
165
|
+
> - seller_id: Seller ID (can be empty string)
|
|
166
|
+
> - product_id: Product ID (required)
|
|
167
|
+
> - region: Region code (US/GB/SG/MY/PH/TH/VN/ID)
|
|
168
|
+
> ### Important Notice:
|
|
169
|
+
> - Due to API rate limiting, please set request timeout to 30 seconds
|
|
170
|
+
> - If you encounter error code 400, please retry the request 3 times
|
|
171
|
+
> ### Response Structure:
|
|
172
|
+
> ```json
|
|
173
|
+
> {
|
|
174
|
+
> "code": 0,
|
|
175
|
+
> "message": "success",
|
|
176
|
+
> "data": {
|
|
177
|
+
> "global_fe_config": {}, // Global frontend config
|
|
178
|
+
> "components_map": [], // Component mapping list
|
|
179
|
+
> "global_data": { // Global data
|
|
180
|
+
> "product_info": {}, // Product information
|
|
181
|
+
> "seller_info": {}, // Seller information
|
|
182
|
+
> "shipping_info": {}, // Shipping information
|
|
183
|
+
> "review_info": {} // Review information
|
|
184
|
+
> }
|
|
185
|
+
> }
|
|
186
|
+
> }
|
|
187
|
+
> ```
|
|
188
|
+
>
|
|
189
|
+
> # [示例/Example]
|
|
190
|
+
> seller_id = "7494629757824764402"
|
|
191
|
+
> product_id = "1729556436942358002"
|
|
192
|
+
> region = "MY"
|
|
193
|
+
|
|
194
|
+
#### Parameters
|
|
195
|
+
|
|
196
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
197
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
198
|
+
| product_id | query | string | Yes | 商品ID/Product ID | None | 1729556436942358002 | None |
|
|
199
|
+
| seller_id | query | string | No | 卖家ID(可选)/Seller ID (optional) | None | 7494629757824764402 | None |
|
|
200
|
+
| region | query | string | No | 地区代码/Region code | MY | MY | None |
|
|
201
|
+
|
|
202
|
+
#### Request Body
|
|
203
|
+
|
|
204
|
+
None
|
|
205
|
+
|
|
206
|
+
#### Success Response
|
|
207
|
+
|
|
208
|
+
##### `200 application/json`
|
|
209
|
+
|
|
210
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
211
|
+
|
|
212
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
213
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
214
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
215
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
216
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
217
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
218
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
219
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
220
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
221
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
222
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
223
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
224
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
225
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
226
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
227
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
228
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
229
|
+
|
|
230
|
+
<a id="get-api-u1-v1-tiktok-shop-web-fetch-product-detail-v2"></a>
|
|
231
|
+
### `GET /api/u1/v1/tiktok/shop/web/fetch_product_detail_v2`
|
|
232
|
+
|
|
233
|
+
- Summary: 获取商品详情V2(移动端-数据少)/Get product detail V2 (Less Data)
|
|
234
|
+
- Capabilities: details / commerce
|
|
235
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
236
|
+
- operationId: `fetch_product_detail_v2_api_v1_tiktok_shop_web_fetch_product_detail_v2_get`
|
|
237
|
+
|
|
238
|
+
#### Notes
|
|
239
|
+
|
|
240
|
+
> # [中文]
|
|
241
|
+
> ### 用途:
|
|
242
|
+
> - 获取TikTok Shop商品详情(移动端接口)
|
|
243
|
+
> - 数据结构更精简,响应速度更快
|
|
244
|
+
> - 此接口返回的数据更少,如果需要更完整的数据请使用 `fetch_product_detail` 或 `fetch_product_detail_v3` 接口
|
|
245
|
+
> ### 参数:
|
|
246
|
+
> - seller_id: 卖家ID (可传空字符串)
|
|
247
|
+
> - product_id: 商品ID (必填)
|
|
248
|
+
> - region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)
|
|
249
|
+
> ### 重要提示:
|
|
250
|
+
> - 由于接口风控原因,请务必将请求timeout设置为30秒
|
|
251
|
+
> - 如遇到400错误代码,请重试请求3次
|
|
252
|
+
> ### 返回数据结构:
|
|
253
|
+
> ```json
|
|
254
|
+
> {
|
|
255
|
+
> "code": 0,
|
|
256
|
+
> "message": "success",
|
|
257
|
+
> "data": {
|
|
258
|
+
> "productDetailSchema": {}, // 商品详细信息
|
|
259
|
+
> "productCategoryInfoSchema": {}, // 分类信息
|
|
260
|
+
> "pdpRelatedKwSchema": [], // 相关关键词
|
|
261
|
+
> "productsForComponentListSchema": [] // 推荐商品组件
|
|
262
|
+
> }
|
|
263
|
+
> }
|
|
264
|
+
> ```
|
|
265
|
+
>
|
|
266
|
+
> # [English]
|
|
267
|
+
> ### Purpose:
|
|
268
|
+
> - Get TikTok Shop product details (Mobile API)
|
|
269
|
+
> - More streamlined data structure with faster response
|
|
270
|
+
> - This API returns less data; for more complete data, use `fetch_product_detail` or `fetch_product_detail_v3`
|
|
271
|
+
> ### Parameters:
|
|
272
|
+
> - seller_id: Seller ID (can be empty string)
|
|
273
|
+
> - product_id: Product ID (required)
|
|
274
|
+
> - region: Region code (US/GB/SG/MY/PH/TH/VN/ID)
|
|
275
|
+
> ### Important Notice:
|
|
276
|
+
> - Due to API rate limiting, please set request timeout to 30 seconds
|
|
277
|
+
> - If you encounter error code 400, please retry the request 3 times
|
|
278
|
+
> ### Response Structure:
|
|
279
|
+
> ```json
|
|
280
|
+
> {
|
|
281
|
+
> "code": 0,
|
|
282
|
+
> "message": "success",
|
|
283
|
+
> "data": {
|
|
284
|
+
> "productDetailSchema": {}, // Product details
|
|
285
|
+
> "productCategoryInfoSchema": {}, // Category info
|
|
286
|
+
> "pdpRelatedKwSchema": [], // Related keywords
|
|
287
|
+
> "productsForComponentListSchema": [] // Recommended product components
|
|
288
|
+
> }
|
|
289
|
+
> }
|
|
290
|
+
> ```
|
|
291
|
+
>
|
|
292
|
+
> # [示例/Example]
|
|
293
|
+
> seller_id = "7494629757824764402"
|
|
294
|
+
> product_id = "1729556436942358002"
|
|
295
|
+
> region = "MY"
|
|
296
|
+
|
|
297
|
+
#### Parameters
|
|
298
|
+
|
|
299
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
300
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
301
|
+
| product_id | query | string | Yes | 商品ID/Product ID | None | 1729556436942358002 | None |
|
|
302
|
+
| seller_id | query | string | No | 卖家ID(可选)/Seller ID (optional) | None | 7494629757824764402 | None |
|
|
303
|
+
| region | query | string | No | 地区代码/Region code | MY | MY | None |
|
|
304
|
+
|
|
305
|
+
#### Request Body
|
|
306
|
+
|
|
307
|
+
None
|
|
308
|
+
|
|
309
|
+
#### Success Response
|
|
310
|
+
|
|
311
|
+
##### `200 application/json`
|
|
312
|
+
|
|
313
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
314
|
+
|
|
315
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
316
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
317
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
318
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
319
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
320
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
321
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
322
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
323
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
324
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
325
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
326
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
327
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
328
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
329
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
330
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
331
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
332
|
+
|
|
333
|
+
<a id="get-api-u1-v1-tiktok-shop-web-fetch-product-detail-v3"></a>
|
|
334
|
+
### `GET /api/u1/v1/tiktok/shop/web/fetch_product_detail_v3`
|
|
335
|
+
|
|
336
|
+
- Summary: 获取商品详情V3(移动端-数据完整)/Get product detail V3 (Full Data)
|
|
337
|
+
- Capabilities: details / commerce
|
|
338
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
339
|
+
- operationId: `fetch_product_detail_v3_api_v1_tiktok_shop_web_fetch_product_detail_v3_get`
|
|
340
|
+
|
|
341
|
+
#### Notes
|
|
342
|
+
|
|
343
|
+
> # [中文]
|
|
344
|
+
> ### 用途:
|
|
345
|
+
> - 获取TikTok Shop商品详情
|
|
346
|
+
> - 提供最完整的商品信息,包括推荐商品、相关视频、店铺信息等
|
|
347
|
+
> - 适用于所有地区的商品
|
|
348
|
+
> ### 参数:
|
|
349
|
+
> - product_id: 商品ID (必填)
|
|
350
|
+
> - region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)
|
|
351
|
+
> ### 重要提示:
|
|
352
|
+
> - **请务必确保 `product_id` 对应的 `region` 是正确的,否则接口将不会返回数据。**
|
|
353
|
+
> - 由于接口风控原因,请务必将请求timeout设置为30秒
|
|
354
|
+
> - 如遇到400错误代码,请重试请求3次
|
|
355
|
+
> ### 返回数据结构:
|
|
356
|
+
> ```json
|
|
357
|
+
> {
|
|
358
|
+
> "code": 200,
|
|
359
|
+
> "data": {
|
|
360
|
+
> "productInfo": {}, // 商品详细信息
|
|
361
|
+
> "frequentlyBoughtTogether": [], // 经常一起购买的商品
|
|
362
|
+
> "similarProductsInCategory": [], // 同类别相似商品
|
|
363
|
+
> "exploreMoreFromShop": [], // 店铺更多商品
|
|
364
|
+
> "brandInCategoryRecommendedProducts": [], // 品牌分类推荐商品
|
|
365
|
+
> "customersAlsoBought": [], // 顾客还购买了
|
|
366
|
+
> "moreInThisColorStyle": [], // 更多颜色款式
|
|
367
|
+
> "relatedVideos": [], // 相关视频
|
|
368
|
+
> "shopPerformance": {}, // 店铺表现
|
|
369
|
+
> "categoryInfo": {}, // 分类信息
|
|
370
|
+
> "searchRecommendWords": [], // 搜索推荐词
|
|
371
|
+
> "randomSearchWord": "", // 随机搜索词
|
|
372
|
+
> "shopInfo": {}, // 店铺信息
|
|
373
|
+
> "shopHotReviews": [] // 店铺热门评论
|
|
374
|
+
> }
|
|
375
|
+
> }
|
|
376
|
+
> ```
|
|
377
|
+
>
|
|
378
|
+
> # [English]
|
|
379
|
+
> ### Purpose:
|
|
380
|
+
> - Get TikTok Shop product details
|
|
381
|
+
> - Provides the most complete product information including recommendations, videos, shop info, etc.
|
|
382
|
+
> - Suitable for products from all regions
|
|
383
|
+
> ### Parameters:
|
|
384
|
+
> - product_id: Product ID (required)
|
|
385
|
+
> - region: Region code (US/GB/SG/MY/PH/TH/VN/ID)
|
|
386
|
+
> ### Important Notice:
|
|
387
|
+
> - **Please ensure that the `region` matches the actual region of the `product_id`, otherwise the API will not return any data.**
|
|
388
|
+
> - Due to API rate limiting, please set request timeout to 30 seconds
|
|
389
|
+
> - If you encounter error code 400, please retry the request 3 times
|
|
390
|
+
> ### Response Structure:
|
|
391
|
+
> ```json
|
|
392
|
+
> {
|
|
393
|
+
> "code": 200,
|
|
394
|
+
> "data": {
|
|
395
|
+
> "productInfo": {}, // Product details
|
|
396
|
+
> "frequentlyBoughtTogether": [], // Frequently bought together
|
|
397
|
+
> "similarProductsInCategory": [], // Similar products in category
|
|
398
|
+
> "exploreMoreFromShop": [], // More from shop
|
|
399
|
+
> "brandInCategoryRecommendedProducts": [], // Brand category recommendations
|
|
400
|
+
> "customersAlsoBought": [], // Customers also bought
|
|
401
|
+
> "moreInThisColorStyle": [], // More colors/styles
|
|
402
|
+
> "relatedVideos": [], // Related videos
|
|
403
|
+
> "shopPerformance": {}, // Shop performance
|
|
404
|
+
> "categoryInfo": {}, // Category info
|
|
405
|
+
> "searchRecommendWords": [], // Search recommendation words
|
|
406
|
+
> "randomSearchWord": "", // Random search word
|
|
407
|
+
> "shopInfo": {}, // Shop information
|
|
408
|
+
> "shopHotReviews": [] // Shop hot reviews
|
|
409
|
+
> }
|
|
410
|
+
> }
|
|
411
|
+
> ```
|
|
412
|
+
>
|
|
413
|
+
> # [示例/Example]
|
|
414
|
+
> product_id = "1732108663255959373"
|
|
415
|
+
> region = "SG"
|
|
416
|
+
|
|
417
|
+
#### Parameters
|
|
418
|
+
|
|
419
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
420
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
421
|
+
| product_id | query | string | Yes | 商品ID/Product ID | None | 1732108663255959373 | None |
|
|
422
|
+
| region | query | string | No | 地区代码/Region code | SG | SG | None |
|
|
423
|
+
|
|
424
|
+
#### Request Body
|
|
425
|
+
|
|
426
|
+
None
|
|
427
|
+
|
|
428
|
+
#### Success Response
|
|
429
|
+
|
|
430
|
+
##### `200 application/json`
|
|
431
|
+
|
|
432
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
433
|
+
|
|
434
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
435
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
436
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
437
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
438
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
439
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
440
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
441
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
442
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
443
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
444
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
445
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
446
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
447
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
448
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
449
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
450
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
451
|
+
|
|
452
|
+
<a id="get-api-u1-v1-tiktok-shop-web-fetch-product-reviews-v1"></a>
|
|
453
|
+
### `GET /api/u1/v1/tiktok/shop/web/fetch_product_reviews_v1`
|
|
454
|
+
|
|
455
|
+
- Summary: 获取商品评论V1/Get product reviews V1
|
|
456
|
+
- Capabilities: commerce
|
|
457
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
458
|
+
- operationId: `fetch_product_reviews_v1_api_v1_tiktok_shop_web_fetch_product_reviews_v1_get`
|
|
459
|
+
|
|
460
|
+
#### Notes
|
|
461
|
+
|
|
462
|
+
> # [中文]
|
|
463
|
+
> ### 用途:
|
|
464
|
+
> - 获取TikTok Shop商品的评论列表(支持所有国家区域的商品,无需指定地区代码)
|
|
465
|
+
> - 支持按相关性或时间排序
|
|
466
|
+
> - 支持评论筛选和分页加载
|
|
467
|
+
> ### 参数:
|
|
468
|
+
> - product_id: 商品ID (必填)
|
|
469
|
+
> - sort_type: 排序方式
|
|
470
|
+
> - 1: 按相关性排序
|
|
471
|
+
> - 2: 按时间排序(最新),默认值
|
|
472
|
+
> - filter_id: 评论筛选ID (可选)
|
|
473
|
+
> - 可从首次响应的 review_filters 列表中获取
|
|
474
|
+
> - offset: 分页偏移量,默认1
|
|
475
|
+
> - 如果响应中 has_more=1,使用 next_cursor 值进行下一页请求
|
|
476
|
+
> ### 重要提示:
|
|
477
|
+
> - 由于接口风控原因,请务必将请求timeout设置为30秒
|
|
478
|
+
> - 如遇到400错误代码,请重试请求3次
|
|
479
|
+
> ### 返回数据结构:
|
|
480
|
+
> ```json
|
|
481
|
+
> {
|
|
482
|
+
> "code": 200,
|
|
483
|
+
> "data": {
|
|
484
|
+
> "reviews": [ // 评论列表(每页20条)
|
|
485
|
+
> {
|
|
486
|
+
> "review_id": "xxx",
|
|
487
|
+
> "user_info": {}, // 用户信息
|
|
488
|
+
> "rating": 5, // 评分(1-5星)
|
|
489
|
+
> "review_content": "...", // 评论内容
|
|
490
|
+
> "images": [], // 评论图片
|
|
491
|
+
> "videos": [], // 评论视频
|
|
492
|
+
> "create_time": 0, // 创建时间戳
|
|
493
|
+
> "is_verified_buyer": true // 是否认证买家
|
|
494
|
+
> }
|
|
495
|
+
> ],
|
|
496
|
+
> "has_more": 1, // 是否有更多: 1=有, 0=无
|
|
497
|
+
> "next_cursor": "xxx", // 下一页游标
|
|
498
|
+
> "review_filters": [ // 可用的筛选器
|
|
499
|
+
> {
|
|
500
|
+
> "filter_id": "xxx",
|
|
501
|
+
> "filter_name": "所有评论"
|
|
502
|
+
> }
|
|
503
|
+
> ],
|
|
504
|
+
> "statistics": { // 统计信息
|
|
505
|
+
> "total_count": 1000,
|
|
506
|
+
> "average_rating": 4.5,
|
|
507
|
+
> "rating_distribution": {} // 星级分布
|
|
508
|
+
> }
|
|
509
|
+
> }
|
|
510
|
+
> }
|
|
511
|
+
> ```
|
|
512
|
+
>
|
|
513
|
+
> # [English]
|
|
514
|
+
> ### Purpose:
|
|
515
|
+
> - Get TikTok Shop product reviews list (supports products from all countries/regions without specifying region code)
|
|
516
|
+
> - Support sorting by relevance or time
|
|
517
|
+
> - Support review filtering and pagination
|
|
518
|
+
> ### Parameters:
|
|
519
|
+
> - product_id: Product ID (required)
|
|
520
|
+
> - sort_type: Sort type
|
|
521
|
+
> - 1: Sort by relevance
|
|
522
|
+
> - 2: Sort by recent (default)
|
|
523
|
+
> - filter_id: Review filter ID (optional)
|
|
524
|
+
> - Can be obtained from review_filters list in first response
|
|
525
|
+
> - offset: Offset for pagination, default 1
|
|
526
|
+
> - If has_more=1 in response, use next_cursor value for next page
|
|
527
|
+
> ### Important Notice:
|
|
528
|
+
> - Due to API rate limiting, please set request timeout to 30 seconds
|
|
529
|
+
> - If you encounter error code 400, please retry the request 3 times
|
|
530
|
+
> ### Response Structure:
|
|
531
|
+
> ```json
|
|
532
|
+
> {
|
|
533
|
+
> "code": 200,
|
|
534
|
+
> "data": {
|
|
535
|
+
> "reviews": [ // Review list (20 per page)
|
|
536
|
+
> {
|
|
537
|
+
> "review_id": "xxx",
|
|
538
|
+
> "user_info": {}, // User info
|
|
539
|
+
> "rating": 5, // Rating (1-5 stars)
|
|
540
|
+
> "review_content": "...", // Review content
|
|
541
|
+
> "images": [], // Review images
|
|
542
|
+
> "videos": [], // Review videos
|
|
543
|
+
> "create_time": 0, // Create timestamp
|
|
544
|
+
> "is_verified_buyer": true // Is verified buyer
|
|
545
|
+
> }
|
|
546
|
+
> ],
|
|
547
|
+
> "has_more": 1, // Has more: 1=yes, 0=no
|
|
548
|
+
> "next_cursor": "xxx", // Next page cursor
|
|
549
|
+
> "review_filters": [ // Available filters
|
|
550
|
+
> {
|
|
551
|
+
> "filter_id": "xxx",
|
|
552
|
+
> "filter_name": "All reviews"
|
|
553
|
+
> }
|
|
554
|
+
> ],
|
|
555
|
+
> "statistics": { // Statistics
|
|
556
|
+
> "total_count": 1000,
|
|
557
|
+
> "average_rating": 4.5,
|
|
558
|
+
> "rating_distribution": {} // Rating distribution
|
|
559
|
+
> }
|
|
560
|
+
> }
|
|
561
|
+
> }
|
|
562
|
+
> ```
|
|
563
|
+
>
|
|
564
|
+
> # [示例/Example]
|
|
565
|
+
> product_id = "1731677627342753961"
|
|
566
|
+
> sort_type = 2
|
|
567
|
+
|
|
568
|
+
#### Parameters
|
|
569
|
+
|
|
570
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
571
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
572
|
+
| product_id | query | string | Yes | 商品ID/Product ID | None | 1731677627342753961 | None |
|
|
573
|
+
| sort_type | query | integer | No | 排序方式/Sort type: 1=相关性/Relevance, 2=最新/Recent | 2 | 2 | None |
|
|
574
|
+
| filter_id | query | string | No | 筛选ID/Filter ID | None | None | None |
|
|
575
|
+
| offset | query | integer | No | 分页偏移量/Offset for pagination | 1 | 1 | None |
|
|
576
|
+
|
|
577
|
+
#### Request Body
|
|
578
|
+
|
|
579
|
+
None
|
|
580
|
+
|
|
581
|
+
#### Success Response
|
|
582
|
+
|
|
583
|
+
##### `200 application/json`
|
|
584
|
+
|
|
585
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
586
|
+
|
|
587
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
588
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
589
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
590
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
591
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
592
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
593
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
594
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
595
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
596
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
597
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
598
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
599
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
600
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
601
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
602
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
603
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
604
|
+
|
|
605
|
+
<a id="get-api-u1-v1-tiktok-shop-web-fetch-product-reviews-v2"></a>
|
|
606
|
+
### `GET /api/u1/v1/tiktok/shop/web/fetch_product_reviews_v2`
|
|
607
|
+
|
|
608
|
+
- Summary: 获取商品评论V2/Get product reviews V2
|
|
609
|
+
- Capabilities: commerce
|
|
610
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
611
|
+
- operationId: `fetch_product_reviews_v2_api_v1_tiktok_shop_web_fetch_product_reviews_v2_get`
|
|
612
|
+
|
|
613
|
+
#### Notes
|
|
614
|
+
|
|
615
|
+
> # [中文]
|
|
616
|
+
> ### 用途:
|
|
617
|
+
> - 获取TikTok Shop商品评论(仅支持美洲,欧洲,地区的商品,东南亚地区商品请使用 `fetch_product_reviews_v1` 接口)
|
|
618
|
+
> - 支持多种筛选和排序方式
|
|
619
|
+
> - 数据结构更完整,包含更多评论详情
|
|
620
|
+
> ### 参数:
|
|
621
|
+
> - product_id: 商品ID (必填)
|
|
622
|
+
> - page_start: 起始页码,默认1
|
|
623
|
+
> - 当响应中 has_more=1 时,使用当前页码 +1 进行下一页请求
|
|
624
|
+
> - sort_rule: 排序规则,默认2
|
|
625
|
+
> - filter_type: 筛选类型
|
|
626
|
+
> - 1: 默认不选择任何过滤
|
|
627
|
+
> - 2: 包含图片或视频
|
|
628
|
+
> - 3: 真实购买过滤
|
|
629
|
+
> - filter_value: 星级筛选
|
|
630
|
+
> - 6: 所有星级的评论(默认)
|
|
631
|
+
> - 5: 5星评价
|
|
632
|
+
> - 4: 4星评价
|
|
633
|
+
> - 3: 3星评价
|
|
634
|
+
> - 2: 2星评价
|
|
635
|
+
> - 1: 1星评价
|
|
636
|
+
> - region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)
|
|
637
|
+
> ### 重要提示:
|
|
638
|
+
> - 由于接口风控原因,请务必将请求timeout设置为30秒
|
|
639
|
+
> - 如遇到400错误代码,请重试请求3次
|
|
640
|
+
> ### 返回数据结构:
|
|
641
|
+
> ```json
|
|
642
|
+
> {
|
|
643
|
+
> "code": 0,
|
|
644
|
+
> "message": "success",
|
|
645
|
+
> "data": {
|
|
646
|
+
> "reviews": [ // 评论列表(每页20条)
|
|
647
|
+
> {
|
|
648
|
+
> "review_id": "xxx",
|
|
649
|
+
> "user": { // 用户信息
|
|
650
|
+
> "user_id": "xxx",
|
|
651
|
+
> "nickname": "用户昵称",
|
|
652
|
+
> "avatar": "头像URL"
|
|
653
|
+
> },
|
|
654
|
+
> "rating": 5, // 评分(1-5星)
|
|
655
|
+
> "content": "评论内容",
|
|
656
|
+
> "medias": [ // 媒体文件(图片/视频)
|
|
657
|
+
> {
|
|
658
|
+
> "type": "image",
|
|
659
|
+
> "url": "媒体URL"
|
|
660
|
+
> }
|
|
661
|
+
> ],
|
|
662
|
+
> "create_time": 0, // 创建时间戳
|
|
663
|
+
> "verified_purchase": true, // 是否认证购买
|
|
664
|
+
> "product_info": {}, // 商品信息
|
|
665
|
+
> "likes_count": 10, // 点赞数
|
|
666
|
+
> "seller_reply": {} // 卖家回复
|
|
667
|
+
> }
|
|
668
|
+
> ],
|
|
669
|
+
> "has_more": 1, // 是否有更多: 1=有, 0=无
|
|
670
|
+
> "page_start": 1, // 当前页码
|
|
671
|
+
> "total_count": 500, // 总评论数
|
|
672
|
+
> "review_summary": { // 评论摘要
|
|
673
|
+
> "average_rating": 4.8,
|
|
674
|
+
> "star_distribution": { // 星级分布
|
|
675
|
+
> "5": 400,
|
|
676
|
+
> "4": 80,
|
|
677
|
+
> "3": 15,
|
|
678
|
+
> "2": 3,
|
|
679
|
+
> "1": 2
|
|
680
|
+
> }
|
|
681
|
+
> }
|
|
682
|
+
> }
|
|
683
|
+
> }
|
|
684
|
+
> ```
|
|
685
|
+
>
|
|
686
|
+
> # [English]
|
|
687
|
+
> ### Purpose:
|
|
688
|
+
> - Get TikTok Shop product reviews (only supports products from Americas, Europe; for Southeast Asia products, use `fetch_product_reviews_v1`)
|
|
689
|
+
> - Support multiple filtering and sorting options
|
|
690
|
+
> - More complete data structure with detailed review information
|
|
691
|
+
> ### Parameters:
|
|
692
|
+
> - product_id: Product ID (required)
|
|
693
|
+
> - page_start: Starting page number, default 1
|
|
694
|
+
> - When has_more=1 in response, use current page +1 for next page
|
|
695
|
+
> - sort_rule: Sort rule, default 2
|
|
696
|
+
> - filter_type: Filter type
|
|
697
|
+
> - 1: Default, no filter
|
|
698
|
+
> - 2: Contains images or videos
|
|
699
|
+
> - 3: Verified purchase filter
|
|
700
|
+
> - filter_value: Star filter
|
|
701
|
+
> - 6: All star ratings (default)
|
|
702
|
+
> - 5: 5-star reviews
|
|
703
|
+
> - 4: 4-star reviews
|
|
704
|
+
> - 3: 3-star reviews
|
|
705
|
+
> - 2: 2-star reviews
|
|
706
|
+
> - 1: 1-star reviews
|
|
707
|
+
> - region: Region code (US/GB/SG/MY/PH/TH/VN/ID)
|
|
708
|
+
> ### Important Notice:
|
|
709
|
+
> - Due to API rate limiting, please set request timeout to 30 seconds
|
|
710
|
+
> - If you encounter error code 400, please retry the request 3 times
|
|
711
|
+
> ### Response Structure:
|
|
712
|
+
> ```json
|
|
713
|
+
> {
|
|
714
|
+
> "code": 0,
|
|
715
|
+
> "message": "success",
|
|
716
|
+
> "data": {
|
|
717
|
+
> "reviews": [ // Review list (20 per page)
|
|
718
|
+
> {
|
|
719
|
+
> "review_id": "xxx",
|
|
720
|
+
> "user": { // User info
|
|
721
|
+
> "user_id": "xxx",
|
|
722
|
+
> "nickname": "Username",
|
|
723
|
+
> "avatar": "Avatar URL"
|
|
724
|
+
> },
|
|
725
|
+
> "rating": 5, // Rating (1-5 stars)
|
|
726
|
+
> "content": "Review content",
|
|
727
|
+
> "medias": [ // Media files (images/videos)
|
|
728
|
+
> {
|
|
729
|
+
> "type": "image",
|
|
730
|
+
> "url": "Media URL"
|
|
731
|
+
> }
|
|
732
|
+
> ],
|
|
733
|
+
> "create_time": 0, // Create timestamp
|
|
734
|
+
> "verified_purchase": true, // Is verified purchase
|
|
735
|
+
> "product_info": {}, // Product info
|
|
736
|
+
> "likes_count": 10, // Likes count
|
|
737
|
+
> "seller_reply": {} // Seller reply
|
|
738
|
+
> }
|
|
739
|
+
> ],
|
|
740
|
+
> "has_more": 1, // Has more: 1=yes, 0=no
|
|
741
|
+
> "page_start": 1, // Current page
|
|
742
|
+
> "total_count": 500, // Total review count
|
|
743
|
+
> "review_summary": { // Review summary
|
|
744
|
+
> "average_rating": 4.8,
|
|
745
|
+
> "star_distribution": { // Star distribution
|
|
746
|
+
> "5": 400,
|
|
747
|
+
> "4": 80,
|
|
748
|
+
> "3": 15,
|
|
749
|
+
> "2": 3,
|
|
750
|
+
> "1": 2
|
|
751
|
+
> }
|
|
752
|
+
> }
|
|
753
|
+
> }
|
|
754
|
+
> }
|
|
755
|
+
> ```
|
|
756
|
+
>
|
|
757
|
+
> # [示例/Example]
|
|
758
|
+
> product_id = "1729556436942358002"
|
|
759
|
+
> page_start = 1
|
|
760
|
+
> sort_rule = 2
|
|
761
|
+
> filter_type = 1
|
|
762
|
+
> filter_value = 6
|
|
763
|
+
> region = "MY"
|
|
764
|
+
|
|
765
|
+
#### Parameters
|
|
766
|
+
|
|
767
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
768
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
769
|
+
| product_id | query | string | Yes | 商品ID/Product ID | None | 1729556436942358002 | None |
|
|
770
|
+
| page_start | query | integer | No | 起始页码/Page start | 1 | 1 | None |
|
|
771
|
+
| sort_rule | query | integer | No | 排序规则/Sort rule | 2 | 2 | None |
|
|
772
|
+
| filter_type | query | integer | No | 筛选类型/Filter type: 1=默认, 2=有图片/视频, 3=真实购买 | 1 | 1 | None |
|
|
773
|
+
| filter_value | query | integer | No | 星级筛选/Star filter: 6=全部, 5-1=对应星级 | 6 | 6 | None |
|
|
774
|
+
| region | query | string | No | 地区代码/Region code | MY | MY | None |
|
|
775
|
+
|
|
776
|
+
#### Request Body
|
|
777
|
+
|
|
778
|
+
None
|
|
779
|
+
|
|
780
|
+
#### Success Response
|
|
781
|
+
|
|
782
|
+
##### `200 application/json`
|
|
783
|
+
|
|
784
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
785
|
+
|
|
786
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
787
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
788
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
789
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
790
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
791
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
792
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
793
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
794
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
795
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
796
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
797
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
798
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
799
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
800
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
801
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
802
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
803
|
+
|
|
804
|
+
<a id="get-api-u1-v1-tiktok-shop-web-fetch-products-by-category-id"></a>
|
|
805
|
+
### `GET /api/u1/v1/tiktok/shop/web/fetch_products_by_category_id`
|
|
806
|
+
|
|
807
|
+
- Summary: 根据分类ID获取商品列表/Get products by category ID
|
|
808
|
+
- Capabilities: commerce
|
|
809
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
810
|
+
- operationId: `fetch_products_by_category_id_api_v1_tiktok_shop_web_fetch_products_by_category_id_get`
|
|
811
|
+
|
|
812
|
+
#### Notes
|
|
813
|
+
|
|
814
|
+
> # [中文]
|
|
815
|
+
> ### 用途:
|
|
816
|
+
> - 根据商品分类ID获取该分类下的商品列表
|
|
817
|
+
> - 可用于构建分类浏览功能
|
|
818
|
+
> ### 参数:
|
|
819
|
+
> - category_id: 分类ID (必填,从fetch_products_category_list接口获取)
|
|
820
|
+
> - offset: 翻页偏移量 (默认0)
|
|
821
|
+
> - 每页默认20个商品,每次请求增加20,当响应中的 `hasMore` 为true时可继续请求下一页,否则已到最后一页。
|
|
822
|
+
> - 例如: 第1页offset=0,第2页offset=20,第3页offset=40,以此类推。
|
|
823
|
+
> - region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)
|
|
824
|
+
> ### 重要提示:
|
|
825
|
+
> - 由于接口风控原因,请务必将请求timeout设置为30秒
|
|
826
|
+
> - 如遇到400错误代码,请重试请求3次
|
|
827
|
+
> ### 返回数据结构:
|
|
828
|
+
> ```json
|
|
829
|
+
> {
|
|
830
|
+
> "code": 0,
|
|
831
|
+
> "message": "success",
|
|
832
|
+
> "data": {
|
|
833
|
+
> "products": [ // 商品列表(最多20个)
|
|
834
|
+
> {
|
|
835
|
+
> "product_id": "xxx",
|
|
836
|
+
> "title": "商品标题",
|
|
837
|
+
> "image": "商品图片",
|
|
838
|
+
> "price": {}, // 价格信息
|
|
839
|
+
> "rating": {}, // 评分信息
|
|
840
|
+
> "sales": {} // 销量信息
|
|
841
|
+
> }
|
|
842
|
+
> ]
|
|
843
|
+
> }
|
|
844
|
+
> }
|
|
845
|
+
> ```
|
|
846
|
+
>
|
|
847
|
+
> # [English]
|
|
848
|
+
> ### Purpose:
|
|
849
|
+
> - Get product list by category ID
|
|
850
|
+
> - Can be used to build category browsing feature
|
|
851
|
+
> ### Parameters:
|
|
852
|
+
> - category_id: Category ID (required, from fetch_products_category_list API)
|
|
853
|
+
> - offset: Offset for pagination (default 0)
|
|
854
|
+
> - Default 20 products per page, increase by 20 for each request. If `hasMore` in response is true, can request next page, otherwise reached last page.
|
|
855
|
+
> - Example: Page 1 offset=0, Page 2 offset=20, Page 3 offset=40, and so on.
|
|
856
|
+
> - region: Region code (US/GB/SG/MY/PH/TH/VN/ID)
|
|
857
|
+
> ### Important Notice:
|
|
858
|
+
> - Due to API rate limiting, please set request timeout to 30 seconds
|
|
859
|
+
> - If you encounter error code 400, please retry the request 3 times
|
|
860
|
+
> ### Response Structure:
|
|
861
|
+
> ```json
|
|
862
|
+
> {
|
|
863
|
+
> "code": 0,
|
|
864
|
+
> "message": "success",
|
|
865
|
+
> "data": {
|
|
866
|
+
> "products": [ // Product list (up to 20)
|
|
867
|
+
> {
|
|
868
|
+
> "product_id": "xxx",
|
|
869
|
+
> "title": "Product title",
|
|
870
|
+
> "image": "Product image",
|
|
871
|
+
> "price": {}, // Price info
|
|
872
|
+
> "rating": {}, // Rating info
|
|
873
|
+
> "sales": {} // Sales info
|
|
874
|
+
> }
|
|
875
|
+
> ]
|
|
876
|
+
> }
|
|
877
|
+
> }
|
|
878
|
+
> ```
|
|
879
|
+
>
|
|
880
|
+
> # [示例/Example]
|
|
881
|
+
> category_id = 963976
|
|
882
|
+
> region = "US"
|
|
883
|
+
|
|
884
|
+
#### Parameters
|
|
885
|
+
|
|
886
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
887
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
888
|
+
| category_id | query | integer | Yes | 分类ID/Category ID | None | 963976 | None |
|
|
889
|
+
| offset | query | integer | No | 翻页偏移量/Offset for pagination | 0 | 0 | None |
|
|
890
|
+
| region | query | string | No | 地区代码/Region code | US | US | None |
|
|
891
|
+
|
|
892
|
+
#### Request Body
|
|
893
|
+
|
|
894
|
+
None
|
|
895
|
+
|
|
896
|
+
#### Success Response
|
|
897
|
+
|
|
898
|
+
##### `200 application/json`
|
|
899
|
+
|
|
900
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
901
|
+
|
|
902
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
903
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
904
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
905
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
906
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
907
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
908
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
909
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
910
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
911
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
912
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
913
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
914
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
915
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
916
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
917
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
918
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
919
|
+
|
|
920
|
+
<a id="get-api-u1-v1-tiktok-shop-web-fetch-products-category-list"></a>
|
|
921
|
+
### `GET /api/u1/v1/tiktok/shop/web/fetch_products_category_list`
|
|
922
|
+
|
|
923
|
+
- Summary: 获取商品分类列表/Get product category list
|
|
924
|
+
- Capabilities: commerce
|
|
925
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
926
|
+
- operationId: `fetch_products_category_list_api_v1_tiktok_shop_web_fetch_products_category_list_get`
|
|
927
|
+
|
|
928
|
+
#### Notes
|
|
929
|
+
|
|
930
|
+
> # [中文]
|
|
931
|
+
> ### 用途:
|
|
932
|
+
> - 获取TikTok Shop的商品分类目录
|
|
933
|
+
> - 返回完整的分类树结构
|
|
934
|
+
> ### 参数:
|
|
935
|
+
> - region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)
|
|
936
|
+
> ### 返回数据结构:
|
|
937
|
+
> ```json
|
|
938
|
+
> [
|
|
939
|
+
> {
|
|
940
|
+
> "self": { // 分类自身信息
|
|
941
|
+
> "category_id": "xxx",
|
|
942
|
+
> "category_level": 1,
|
|
943
|
+
> "is_leaf": false,
|
|
944
|
+
> "parent_category_id": "0",
|
|
945
|
+
> "category_name": "分类名称",
|
|
946
|
+
> "category_name_en": "Category Name",
|
|
947
|
+
> "image_url": "分类图片URL"
|
|
948
|
+
> },
|
|
949
|
+
> "children": [ // 子分类列表
|
|
950
|
+
> {
|
|
951
|
+
> "self": {...},
|
|
952
|
+
> "children": [...]
|
|
953
|
+
> }
|
|
954
|
+
> ]
|
|
955
|
+
> }
|
|
956
|
+
> ]
|
|
957
|
+
> ```
|
|
958
|
+
> - 总共约28个主分类
|
|
959
|
+
>
|
|
960
|
+
> # [English]
|
|
961
|
+
> ### Purpose:
|
|
962
|
+
> - Get TikTok Shop product category directory
|
|
963
|
+
> - Returns complete category tree structure
|
|
964
|
+
> ### Parameters:
|
|
965
|
+
> - region: Region code (US/GB/SG/MY/PH/TH/VN/ID)
|
|
966
|
+
> ### Response Structure:
|
|
967
|
+
> ```json
|
|
968
|
+
> [
|
|
969
|
+
> {
|
|
970
|
+
> "self": { // Category info
|
|
971
|
+
> "category_id": "xxx",
|
|
972
|
+
> "category_level": 1,
|
|
973
|
+
> "is_leaf": false,
|
|
974
|
+
> "parent_category_id": "0",
|
|
975
|
+
> "category_name": "Category Name",
|
|
976
|
+
> "category_name_en": "Category Name",
|
|
977
|
+
> "image_url": "Category image URL"
|
|
978
|
+
> },
|
|
979
|
+
> "children": [ // Sub-categories
|
|
980
|
+
> {
|
|
981
|
+
> "self": {...},
|
|
982
|
+
> "children": [...]
|
|
983
|
+
> }
|
|
984
|
+
> ]
|
|
985
|
+
> }
|
|
986
|
+
> ]
|
|
987
|
+
> ```
|
|
988
|
+
> - Total about 28 main categories
|
|
989
|
+
>
|
|
990
|
+
> # [示例/Example]
|
|
991
|
+
> region = "US"
|
|
992
|
+
|
|
993
|
+
#### Parameters
|
|
994
|
+
|
|
995
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
996
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
997
|
+
| region | query | string | No | 地区代码/Region code | US | US | None |
|
|
998
|
+
|
|
999
|
+
#### Request Body
|
|
1000
|
+
|
|
1001
|
+
None
|
|
1002
|
+
|
|
1003
|
+
#### Success Response
|
|
1004
|
+
|
|
1005
|
+
##### `200 application/json`
|
|
1006
|
+
|
|
1007
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1008
|
+
|
|
1009
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1010
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1011
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1012
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1013
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1014
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1015
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1016
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1017
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1018
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1019
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1020
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1021
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1022
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1023
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1024
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1025
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1026
|
+
|
|
1027
|
+
<a id="get-api-u1-v1-tiktok-shop-web-fetch-search-products-list"></a>
|
|
1028
|
+
### `GET /api/u1/v1/tiktok/shop/web/fetch_search_products_list`
|
|
1029
|
+
|
|
1030
|
+
- Summary: 搜索商品列表V1/Search products list V1
|
|
1031
|
+
- Capabilities: search / commerce
|
|
1032
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1033
|
+
- operationId: `fetch_search_products_list_api_v1_tiktok_shop_web_fetch_search_products_list_get`
|
|
1034
|
+
|
|
1035
|
+
#### Notes
|
|
1036
|
+
|
|
1037
|
+
> # [中文]
|
|
1038
|
+
> ### 用途:
|
|
1039
|
+
> - 根据关键词搜索商品
|
|
1040
|
+
> - 支持分页加载更多结果
|
|
1041
|
+
> ### 参数:
|
|
1042
|
+
> - search_word: 搜索关键词 (必填)
|
|
1043
|
+
> - offset: 偏移量,用于分页 (默认0)
|
|
1044
|
+
> - page_token: 分页标记,用于获取下一页
|
|
1045
|
+
> - region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)
|
|
1046
|
+
> ### 重要提示:
|
|
1047
|
+
> - 由于接口风控原因,请务必将请求timeout设置为30秒
|
|
1048
|
+
> - 如遇到400错误代码,请重试请求3次
|
|
1049
|
+
> ### 返回数据结构:
|
|
1050
|
+
> ```json
|
|
1051
|
+
> {
|
|
1052
|
+
> "code": 0,
|
|
1053
|
+
> "message": "success",
|
|
1054
|
+
> "data": {
|
|
1055
|
+
> "products": [ // 商品列表(每页30个)
|
|
1056
|
+
> {
|
|
1057
|
+
> "product_id": "xxx",
|
|
1058
|
+
> "title": "商品标题",
|
|
1059
|
+
> "image": "商品图片URL",
|
|
1060
|
+
> "product_price_info": {}, // 价格信息
|
|
1061
|
+
> "rate_info": {}, // 评分信息
|
|
1062
|
+
> "sold_info": {}, // 销量信息
|
|
1063
|
+
> "seller_info": {}, // 卖家信息
|
|
1064
|
+
> "seo_url": "商品SEO链接",
|
|
1065
|
+
> "product_marketing_info": {} // 营销信息
|
|
1066
|
+
> }
|
|
1067
|
+
> ],
|
|
1068
|
+
> "has_more": true, // 是否有更多
|
|
1069
|
+
> "load_more_params": { // 分页参数
|
|
1070
|
+
> "offset": 30,
|
|
1071
|
+
> "page_token": "xxx",
|
|
1072
|
+
> "api_source": 2
|
|
1073
|
+
> }
|
|
1074
|
+
> }
|
|
1075
|
+
> }
|
|
1076
|
+
> ```
|
|
1077
|
+
>
|
|
1078
|
+
> # [English]
|
|
1079
|
+
> ### Purpose:
|
|
1080
|
+
> - Search products by keyword
|
|
1081
|
+
> - Support pagination to load more results
|
|
1082
|
+
> ### Parameters:
|
|
1083
|
+
> - search_word: Search keyword (required)
|
|
1084
|
+
> - offset: Offset for pagination (default 0)
|
|
1085
|
+
> - page_token: Page token for next page
|
|
1086
|
+
> - region: Region code (US/GB/SG/MY/PH/TH/VN/ID)
|
|
1087
|
+
> ### Important Notice:
|
|
1088
|
+
> - Due to API rate limiting, please set request timeout to 30 seconds
|
|
1089
|
+
> - If you encounter error code 400, please retry the request 3 times
|
|
1090
|
+
> ### Response Structure:
|
|
1091
|
+
> ```json
|
|
1092
|
+
> {
|
|
1093
|
+
> "code": 0,
|
|
1094
|
+
> "message": "success",
|
|
1095
|
+
> "data": {
|
|
1096
|
+
> "products": [ // Product list (30 per page)
|
|
1097
|
+
> {
|
|
1098
|
+
> "product_id": "xxx",
|
|
1099
|
+
> "title": "Product title",
|
|
1100
|
+
> "image": "Product image URL",
|
|
1101
|
+
> "product_price_info": {}, // Price info
|
|
1102
|
+
> "rate_info": {}, // Rating info
|
|
1103
|
+
> "sold_info": {}, // Sales info
|
|
1104
|
+
> "seller_info": {}, // Seller info
|
|
1105
|
+
> "seo_url": "Product SEO URL",
|
|
1106
|
+
> "product_marketing_info": {} // Marketing info
|
|
1107
|
+
> }
|
|
1108
|
+
> ],
|
|
1109
|
+
> "has_more": true, // Has more
|
|
1110
|
+
> "load_more_params": { // Pagination params
|
|
1111
|
+
> "offset": 30,
|
|
1112
|
+
> "page_token": "xxx",
|
|
1113
|
+
> "api_source": 2
|
|
1114
|
+
> }
|
|
1115
|
+
> }
|
|
1116
|
+
> }
|
|
1117
|
+
> ```
|
|
1118
|
+
>
|
|
1119
|
+
> # [示例/Example]
|
|
1120
|
+
> search_word = "labubu"
|
|
1121
|
+
> offset = 0
|
|
1122
|
+
> page_token = ""
|
|
1123
|
+
> region = "US"
|
|
1124
|
+
|
|
1125
|
+
#### Parameters
|
|
1126
|
+
|
|
1127
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1128
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1129
|
+
| search_word | query | string | Yes | 搜索关键词/Search keyword | None | labubu | None |
|
|
1130
|
+
| offset | query | integer | No | 偏移量/Offset | 0 | 0 | None |
|
|
1131
|
+
| page_token | query | string | No | 分页标记/Page token | None | None | None |
|
|
1132
|
+
| region | query | string | No | 地区代码/Region code | US | US | None |
|
|
1133
|
+
|
|
1134
|
+
#### Request Body
|
|
1135
|
+
|
|
1136
|
+
None
|
|
1137
|
+
|
|
1138
|
+
#### Success Response
|
|
1139
|
+
|
|
1140
|
+
##### `200 application/json`
|
|
1141
|
+
|
|
1142
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1143
|
+
|
|
1144
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1145
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1146
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1147
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1148
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1149
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1150
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1151
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1152
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1153
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1154
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1155
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1156
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1157
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1158
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1159
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1160
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1161
|
+
|
|
1162
|
+
<a id="get-api-u1-v1-tiktok-shop-web-fetch-search-products-list-v2"></a>
|
|
1163
|
+
### `GET /api/u1/v1/tiktok/shop/web/fetch_search_products_list_v2`
|
|
1164
|
+
|
|
1165
|
+
- Summary: 搜索商品列表V2(移动端)/Search products list V2 (Mobile)
|
|
1166
|
+
- Capabilities: search / commerce
|
|
1167
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1168
|
+
- operationId: `fetch_search_products_list_v2_api_v1_tiktok_shop_web_fetch_search_products_list_v2_get`
|
|
1169
|
+
|
|
1170
|
+
#### Notes
|
|
1171
|
+
|
|
1172
|
+
> # [中文]
|
|
1173
|
+
> ### 用途:
|
|
1174
|
+
> - 搜索商品(移动端接口)
|
|
1175
|
+
> - 数据结构更精简,响应更快
|
|
1176
|
+
> ### 参数:
|
|
1177
|
+
> - search_word: 搜索关键词 (必填)
|
|
1178
|
+
> - offset: 偏移量 (默认0)
|
|
1179
|
+
> - page_token: 分页标记
|
|
1180
|
+
> - region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)
|
|
1181
|
+
> ### 返回数据结构:
|
|
1182
|
+
> ```json
|
|
1183
|
+
> {
|
|
1184
|
+
> "code": 0,
|
|
1185
|
+
> "message": "success",
|
|
1186
|
+
> "data": {
|
|
1187
|
+
> "products": [...], // 商品列表
|
|
1188
|
+
> "has_more": true, // 是否有更多
|
|
1189
|
+
> "load_more_params": {} // 加载更多参数
|
|
1190
|
+
> }
|
|
1191
|
+
> }
|
|
1192
|
+
> ```
|
|
1193
|
+
>
|
|
1194
|
+
> # [English]
|
|
1195
|
+
> ### Purpose:
|
|
1196
|
+
> - Search products (Mobile API)
|
|
1197
|
+
> - More streamlined data, faster response
|
|
1198
|
+
> ### Parameters:
|
|
1199
|
+
> - search_word: Search keyword (required)
|
|
1200
|
+
> - offset: Offset (default 0)
|
|
1201
|
+
> - page_token: Page token
|
|
1202
|
+
> - region: Region code (US/GB/SG/MY/PH/TH/VN/ID)
|
|
1203
|
+
> ### Response Structure:
|
|
1204
|
+
> ```json
|
|
1205
|
+
> {
|
|
1206
|
+
> "code": 0,
|
|
1207
|
+
> "message": "success",
|
|
1208
|
+
> "data": {
|
|
1209
|
+
> "products": [...], // Product list
|
|
1210
|
+
> "has_more": true, // Has more
|
|
1211
|
+
> "load_more_params": {} // Load more params
|
|
1212
|
+
> }
|
|
1213
|
+
> }
|
|
1214
|
+
> ```
|
|
1215
|
+
>
|
|
1216
|
+
> # [示例/Example]
|
|
1217
|
+
> search_word = "labubu"
|
|
1218
|
+
> offset = 0
|
|
1219
|
+
> page_token = ""
|
|
1220
|
+
> region = "US"
|
|
1221
|
+
|
|
1222
|
+
#### Parameters
|
|
1223
|
+
|
|
1224
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1225
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1226
|
+
| search_word | query | string | Yes | 搜索关键词/Search keyword | None | labubu | None |
|
|
1227
|
+
| offset | query | integer | No | 偏移量/Offset | 0 | 0 | None |
|
|
1228
|
+
| page_token | query | string | No | 分页标记/Page token | None | None | None |
|
|
1229
|
+
| region | query | string | No | 地区代码/Region code | US | US | None |
|
|
1230
|
+
|
|
1231
|
+
#### Request Body
|
|
1232
|
+
|
|
1233
|
+
None
|
|
1234
|
+
|
|
1235
|
+
#### Success Response
|
|
1236
|
+
|
|
1237
|
+
##### `200 application/json`
|
|
1238
|
+
|
|
1239
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1240
|
+
|
|
1241
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1242
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1243
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1244
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1245
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1246
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1247
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1248
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1249
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1250
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1251
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1252
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1253
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1254
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1255
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1256
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1257
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1258
|
+
|
|
1259
|
+
<a id="get-api-u1-v1-tiktok-shop-web-fetch-search-products-list-v3"></a>
|
|
1260
|
+
### `GET /api/u1/v1/tiktok/shop/web/fetch_search_products_list_v3`
|
|
1261
|
+
|
|
1262
|
+
- Summary: 搜索商品列表V3/Search products list V3
|
|
1263
|
+
- Capabilities: search / commerce
|
|
1264
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1265
|
+
- operationId: `fetch_search_products_list_v3_api_v1_tiktok_shop_web_fetch_search_products_list_v3_get`
|
|
1266
|
+
|
|
1267
|
+
#### Notes
|
|
1268
|
+
|
|
1269
|
+
> # [中文]
|
|
1270
|
+
> ### 用途:
|
|
1271
|
+
> - 搜索TikTok Shop商品,支持高级筛选和排序
|
|
1272
|
+
> - 提供更多的筛选选项和排序方式
|
|
1273
|
+
> - 适合需要精细化筛选的场景
|
|
1274
|
+
> ### 参数:
|
|
1275
|
+
> - keyword: 搜索关键词 (必填)
|
|
1276
|
+
> - offset: 分页偏移量,默认0
|
|
1277
|
+
> - 每页固定返回20个商品
|
|
1278
|
+
> - 如果响应中 has_more=1,使用 cursor 值进行下一页请求
|
|
1279
|
+
> - region: 地区代码,Alpha-2 国家代码 (必填)
|
|
1280
|
+
> - sort_by: 排序方式,默认 RELEVANCE
|
|
1281
|
+
> - RELEVANCE: 按相关性排序(默认)
|
|
1282
|
+
> - PRICE_ASC: 价格从低到高
|
|
1283
|
+
> - PRICE_DESC: 价格从高到低
|
|
1284
|
+
> - BEST_SELLERS: 最畅销
|
|
1285
|
+
> - filters_data: 筛选数据,JSON数组格式字符串(可选)
|
|
1286
|
+
> - 可从首次响应的 filter_groups 字段获取可用筛选器
|
|
1287
|
+
> - 格式示例:
|
|
1288
|
+
> - 简单筛选按钮: {"type": 2, "value": "true"}
|
|
1289
|
+
> - 范围/多选: {"type": 8, "value_list": ["1,1000"]}
|
|
1290
|
+
> - 完整示例(价格和4星及以上): [{"type": 2, "value": "true"},{"type": 8, "value_list": ["1,1000"]}]
|
|
1291
|
+
> ### 重要提示:
|
|
1292
|
+
> - 每页固定返回20个商品
|
|
1293
|
+
> - 由于接口风控原因,请务必将请求timeout设置为30秒
|
|
1294
|
+
> - 如遇到400错误代码,请重试请求3次
|
|
1295
|
+
> ### 返回数据结构:
|
|
1296
|
+
> ```json
|
|
1297
|
+
> {
|
|
1298
|
+
> "code": 200,
|
|
1299
|
+
> "data": {
|
|
1300
|
+
> "products": [ // 商品列表
|
|
1301
|
+
> {
|
|
1302
|
+
> "product_id": "xxx",
|
|
1303
|
+
> "title": "商品标题",
|
|
1304
|
+
> "image": "商品图片URL",
|
|
1305
|
+
> "price": { // 价格信息
|
|
1306
|
+
> "current_price": 19.99,
|
|
1307
|
+
> "original_price": 29.99,
|
|
1308
|
+
> "discount": "33% OFF"
|
|
1309
|
+
> },
|
|
1310
|
+
> "rating": { // 评分信息
|
|
1311
|
+
> "average": 4.8,
|
|
1312
|
+
> "count": 1234
|
|
1313
|
+
> },
|
|
1314
|
+
> "sales": 5000, // 销量
|
|
1315
|
+
> "seller_info": {}, // 卖家信息
|
|
1316
|
+
> "url": "商品链接"
|
|
1317
|
+
> }
|
|
1318
|
+
> ],
|
|
1319
|
+
> "has_more": 1, // 是否有更多: 1=有, 0=无
|
|
1320
|
+
> "cursor": "xxx", // 下一页游标
|
|
1321
|
+
> "filter_groups": [ // 可用的筛选器组
|
|
1322
|
+
> {
|
|
1323
|
+
> "group_name": "价格",
|
|
1324
|
+
> "filters": [
|
|
1325
|
+
> {
|
|
1326
|
+
> "type": 8,
|
|
1327
|
+
> "name": "价格区间",
|
|
1328
|
+
> "options": [...]
|
|
1329
|
+
> }
|
|
1330
|
+
> ]
|
|
1331
|
+
> },
|
|
1332
|
+
> {
|
|
1333
|
+
> "group_name": "评分",
|
|
1334
|
+
> "filters": [
|
|
1335
|
+
> {
|
|
1336
|
+
> "type": 2,
|
|
1337
|
+
> "name": "4星及以上",
|
|
1338
|
+
> "value": "true"
|
|
1339
|
+
> }
|
|
1340
|
+
> ]
|
|
1341
|
+
> }
|
|
1342
|
+
> ],
|
|
1343
|
+
> "total_count": 10000 // 总商品数
|
|
1344
|
+
> }
|
|
1345
|
+
> }
|
|
1346
|
+
> ```
|
|
1347
|
+
>
|
|
1348
|
+
> # [English]
|
|
1349
|
+
> ### Purpose:
|
|
1350
|
+
> - Search TikTok Shop products with advanced filtering and sorting
|
|
1351
|
+
> - Provides more filter options and sort methods
|
|
1352
|
+
> - Suitable for scenarios requiring fine-grained filtering
|
|
1353
|
+
> ### Parameters:
|
|
1354
|
+
> - keyword: Search keyword (required)
|
|
1355
|
+
> - offset: Offset for pagination, default 0
|
|
1356
|
+
> - Fixed 20 products per page
|
|
1357
|
+
> - If has_more=1 in response, use cursor value for next page
|
|
1358
|
+
> - region: Region code, Alpha-2 country code (required)
|
|
1359
|
+
> - sort_by: Sort method, default RELEVANCE
|
|
1360
|
+
> - RELEVANCE: Sort by relevance (default)
|
|
1361
|
+
> - PRICE_ASC: Price low to high
|
|
1362
|
+
> - PRICE_DESC: Price high to low
|
|
1363
|
+
> - BEST_SELLERS: Best sellers
|
|
1364
|
+
> - filters_data: Filter data, JSON array format string (optional)
|
|
1365
|
+
> - Available filters can be obtained from filter_groups field in first response
|
|
1366
|
+
> - Format examples:
|
|
1367
|
+
> - Simple filter button: {"type": 2, "value": "true"}
|
|
1368
|
+
> - Range/multiple select: {"type": 8, "value_list": ["1,1000"]}
|
|
1369
|
+
> - Complete example (price and 4+ stars): [{"type": 2, "value": "true"},{"type": 8, "value_list": ["1,1000"]}]
|
|
1370
|
+
> ### Important Notice:
|
|
1371
|
+
> - Fixed 20 products per page
|
|
1372
|
+
> - Due to API rate limiting, please set request timeout to 30 seconds
|
|
1373
|
+
> - If you encounter error code 400, please retry the request 3 times
|
|
1374
|
+
> ### Response Structure:
|
|
1375
|
+
> ```json
|
|
1376
|
+
> {
|
|
1377
|
+
> "code": 200,
|
|
1378
|
+
> "data": {
|
|
1379
|
+
> "products": [ // Product list
|
|
1380
|
+
> {
|
|
1381
|
+
> "product_id": "xxx",
|
|
1382
|
+
> "title": "Product title",
|
|
1383
|
+
> "image": "Product image URL",
|
|
1384
|
+
> "price": { // Price info
|
|
1385
|
+
> "current_price": 19.99,
|
|
1386
|
+
> "original_price": 29.99,
|
|
1387
|
+
> "discount": "33% OFF"
|
|
1388
|
+
> },
|
|
1389
|
+
> "rating": { // Rating info
|
|
1390
|
+
> "average": 4.8,
|
|
1391
|
+
> "count": 1234
|
|
1392
|
+
> },
|
|
1393
|
+
> "sales": 5000, // Sales count
|
|
1394
|
+
> "seller_info": {}, // Seller info
|
|
1395
|
+
> "url": "Product URL"
|
|
1396
|
+
> }
|
|
1397
|
+
> ],
|
|
1398
|
+
> "has_more": 1, // Has more: 1=yes, 0=no
|
|
1399
|
+
> "cursor": "xxx", // Next page cursor
|
|
1400
|
+
> "filter_groups": [ // Available filter groups
|
|
1401
|
+
> {
|
|
1402
|
+
> "group_name": "Price",
|
|
1403
|
+
> "filters": [
|
|
1404
|
+
> {
|
|
1405
|
+
> "type": 8,
|
|
1406
|
+
> "name": "Price range",
|
|
1407
|
+
> "options": [...]
|
|
1408
|
+
> }
|
|
1409
|
+
> ]
|
|
1410
|
+
> },
|
|
1411
|
+
> {
|
|
1412
|
+
> "group_name": "Rating",
|
|
1413
|
+
> "filters": [
|
|
1414
|
+
> {
|
|
1415
|
+
> "type": 2,
|
|
1416
|
+
> "name": "4 Stars & Up",
|
|
1417
|
+
> "value": "true"
|
|
1418
|
+
> }
|
|
1419
|
+
> ]
|
|
1420
|
+
> }
|
|
1421
|
+
> ],
|
|
1422
|
+
> "total_count": 10000 // Total product count
|
|
1423
|
+
> }
|
|
1424
|
+
> }
|
|
1425
|
+
> ```
|
|
1426
|
+
>
|
|
1427
|
+
> # [示例/Example]
|
|
1428
|
+
> keyword = "baby"
|
|
1429
|
+
> offset = 0
|
|
1430
|
+
> region = "US"
|
|
1431
|
+
> sort_by = "PRICE_ASC"
|
|
1432
|
+
> filters_data = '[{"type": 2, "value": "true"},{"type": 8, "value_list": ["1,1000"]}]'
|
|
1433
|
+
|
|
1434
|
+
#### Parameters
|
|
1435
|
+
|
|
1436
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1437
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1438
|
+
| keyword | query | string | Yes | 搜索关键词/Search keyword | None | Labubu | None |
|
|
1439
|
+
| offset | query | integer | No | 偏移量/Offset | 0 | 0 | None |
|
|
1440
|
+
| region | query | string | No | 地区代码/Region code (Alpha-2) | US | US | None |
|
|
1441
|
+
| sort_by | query | string | No | 排序方式/Sort by: RELEVANCE, PRICE_ASC, PRICE_DESC, BEST_SELLERS | RELEVANCE | RELEVANCE | None |
|
|
1442
|
+
| filters_data | query | string | No | 筛选数据JSON/Filters data JSON | None | None | None |
|
|
1443
|
+
|
|
1444
|
+
#### Request Body
|
|
1445
|
+
|
|
1446
|
+
None
|
|
1447
|
+
|
|
1448
|
+
#### Success Response
|
|
1449
|
+
|
|
1450
|
+
##### `200 application/json`
|
|
1451
|
+
|
|
1452
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1453
|
+
|
|
1454
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1455
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1456
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1457
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1458
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1459
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1460
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1461
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1462
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1463
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1464
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1465
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1466
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1467
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1468
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1469
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1470
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1471
|
+
|
|
1472
|
+
<a id="get-api-u1-v1-tiktok-shop-web-fetch-search-word-suggestion"></a>
|
|
1473
|
+
### `GET /api/u1/v1/tiktok/shop/web/fetch_search_word_suggestion`
|
|
1474
|
+
|
|
1475
|
+
- Summary: 获取搜索关键词建议V1/Get search keyword suggestions V1
|
|
1476
|
+
- Capabilities: search / commerce
|
|
1477
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1478
|
+
- operationId: `fetch_search_word_suggestion_api_v1_tiktok_shop_web_fetch_search_word_suggestion_get`
|
|
1479
|
+
|
|
1480
|
+
#### Notes
|
|
1481
|
+
|
|
1482
|
+
> # [中文]
|
|
1483
|
+
> ### 用途:
|
|
1484
|
+
> - 获取搜索关键词的自动补全建议
|
|
1485
|
+
> - 用于搜索框的智能提示功能
|
|
1486
|
+
> ### 参数:
|
|
1487
|
+
> - search_word: 搜索关键词 (必填)
|
|
1488
|
+
> - lang: 语言代码 (en/zh等)
|
|
1489
|
+
> - region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)
|
|
1490
|
+
> ### 重要提示:
|
|
1491
|
+
> - 由于接口风控原因,请务必将请求timeout设置为30秒
|
|
1492
|
+
> - 如遇到400错误代码,请重试请求3次
|
|
1493
|
+
> ### 返回数据结构:
|
|
1494
|
+
> ```json
|
|
1495
|
+
> {
|
|
1496
|
+
> "code": 0,
|
|
1497
|
+
> "message": "",
|
|
1498
|
+
> "data": [ // 建议列表(最多50个)
|
|
1499
|
+
> "phone case",
|
|
1500
|
+
> "phone mount",
|
|
1501
|
+
> "phone holder for car",
|
|
1502
|
+
> "..."
|
|
1503
|
+
> ]
|
|
1504
|
+
> }
|
|
1505
|
+
> ```
|
|
1506
|
+
>
|
|
1507
|
+
> # [English]
|
|
1508
|
+
> ### Purpose:
|
|
1509
|
+
> - Get auto-complete suggestions for search keywords
|
|
1510
|
+
> - Used for search box smart suggestions
|
|
1511
|
+
> ### Parameters:
|
|
1512
|
+
> - search_word: Search keyword (required)
|
|
1513
|
+
> - lang: Language code (en/zh etc.)
|
|
1514
|
+
> - region: Region code (US/GB/SG/MY/PH/TH/VN/ID)
|
|
1515
|
+
> ### Important Notice:
|
|
1516
|
+
> - Due to API rate limiting, please set request timeout to 30 seconds
|
|
1517
|
+
> - If you encounter error code 400, please retry the request 3 times
|
|
1518
|
+
> ### Response Structure:
|
|
1519
|
+
> ```json
|
|
1520
|
+
> {
|
|
1521
|
+
> "code": 0,
|
|
1522
|
+
> "message": "",
|
|
1523
|
+
> "data": [ // Suggestion list (up to 50)
|
|
1524
|
+
> "phone case",
|
|
1525
|
+
> "phone mount",
|
|
1526
|
+
> "phone holder for car",
|
|
1527
|
+
> "..."
|
|
1528
|
+
> ]
|
|
1529
|
+
> }
|
|
1530
|
+
> ```
|
|
1531
|
+
>
|
|
1532
|
+
> # [示例/Example]
|
|
1533
|
+
> search_word = "labubu"
|
|
1534
|
+
> lang = "en"
|
|
1535
|
+
> region = "US"
|
|
1536
|
+
|
|
1537
|
+
#### Parameters
|
|
1538
|
+
|
|
1539
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1540
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1541
|
+
| search_word | query | string | Yes | 搜索关键词/Search keyword | None | labubu | None |
|
|
1542
|
+
| lang | query | string | No | 语言/Language | en | en | None |
|
|
1543
|
+
| region | query | string | No | 地区代码/Region code | US | US | None |
|
|
1544
|
+
|
|
1545
|
+
#### Request Body
|
|
1546
|
+
|
|
1547
|
+
None
|
|
1548
|
+
|
|
1549
|
+
#### Success Response
|
|
1550
|
+
|
|
1551
|
+
##### `200 application/json`
|
|
1552
|
+
|
|
1553
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1554
|
+
|
|
1555
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1556
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1557
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1558
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1559
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1560
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1561
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1562
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1563
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1564
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1565
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1566
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1567
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1568
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1569
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1570
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1571
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1572
|
+
|
|
1573
|
+
<a id="get-api-u1-v1-tiktok-shop-web-fetch-search-word-suggestion-v2"></a>
|
|
1574
|
+
### `GET /api/u1/v1/tiktok/shop/web/fetch_search_word_suggestion_v2`
|
|
1575
|
+
|
|
1576
|
+
- Summary: 获取搜索关键词建议V2(移动端)/Get search keyword suggestions V2 (Mobile)
|
|
1577
|
+
- Capabilities: search / commerce
|
|
1578
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1579
|
+
- operationId: `fetch_search_word_suggestion_v2_api_v1_tiktok_shop_web_fetch_search_word_suggestion_v2_get`
|
|
1580
|
+
|
|
1581
|
+
#### Notes
|
|
1582
|
+
|
|
1583
|
+
> # [中文]
|
|
1584
|
+
> ### 用途:
|
|
1585
|
+
> - 获取搜索关键词建议(移动端接口)
|
|
1586
|
+
> - 专为电商搜索结果优化
|
|
1587
|
+
> ### 参数:
|
|
1588
|
+
> - search_word: 搜索关键词 (必填)
|
|
1589
|
+
> - lang: 语言代码 (en/zh等)
|
|
1590
|
+
> - region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)
|
|
1591
|
+
> ### 重要提示:
|
|
1592
|
+
> - 由于接口风控原因,请务必将请求timeout设置为30秒
|
|
1593
|
+
> - 如遇到400错误代码,请重试请求3次
|
|
1594
|
+
> ### 返回数据结构:
|
|
1595
|
+
> ```json
|
|
1596
|
+
> {
|
|
1597
|
+
> "code": 0,
|
|
1598
|
+
> "message": "",
|
|
1599
|
+
> "data": [ // 建议列表(最多50个)
|
|
1600
|
+
> "关键词1",
|
|
1601
|
+
> "关键词2",
|
|
1602
|
+
> "..."
|
|
1603
|
+
> ]
|
|
1604
|
+
> }
|
|
1605
|
+
> ```
|
|
1606
|
+
>
|
|
1607
|
+
> # [English]
|
|
1608
|
+
> ### Purpose:
|
|
1609
|
+
> - Get search keyword suggestions (Mobile API)
|
|
1610
|
+
> - Optimized for e-commerce search results
|
|
1611
|
+
> ### Parameters:
|
|
1612
|
+
> - search_word: Search keyword (required)
|
|
1613
|
+
> - lang: Language code (en/zh etc.)
|
|
1614
|
+
> - region: Region code (US/GB/SG/MY/PH/TH/VN/ID)
|
|
1615
|
+
> ### Important Notice:
|
|
1616
|
+
> - Due to API rate limiting, please set request timeout to 30 seconds
|
|
1617
|
+
> - If you encounter error code 400, please retry the request 3 times
|
|
1618
|
+
> ### Response Structure:
|
|
1619
|
+
> ```json
|
|
1620
|
+
> {
|
|
1621
|
+
> "code": 0,
|
|
1622
|
+
> "message": "",
|
|
1623
|
+
> "data": [ // Suggestion list (up to 50)
|
|
1624
|
+
> "keyword1",
|
|
1625
|
+
> "keyword2",
|
|
1626
|
+
> "..."
|
|
1627
|
+
> ]
|
|
1628
|
+
> }
|
|
1629
|
+
> ```
|
|
1630
|
+
>
|
|
1631
|
+
> # [示例/Example]
|
|
1632
|
+
> search_word = "labubu"
|
|
1633
|
+
> lang = "en"
|
|
1634
|
+
> region = "US"
|
|
1635
|
+
|
|
1636
|
+
#### Parameters
|
|
1637
|
+
|
|
1638
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1639
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1640
|
+
| search_word | query | string | Yes | 搜索关键词/Search keyword | None | labubu | None |
|
|
1641
|
+
| lang | query | string | No | 语言/Language | en | en | None |
|
|
1642
|
+
| region | query | string | No | 地区代码/Region code | US | US | None |
|
|
1643
|
+
|
|
1644
|
+
#### Request Body
|
|
1645
|
+
|
|
1646
|
+
None
|
|
1647
|
+
|
|
1648
|
+
#### Success Response
|
|
1649
|
+
|
|
1650
|
+
##### `200 application/json`
|
|
1651
|
+
|
|
1652
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1653
|
+
|
|
1654
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1655
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1656
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1657
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1658
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1659
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1660
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1661
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1662
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1663
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1664
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1665
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1666
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1667
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1668
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1669
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1670
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1671
|
+
|
|
1672
|
+
<a id="get-api-u1-v1-tiktok-shop-web-fetch-seller-products-list"></a>
|
|
1673
|
+
### `GET /api/u1/v1/tiktok/shop/web/fetch_seller_products_list`
|
|
1674
|
+
|
|
1675
|
+
- Summary: 获取商家商品列表V1/Get seller products list V1
|
|
1676
|
+
- Capabilities: commerce
|
|
1677
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1678
|
+
- operationId: `fetch_seller_products_list_api_v1_tiktok_shop_web_fetch_seller_products_list_get`
|
|
1679
|
+
|
|
1680
|
+
#### Notes
|
|
1681
|
+
|
|
1682
|
+
> # [中文]
|
|
1683
|
+
> ### 用途:
|
|
1684
|
+
> - 获取指定商家的商品列表
|
|
1685
|
+
> - 支持分页加载更多商品
|
|
1686
|
+
> ### 参数:
|
|
1687
|
+
> - seller_id: 卖家ID (必填)
|
|
1688
|
+
> - search_params: 搜索参数,用于分页加载(可选)
|
|
1689
|
+
> - region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)
|
|
1690
|
+
> ### 重要提示:
|
|
1691
|
+
> - 由于接口风控原因,请务必将请求timeout设置为30秒
|
|
1692
|
+
> - 如遇到400错误代码,请重试请求3次
|
|
1693
|
+
> ### 返回数据结构:
|
|
1694
|
+
> ```json
|
|
1695
|
+
> {
|
|
1696
|
+
> "code": 0,
|
|
1697
|
+
> "message": "success",
|
|
1698
|
+
> "data": {
|
|
1699
|
+
> "products": [ // 商品列表(每页30个)
|
|
1700
|
+
> {
|
|
1701
|
+
> "product_id": "xxx",
|
|
1702
|
+
> "title": "商品标题",
|
|
1703
|
+
> "image": "商品图片URL",
|
|
1704
|
+
> "product_price_info": {}, // 价格信息
|
|
1705
|
+
> "rate_info": {}, // 评分信息
|
|
1706
|
+
> "sold_info": {}, // 销量信息
|
|
1707
|
+
> "seller_info": {}, // 卖家信息
|
|
1708
|
+
> "seo_url": "商品SEO链接"
|
|
1709
|
+
> }
|
|
1710
|
+
> ],
|
|
1711
|
+
> "has_more": true, // 是否有更多商品
|
|
1712
|
+
> "load_more_params": {} // 加载更多参数(用于下一页)
|
|
1713
|
+
> }
|
|
1714
|
+
> }
|
|
1715
|
+
> ```
|
|
1716
|
+
>
|
|
1717
|
+
> # [English]
|
|
1718
|
+
> ### Purpose:
|
|
1719
|
+
> - Get product list from specified seller
|
|
1720
|
+
> - Support pagination to load more products
|
|
1721
|
+
> ### Parameters:
|
|
1722
|
+
> - seller_id: Seller ID (required)
|
|
1723
|
+
> - search_params: Search parameters for pagination (optional)
|
|
1724
|
+
> - region: Region code (US/GB/SG/MY/PH/TH/VN/ID)
|
|
1725
|
+
> ### Important Notice:
|
|
1726
|
+
> - Due to API rate limiting, please set request timeout to 30 seconds
|
|
1727
|
+
> - If you encounter error code 400, please retry the request 3 times
|
|
1728
|
+
> ### Response Structure:
|
|
1729
|
+
> ```json
|
|
1730
|
+
> {
|
|
1731
|
+
> "code": 0,
|
|
1732
|
+
> "message": "success",
|
|
1733
|
+
> "data": {
|
|
1734
|
+
> "products": [ // Product list (30 per page)
|
|
1735
|
+
> {
|
|
1736
|
+
> "product_id": "xxx",
|
|
1737
|
+
> "title": "Product title",
|
|
1738
|
+
> "image": "Product image URL",
|
|
1739
|
+
> "product_price_info": {}, // Price info
|
|
1740
|
+
> "rate_info": {}, // Rating info
|
|
1741
|
+
> "sold_info": {}, // Sales info
|
|
1742
|
+
> "seller_info": {}, // Seller info
|
|
1743
|
+
> "seo_url": "Product SEO URL"
|
|
1744
|
+
> }
|
|
1745
|
+
> ],
|
|
1746
|
+
> "has_more": true, // Has more products
|
|
1747
|
+
> "load_more_params": {} // Load more params (for next page)
|
|
1748
|
+
> }
|
|
1749
|
+
> }
|
|
1750
|
+
> ```
|
|
1751
|
+
>
|
|
1752
|
+
> # [示例/Example]
|
|
1753
|
+
> seller_id = "7495150558072178725"
|
|
1754
|
+
> search_params = ""
|
|
1755
|
+
> region = "US"
|
|
1756
|
+
|
|
1757
|
+
#### Parameters
|
|
1758
|
+
|
|
1759
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1760
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1761
|
+
| seller_id | query | string | Yes | 卖家ID/Seller ID | None | 7495150558072178725 | None |
|
|
1762
|
+
| search_params | query | string | No | 搜索参数(用于分页)/Search params (for pagination) | None | 30_WzQzOSwzOTAwMDAwMCwxNzIzMDU4NTY3NTM5LCIxNzI5NTc3OTc3OTI0Nzg0MTY1Il0= | None |
|
|
1763
|
+
| region | query | string | No | 地区代码/Region code | US | US | None |
|
|
1764
|
+
|
|
1765
|
+
#### Request Body
|
|
1766
|
+
|
|
1767
|
+
None
|
|
1768
|
+
|
|
1769
|
+
#### Success Response
|
|
1770
|
+
|
|
1771
|
+
##### `200 application/json`
|
|
1772
|
+
|
|
1773
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1774
|
+
|
|
1775
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1776
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1777
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1778
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1779
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1780
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1781
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1782
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1783
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1784
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1785
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1786
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1787
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1788
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1789
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1790
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1791
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1792
|
+
|
|
1793
|
+
<a id="get-api-u1-v1-tiktok-shop-web-fetch-seller-products-list-v2"></a>
|
|
1794
|
+
### `GET /api/u1/v1/tiktok/shop/web/fetch_seller_products_list_v2`
|
|
1795
|
+
|
|
1796
|
+
- Summary: 获取商家商品列表V2(移动端)/Get seller products list V2 (Mobile)
|
|
1797
|
+
- Capabilities: commerce
|
|
1798
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1799
|
+
- operationId: `fetch_seller_products_list_v2_api_v1_tiktok_shop_web_fetch_seller_products_list_v2_get`
|
|
1800
|
+
|
|
1801
|
+
#### Notes
|
|
1802
|
+
|
|
1803
|
+
> # [中文]
|
|
1804
|
+
> ### 用途:
|
|
1805
|
+
> - 获取商家商品列表(移动端接口)
|
|
1806
|
+
> - 数据结构更精简
|
|
1807
|
+
> ### 参数:
|
|
1808
|
+
> - seller_id: 卖家ID (必填)
|
|
1809
|
+
> - searchParams: 搜索参数(可选)
|
|
1810
|
+
> - region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)
|
|
1811
|
+
> ### 重要提示:
|
|
1812
|
+
> - 由于接口风控原因,请务必将请求timeout设置为30秒
|
|
1813
|
+
> - 如遇到400错误代码,请重试请求3次
|
|
1814
|
+
> ### 返回数据结构:
|
|
1815
|
+
> ```json
|
|
1816
|
+
> {
|
|
1817
|
+
> "code": 0,
|
|
1818
|
+
> "message": "success",
|
|
1819
|
+
> "data": {
|
|
1820
|
+
> "products": [...], // 商品列表
|
|
1821
|
+
> "has_more": true, // 是否有更多
|
|
1822
|
+
> "load_more_params": {} // 加载更多参数
|
|
1823
|
+
> }
|
|
1824
|
+
> }
|
|
1825
|
+
> ```
|
|
1826
|
+
>
|
|
1827
|
+
> # [English]
|
|
1828
|
+
> ### Purpose:
|
|
1829
|
+
> - Get seller product list (Mobile API)
|
|
1830
|
+
> - More streamlined data structure
|
|
1831
|
+
> ### Parameters:
|
|
1832
|
+
> - seller_id: Seller ID (required)
|
|
1833
|
+
> - searchParams: Search parameters (optional)
|
|
1834
|
+
> - region: Region code (US/GB/SG/MY/PH/TH/VN/ID)
|
|
1835
|
+
> ### Important Notice:
|
|
1836
|
+
> - Due to API rate limiting, please set request timeout to 30 seconds
|
|
1837
|
+
> - If you encounter error code 400, please retry the request 3 times
|
|
1838
|
+
> ### Response Structure:
|
|
1839
|
+
> ```json
|
|
1840
|
+
> {
|
|
1841
|
+
> "code": 0,
|
|
1842
|
+
> "message": "success",
|
|
1843
|
+
> "data": {
|
|
1844
|
+
> "products": [...], // Product list
|
|
1845
|
+
> "has_more": true, // Has more
|
|
1846
|
+
> "load_more_params": {} // Load more params
|
|
1847
|
+
> }
|
|
1848
|
+
> }
|
|
1849
|
+
> ```
|
|
1850
|
+
>
|
|
1851
|
+
> # [示例/Example]
|
|
1852
|
+
> seller_id = "7495150558072178725"
|
|
1853
|
+
> searchParams = ""
|
|
1854
|
+
> region = "US"
|
|
1855
|
+
|
|
1856
|
+
#### Parameters
|
|
1857
|
+
|
|
1858
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1859
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1860
|
+
| seller_id | query | string | Yes | 卖家ID/Seller ID | None | 7495150558072178725 | None |
|
|
1861
|
+
| searchParams | query | string | No | 搜索参数/Search params | None | None | None |
|
|
1862
|
+
| region | query | string | No | 地区代码/Region code | US | US | None |
|
|
1863
|
+
|
|
1864
|
+
#### Request Body
|
|
1865
|
+
|
|
1866
|
+
None
|
|
1867
|
+
|
|
1868
|
+
#### Success Response
|
|
1869
|
+
|
|
1870
|
+
##### `200 application/json`
|
|
1871
|
+
|
|
1872
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1873
|
+
|
|
1874
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1875
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1876
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1877
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1878
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1879
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1880
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1881
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1882
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1883
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1884
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1885
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1886
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1887
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1888
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1889
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1890
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|