Fecify Skill 基础 API 索引(上)
列出 Fecify Skill 中所有单个 API,按模块分组。 不含工作流——这些是多个 API 协同完成的复杂流程。 每个 API 含路径、方法、用途、文档链接。
1. 商品 (Products) — 11 个
| # | API | 路径 | 方法 | 用途 | 文档 |
|---|---|---|---|---|---|
| 1 | 商品列表 | /api/skill/product/list |
GET | 按标题/状态/专辑/tag/ID区间/时间区间分页查询商品列表 | docs/products/product-list.md |
| 2 | 商品详情 | /api/skill/product/info |
GET | 根据商品ID获取完整信息:标题/描述/variants/options/图片/SEO/专辑/tag | docs/products/product-info.md |
| 3 | 创建商品 | /api/skill/product/create |
POST | 创建新商品:含 product/variants/options/images/collections/tags/videos/角标/属性 | docs/products/product-create.md |
| 4 | 创建商品(多语言) | /api/skill/product/create-language-product |
POST | 创建新商品(多语言格式):title/subtitle/body_html/meta* 传多语言对象 | docs/products/product-create-language.md |
| 5 | 更新商品(全量) | /api/skill/product/update |
POST | 全量更新商品所有字段:覆盖标题/描述/variants/options/images/SEO等全部数据 | docs/products/product-update.md |
| 6 | 更新商品(全量·多语言) | /api/skill/product/update-language-product |
POST | 全量更新商品(多语言格式):title/bodyhtml/meta* 传多语言对象 | docs/products/product-update-language.md |
| 7 | 字段更新 | /api/skill/product/update-columns |
POST | 部分更新商品字段:仅传 title/status/spu/type 等要改的字段,不必传全量 | docs/products/product-update-columns.md |
| 8 | 字段更新(多语言) | /api/skill/product/update-language-columns |
POST | 部分更新商品字段(多语言格式):仅更新某个语言字段而不动其他字段 | docs/products/product-update-columns-language.md |
| 9 | 批量更新上下架 | /api/skill/product/update-status |
POST | 批量修改商品状态:传 id 数组 + status(1上架/2下架),一次处理多个 | docs/products/product-update-status.md |
| 10 | 更新库存 | /api/skill/product/update-stock-qty |
POST | 覆盖式更新变体库存:传 variants 数组,含 variant_id + 目标 qty | docs/products/product-update-stock.md |
| 11 | 删除商品 | /api/skill/product/delete |
POST | 批量删除商品(传 id 数组),删除前先调 check-delete-permit 检查关联 | docs/products/product-delete.md |
2. 商品专辑 (Collections) — 13 个
| # | API | 路径 | 方法 | 用途 | 文档 |
|---|---|---|---|---|---|
| 1 | 专辑列表 | /api/skill/product-collection/list |
POST | 按标题/handle/类型(1自动/2手动)/状态分页搜索商品专辑列表 | docs/collections/collection-list.md |
| 2 | 专辑详情 | /api/skill/product-collection/info |
POST | 根据专辑ID获取完整信息:标题/描述/图片/SEO/类型/排序规则/筛选器配置 | docs/collections/collection-info.md |
| 3 | 创建专辑 | /api/skill/product-collection/create |
POST | 创建新商品专辑:含 title/handle/描述/image/SEO/type/sort/filter | docs/collections/collection-create.md |
| 4 | 更新专辑 | /api/skill/product-collection/update |
POST | 全量更新专辑字段:覆盖 title/handle/描述/image/SEO/sort/filter等所有配置 | docs/collections/collection-update.md |
| 5 | 删除专辑 | /api/skill/product-collection/delete |
POST | 删除指定商品专辑(传 id 数组),清空专辑但不影响商品本身 | docs/collections/collection-delete.md |
| 6 | 专辑商品列表 | /api/skill/product-collection/get-collect-product-list |
POST | 分页查询指定专辑下的商品列表(传 collection_id + pageNum/pageSize) | docs/collections/collection-get-product-list.md |
| 7 | 批量增删商品 | /api/skill/product-collection/update-collect-product |
POST | 批量增删专辑内商品:传 add_product_ids 和 del_product_ids,一次调用同时增删 | docs/collections/collection-update-products.md |
| 8 | 解绑单商品 | /api/skill/product-collection/unbind-collect-product |
POST | 从专辑中移除单个商品(传 collection_id + product_id) | docs/collections/collection-unbind-product.md |
| 9 | 置顶商品 | /api/skill/product-collection/set-product-top |
POST | 将指定商品在专辑内置顶(传 collection_id + product_id) | docs/collections/collection-set-top.md |
| 10 | 取消置顶 | /api/skill/product-collection/unset-product-top |
POST | 取消专辑内指定商品的置顶状态(传 collection_id + product_id) | docs/collections/collection-unset-top.md |
| 11 | 筛选器-全部属性 | /api/skill/product-collection/get-all-filter-attr |
GET | 获取本店铺所有商品属性列表,供筛选器配置参考(GET 无参) | docs/collections/filter-all.md |
| 12 | 筛选器-当前属性 | /api/skill/product-collection/get-current-filter-attr |
GET | 查看某专辑当前启用的筛选属性配置(传 collection_id) | docs/collections/filter-current.md |
| 13 | 筛选器-保存属性 | /api/skill/product-collection/set-current-filter-attr |
POST | 设置专辑筛选器属性(全量覆盖):传 collection_id + filter_attrs JSON数组 | docs/collections/filter-save.md |
3. 自定义页面 (Page) — 5 个
| # | API | 路径 | 方法 | 用途 | 文档 |
|---|---|---|---|---|---|
| 1 | 页面列表 | /api/skill/page/list |
POST | 按标题/handle/创建时间分页搜索自定义页面列表 | docs/page/page-list.md |
| 2 | 页面详情 | /api/skill/page/info |
POST | 根据页面ID获取完整信息:标题/handle/bodyhtml/meta*/模板/发布时间 | docs/page/page-info.md |
| 3 | 创建页面 | /api/skill/page/create |
POST | 创建新自定义页面:含 title/handle/body_html/SEO/模板后缀 | docs/page/page-create.md |
| 4 | 更新页面 | /api/skill/page/update |
POST | 全量更新页面内容(标题/handle/body_html/SEO/模板),覆盖全部字段 | docs/page/page-update.md |
| 5 | 删除页面 | /api/skill/page/delete |
POST | 删除指定自定义页面(传 id 数组) | docs/page/page-delete.md |
4. 博客文章 (Blog Article) — 6 个
| # | API | 路径 | 方法 | 用途 | 文档 |
|---|---|---|---|---|---|
| 1 | 文章列表 | /api/skill/blog-article/list |
POST | 按标题/发布状态/专辑ID/时间区间分页搜索博客文章列表 | docs/blog-article/blog-article-list.md |
| 2 | 文章详情 | /api/skill/blog-article/info |
POST | 根据文章ID获取完整信息:标题/bodyhtml/summary/meta*/作者/所属专辑/发布时间/状态 | docs/blog-article/blog-article-info.md |
| 3 | 创建文章 | /api/skill/blog-article/create |
POST | 创建博客文章:含 title/handle/author/body_html/summary/image/SEO/published_at/collection | docs/blog-article/blog-article-create.md |
| 4 | 更新文章(全量) | /api/skill/blog-article/update |
POST | 全量更新文章所有字段:title/handle/author/body_html/SEO/collection/image等 | docs/blog-article/blog-article-update.md |
| 5 | 批量更新发布状态 | /api/skill/blog-article/change-publish-status |
POST | 批量修改文章发布状态:传 id 数组 + status(1发布/0取消),控制前台可见 | docs/blog-article/blog-article-update-publish-status.md |
| 6 | 删除文章 | /api/skill/blog-article/delete |
POST | 批量删除博客文章(传 id 数组) | docs/blog-article/blog-article-delete.md |
5. 博客专辑 (Blog Collection) — 10 个
| # | API | 路径 | 方法 | 用途 | 文档 |
|---|---|---|---|---|---|
| 1 | 专辑列表 | /api/skill/blog-collection/list |
POST | 按标题/handle/类型/状态分页搜索博客专辑列表 | docs/blog-collection/blog-collection-list.md |
| 2 | 专辑详情 | /api/skill/blog-collection/info |
POST | 根据专辑ID获取完整信息:标题/描述/handle/图片/SEO/模板/自动收录规则 | docs/blog-collection/blog-collection-info.md |
| 3 | 创建专辑 | /api/skill/blog-collection/create |
POST | 创建博客专辑:含 title/handle/描述/image/SEO/template/type/auto_tags | docs/blog-collection/blog-collection-create.md |
| 4 | 更新专辑 | /api/skill/blog-collection/update |
POST | 全量更新博客专辑字段:覆盖 title/handle/描述/image/SEO/template/auto_tags等 | docs/blog-collection/blog-collection-update.md |
| 5 | 文章列表 | /api/skill/blog-collection/get-collect-article-list |
POST | 分页查询指定博客专辑下的文章列表(传 collection_id + pageNum/pageSize) | docs/blog-collection/blog-collection-get-article-list.md |
| 6 | 批量增删文章 | /api/skill/blog-collection/update-collect-article |
POST | 批量增删博客专辑内文章:传 add_article_ids 和 del_article_ids | docs/blog-collection/blog-collection-update-articles.md |
| 7 | 解绑单文章 | /api/skill/blog-collection/unbind-collect-article |
POST | 从博客专辑中移除单篇文章(传 collection_id + article_id) | docs/blog-collection/blog-collection-unbind-article.md |
| 8 | 置顶文章 | /api/skill/blog-collection/set-article-top |
POST | 将指定文章在博客专辑内置顶(传 collection_id + article_id) | docs/blog-collection/blog-collection-set-article-top.md |
| 9 | 取消置顶 | /api/skill/blog-collection/unset-article-top |
POST | 取消博客专辑内指定文章的置顶状态(传 collection_id + article_id) | docs/blog-collection/blog-collection-unset-article-top.md |
| 10 | 删除专辑 | /api/skill/blog-collection/delete |
POST | 删除指定博客专辑(传 id 数组),清空专辑不影响文章 | docs/blog-collection/blog-collection-delete.md |
6. 商品评论 (Product Review) — 11 个
| # | API | 路径 | 方法 | 用途 | 文档 |
|---|---|---|---|---|---|
| 1 | 评论列表 | /api/skill/product-review/get-review-list |
GET | 按商品ID/内容关键词/状态/评分/时间区间分页搜索商品评论列表 | docs/product-review/review-list.md |
| 2 | 评论详情 | /api/skill/product-review/get-review-info |
GET | 根据评论ID获取完整信息:内容/评分/买家信息/点赞数/商家回复/精选状态 | docs/product-review/review-info.md |
| 3 | 创建评论 | /api/skill/product-review/add-review |
POST | 为指定商品创建新评论:含 rating/content/nickname/email/images 等 | docs/product-review/review-create.md |
| 4 | 更新评论 | /api/skill/product-review/update-review |
POST | 全量更新评论所有字段:rating/content/images/buyer_info等,覆盖式提交 | docs/product-review/review-update.md |
| 5 | 删除评论 | /api/skill/product-review/delete-review |
POST | 批量删除商品评论(传 id 数组) | docs/product-review/review-delete.md |
| 6 | 商品评论列表 | /api/skill/product-review/get-product-review-list |
GET | 根据商品ID查询其所有评论列表(指定单个商品,分页返回) | docs/product-review/review-product-list.md |
| 7 | 发布/取消发布 | /api/skill/product-review/change-review-status |
POST | 批量发布/取消发布评论:传 id 数组 + status(1发布/0取消),控制前台展示 | docs/product-review/review-publish.md |
| 8 | 随机点赞 | /api/skill/product-review/review-random-likes |
POST | 为评论随机生成点赞数据:传 id 和点赞数范围,模拟真实用户互动 | docs/product-review/review-random-likes.md |
| 9 | 商家回复 | /api/skill/product-review/reply-review |
POST | 商家回复评论:传 review_id + content,每条评论只支持一条商家回复 | docs/product-review/review-reply.md |
| 10 | 设置精选 | /api/skill/product-review/change-review-feature |
POST | 批量设置/取消评论精选标记:传 id 数组 + is_featured(1/0),精选在首页展示 | docs/product-review/review-feature.md |
| 11 | 汇总页展示 | /api/skill/product-review/change-show-in-review-page-all |
POST | 批量设置评论是否在汇总页显示:传 id 数组 + is_show(1/0) | docs/product-review/review-show-page-all.md |
7. 客户管理 (Customer) — 10 个
| # | API | 路径 | 方法 | 用途 | 文档 |
|---|---|---|---|---|---|
| 1 | 客户列表 | /api/skill/customer/get-customer-list |
GET | 按邮箱/姓名/电话/标签/注册时间/消费金额/订单数分页搜索客户列表 | docs/customer/customer-list.md |
| 2 | 客户详情 | /api/skill/customer/get-customer-info |
GET | 根据客户ID获取完整信息:邮箱/姓名/电话/地址/标签/备注/营销偏好/消费汇总 | docs/customer/customer-info.md |
| 3 | 创建客户 | /api/skill/customer/create-customer |
POST | 后台手动创建客户:含 email/name/phone/address/tags/marketing_pref/note | docs/customer/customer-create.md |
| 4 | 更新客户 | /api/skill/customer/update-customer |
POST | 部分更新客户信息:如phone/tags/note/marketing_pref,传要改的字段即可 | docs/customer/customer-update.md |
| 5 | 删除客户 | /api/skill/customer/delete-customer |
POST | 批量删除客户(传 customer_id 数组) | docs/customer/customer-delete.md |
| 6 | 客户订单列表 | /api/skill/customer/get-order-list |
GET | 查询指定客户的历史订单列表:传 customer_id + 分页,含单号/金额/状态 | docs/customer/customer-order-list.md |
| 7 | 收货地址列表 | /api/skill/customer/get-address-list |
GET | 查询指定客户的所有收货地址列表(传 customer_id) | docs/customer/customer-address-list.md |
| 8 | 留言列表 | /api/skill/customer/get-contacts-list |
GET | 分页查询客户留言/询盘列表(支持按处理状态筛选) | docs/customer/customer-contacts-list.md |
| 9 | 留言详情 | /api/skill/customer/get-contacts-info |
GET | 查看单条客户留言详情:含留言内容/联系方式/处理状态 | docs/customer/customer-contacts-info.md |
| 10 | 更改留言状态 | /api/skill/customer/change-contacts-status |
POST | 批量更新客户留言处理状态:传 ids + status,标记已处理或未处理 | docs/customer/customer-contacts-status.md |
8. 订单管理 (Order) — 24 个
查询与信息
| # | API | 路径 | 方法 | 用途 | 文档 |
|---|---|---|---|---|---|
| 1 | 待处理订单列表 | /api/skill/order/get-order-list |
GET | 分页搜索已完成支付订单:按单号/邮箱/状态/金额/时间/标签/支付方式筛选 | docs/order/order-list-recalled.md |
| 2 | 未完成订单列表 | /api/skill/order/get-pending-order-list |
GET | 分页搜索支付中断的未完成订单:按单号/邮箱/时间等筛选 | docs/order/order-list-pending.md |
| 3 | 订单详情 | /api/skill/order/get-order-info |
GET | 获取订单完整详情:基本信息/地址/商品/价格/物流/优惠/退款/日志,后续操作的前置步骤 | docs/order/order-info.md |
| 4 | 历史日志 | /api/skill/order/get-order-logs |
GET | 查询订单操作历史日志(倒序):记录状态变更/发货/退款/备注等每次操作 | docs/order/order-history-log.md |
数据维护
| # | API | 路径 | 方法 | 用途 | 文档 |
|---|---|---|---|---|---|
| 5 | 后台创建订单 | /api/skill/order/create-order |
POST | 后台手动创建订单:需传商品/收货地址/物流/折扣/客户/支付方式等完整参数 | docs/order/order-create.md |
| 6 | 获取收货地址 | /api/skill/order/get-shipping-address |
GET | 获取订单收货地址(修改地址前必须先调此接口校验权限和数据) | docs/order/order-address-get.md |
| 7 | 修改收货地址 | /api/skill/order/change-shipping-address |
POST | 修改订单收货地址:姓名/电话/国家/城市/邮编/详细地址等 | docs/order/order-address-set.md |
| 8 | 添加标签 | /api/skill/order/add-order-tag |
POST | 为订单添加管理标签(传 order_id + tag名),用于后台分类/标记/筛选 | docs/order/order-tag-add.md |
| 9 | 删除标签 | /api/skill/order/delete-order-tag |
POST | 从订单移除指定标签(传 order_id + tag名) | docs/order/order-tag-delete.md |
| 10 | 保存备注 | /api/skill/order/update-order-note |
POST | 修改订单后台备注(仅内部管理可见,不影响客户),传 order_id + note | docs/order/order-remark-save.md |
| 11 | 归档 | /api/skill/order/order-archive |
POST | 将已完成订单归档(传 order_id 数组),归档后主列表隐藏但可查 | docs/order/order-archive.md |
| 12 | 取消归档 | /api/skill/order/order-archive-cancel |
POST | 取消订单归档状态(传 order_id 数组),订单回到主列表可见 | docs/order/order-archive-cancel.md |
流转操作
| # | API | 路径 | 方法 | 用途 | 文档 |
|---|---|---|---|---|---|
| 13 | 取消待处理订单 | /api/skill/order/order-cancel |
POST | 取消待处理的已支付订单:含退款/库存恢复/可选reason/可选邮件通知 | docs/order/order-cancel.md |
| 14 | 取消未完成订单 | /api/skill/order/cancel-pending-order |
POST | 批量取消支付中断的未完成订单(传 order_id 数组),释放库存但不退款 | docs/order/order-pending-cancel.md |
| 15 | 强制支付 | /api/skill/order/order-force-payed |
POST | 强制标记未支付订单为已支付(应对支付通知丢失),可填 transaction_id | docs/order/order-force-pay.md |
| 16 | 更改折扣 | /api/skill/order/change-pending-order-discount-amount |
POST | 修改未支付订单折扣金额:传 order_id + discount_amount,调整优惠额度 | docs/order/order-pending-change-discount.md |
| 17 | 取消折扣 | /api/skill/order/remove-pending-order-discount |
POST | 移除未支付订单的折扣恢复原价(传 order_id) | docs/order/order-pending-cancel-discount.md |
包裹发货
| # | API | 路径 | 方法 | 用途 | 文档 |
|---|---|---|---|---|---|
| 18 | 可发货商品 | /api/skill/order/get-order-fulfill-product-list |
GET | 获取订单可发货商品/数量/仓库列表(区分多仓库库存),发货前必须调用 | docs/order/order-fulfill-product-list.md |
| 19 | 创建发货 | /api/skill/order/order-fulfill |
POST | 创建包裹并标记发货:含物流公司/快递单号/追踪URL/通知,支持拆包裹 | docs/order/order-fulfill-dispatch.md |
| 20 | 已发货包裹列表 | /api/skill/order/get-shiped-package-list |
GET | 查看订单所有发货包裹列表:含状态/物流/追踪号/商品明细 | docs/order/order-fulfill-shipped-list.md |
| 21 | 取消发货 | /api/skill/order/order-fulfill-cancel |
POST | 取消已创建的发货包裹并撤消发货状态,恢复库存(传 order_id + fulfillment_id) | docs/order/order-fulfill-cancel.md |
| 22 | 确认收货 | /api/skill/order/order-receive |
POST | 手动标记包裹已妥投/签收(传 order_id + fulfillment_id),管理员操作 | docs/order/order-fulfill-receive.md |
| 23 | 取消收货 | /api/skill/order/order-receive-cancel |
POST | 取消包裹已收货标记(传 order_id + fulfillment_id),多包裹场景误操作恢复 | docs/order/order-fulfill-cancel-receive.md |
| 24 | 更新物流 | /api/skill/order/update-order-fulfill |
POST | 更新已发货包裹物流信息:传 order_id + fulfillment_id + 新公司/新单号/新URL | docs/order/order-fulfill-update-shipping.md |
9. 优惠券管理 (Coupon) — 11 个
| # | API | 路径 | 方法 | 用途 | 文档 |
|---|---|---|---|---|---|
| 1 | 全部列表 | /api/skill/coupon/list |
GET | 分页搜索优惠券列表:按名称/状态/类型筛选,返回使用人数/订单量等统计 | docs/coupon/list.md |
| 2 | 激活列表 | /api/skill/coupon/get-all-active-list |
GET | 获取当前进行中的有效优惠券列表:名称/类型/折扣/有效期,快速选择用 | docs/coupon/active-list.md |
| 3 | 详情 | /api/skill/coupon/info |
GET | 获取单个优惠券完整详情:配置/条件/适用范围/限量等,更新前先查 | docs/coupon/info.md |
| 4 | 创建 | /api/skill/coupon/create |
POST | 创建新优惠券:含名称/类型/折扣/最低消费/有效期/使用限制/适用范围/限量 | docs/coupon/create.md |
| 5 | 更新 | /api/skill/coupon/update |
POST | 全量更新优惠券配置(名称/类型/折扣/门槛/有效期/限制/适用范围) | docs/coupon/update.md |
| 6 | 删除 | /api/skill/coupon/delete |
POST | 批量删除优惠券(传 id 数组),删除后用户端不可见且不可再使用 | docs/coupon/delete.md |
| 7 | 提前结束 | /api/skill/coupon/disable |
POST | 批量提前结束优惠券活动(传 id 数组),结束后不可再使用 | docs/coupon/disable.md |
| 8 | 生成券码 | /api/skill/coupon/generate-coupon-code |
GET | 生成随机优惠券兑换码,用于创建 code 类型优惠券时获取唯一码 | docs/coupon/generate.md |
| 9 | 单个统计 | /api/skill/coupon/get-coupon-statistics |
GET | 查看单个优惠券统计(已领/已用次数+金额)+ 使用该券的订单列表 | docs/coupon/statistics-info.md |
| 10 | 全部统计列表 | /api/skill/coupon/get-all-coupon-statistics |
GET | 分页查看所有优惠券使用统计(已领/已用次数+金额),每券一行 | docs/coupon/statistics-list.md |
| 11 | 全部汇总 | /api/skill/coupon/get-all-statistics |
GET | 全部优惠券活动汇总:总领用/总使用/总减免金额等全局汇总数据 | docs/coupon/statistics-all.md |