云店主插件（cloud-merchant）前端接口文档

目录

  1. 获取云店主管理中心数据
  2. 获取收益明细列表
  3. 获取店铺上品数量信息
  4. 获取商品分类
  5. 获取已上架商品列表
  6. 获取可上架商品列表（商品池）
  7. 上架商品
  8. 下架商品
  9. 上架/下架切换
  10. 获取云店主页数据
  11. 获取云店商品列表
  12. 获取店铺二维码
  13. 云店主订单列表
  14. 云店主售后列表

1. 获取云店主管理中心数据

简要描述：

获取云店主管理中心首页数据，包含店主信息和统计。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.cloud-merchant.frontend.center.get-center-info

请求参数说明:

无（自动获取当前登录会员）

返回示例:

成功时返回

{
    "result": 1,
    "msg": "ok",
    "data": {
        "merchant_id": 123,
        "member_id": 10001,
        "avatar": "https://example.com/avatar.png",
        "nickname": "张三",
        "invite_reward": "100.00",
        "sales_reward": "500.00",
        "order_counts": {
            "wait_pay": 2,
            "wait_send": 1,
            "wait_receive": 3,
            "aftersale": 0,
            "total": 10
        }
    }
}

失败时返回

{
    "result": 0,
    "msg": "您还不是云店主"
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功，0 表示失败
msg string 返回提示
data object 店主数据
data.merchant_id int 云店主ID
data.member_id int 会员ID
data.avatar string 会员头像URL
data.nickname string 会员昵称，未设置时返回"匿名用户"
data.invite_reward string 邀请奖励总额
data.sales_reward string 自店销售总额
data.order_counts object 订单统计
data.order_counts.wait_pay int 待付款订单数
data.order_counts.wait_send int 待发货订单数
data.order_counts.wait_receive int 待收货订单数
data.order_counts.aftersale int 售后订单数
data.order_counts.total int 订单总数

2. 获取收益明细列表

简要描述：

获取云店主的收益明细记录列表。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.cloud-merchant.frontend.center.get-income-list

请求参数说明:

参数名 类型 说明
page int 页码，默认 1
page_size int 每页数量，默认 10，最大 50

返回示例:

{
    "result": 1,
    "msg": "ok",
    "data": {
        "list": [
            {
                "id": 1,
                "type": 1,
                "type_name": "邀请奖励",
                "amount": "10.00",
                "relation_id": 0,
                "status": 1,
                "status_name": "已结算",
                "remark": "邀请新用户奖励",
                "order_sn": "",
                "created_at": 1713580800
            },
            {
                "id": 2,
                "type": 2,
                "type_name": "自店销售",
                "amount": "25.00",
                "relation_id": 1001,
                "status": 1,
                "status_name": "已结算",
                "remark": "",
                "order_sn": "ORDER202604200001",
                "created_at": 1713580800
            }
        ],
        "total": 2,
        "per_page": 10,
        "last_page": 1,
        "current_page": 1
    }
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data.list array 收益明细列表
data.list[].id int 记录ID
data.list[].type int 收益类型，1=邀请奖励，2=自店销售
data.list[].type_name string 收益类型名称
data.list[].amount string 收益金额，保留2位小数
data.list[].relation_id int 关联ID（订单ID等）
data.list[].status int 结算状态，0=未结算，1=已结算
data.list[].status_name string 结算状态名称
data.list[].remark string 备注
data.list[].order_sn string 关联订单号
data.list[].created_at int 创建时间戳
data.total int 总记录数
data.per_page int 每页数量
data.last_page int 最后一页页码
data.current_page int 当前页码

3. 获取店铺上品数量信息

简要描述：

获取当前云店主的商品数量和上限信息。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.cloud-merchant.frontend.goods.get-goods-info

请求参数说明:

无

返回示例:

{
    "result": 1,
    "msg": "ok",
    "data": {
        "goods_limit": 100,
        "goods_count": 25
    }
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data object 商品数量信息
data.goods_limit int 上品数量上限，null 表示无限制
data.goods_count int 当前已上架商品数量

4. 获取商品分类

简要描述：

获取商品分类列表，用于商品筛选。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.cloud-merchant.frontend.goods.get-category

请求参数说明:

参数名 类型 说明
parent_id int 父分类ID，默认 0（获取一级分类）

返回示例:

{
    "result": 1,
    "msg": "获取分类数据成功",
    "data": {
        "shop_set": {
            "cat_brand": "1",
            "cat_class": "1",
            "cat_level": "3",
            "cat_adv_img": "",
            "cat_adv_url": "",
            "small_cat_adv_url": "",
            "category_to_option": "0",
            "category_show_in_list": "0",
            "cat_adv_img_url": "",
            "web_design_enable": "0"
        },
        "recommendList": {
            "current_page": 1,
            "data": [
                {
                    "id": 3,
                    "name": "推荐分类名称",
                    "parent_id": 0,
                    "level": 1,
                    "thumb": "https://example.com/category/thumb.png",
                    "adv_img": "",
                    "adv_url": "",
                    "small_adv_url": ""
                }
            ],
            "first_page_url": "http://example.com/addons/yun_shop/api.php?page=1",
            "from": 1,
            "last_page": 1,
            "last_page_url": "http://example.com/addons/yun_shop/api.php?page=1",
            "links": [],
            "next_page_url": null,
            "path": "http://example.com/addons/yun_shop/api.php",
            "per_page": 20,
            "prev_page_url": null,
            "to": 1,
            "total": 1
        },
        "categoryList": {
            "current_page": 1,
            "data": [
                {
                    "id": 454,
                    "name": "小商品",
                    "parent_id": 0,
                    "level": 1,
                    "thumb": "https://example.com/category/goods.png",
                    "adv_img": "",
                    "adv_url": "",
                    "small_adv_url": null,
                    "plugin_id": 0
                },
                {
                    "id": 446,
                    "name": "家电配件",
                    "parent_id": 0,
                    "level": 1,
                    "thumb": "https://example.com/category/appliance.png",
                    "adv_img": "",
                    "adv_url": "",
                    "small_adv_url": null,
                    "plugin_id": 0
                }
            ],
            "first_page_url": "http://example.com/addons/yun_shop/api.php?page=1",
            "from": 1,
            "last_page": 1,
            "last_page_url": "http://example.com/addons/yun_shop/api.php?page=1",
            "links": [],
            "next_page_url": null,
            "path": "http://example.com/addons/yun_shop/api.php",
            "per_page": 100,
            "prev_page_url": null,
            "to": 2,
            "total": 14
        }
    }
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data object 分类数据对象
data.shop_set object 商城分类设置
data.shop_set.cat_brand string 分类品牌设置
data.shop_set.cat_class string 分类样式设置
data.shop_set.cat_level string 分类层级数量（2 或 3）
data.shop_set.cat_adv_img string 分类顶部大广告图
data.shop_set.cat_adv_url string 分类顶部大广告链接
data.shop_set.small_cat_adv_url string 小广告链接
data.shop_set.category_to_option string 分类关联规格选项开关
data.shop_set.category_show_in_list string 列表显示分类名称开关
data.shop_set.cat_adv_img_url string 分类广告图完整URL
data.shop_set.web_design_enable string 网页设计开关
data.recommendList object 推荐分类列表（分页数据）
data.recommendList.data array 推荐分类数据
data.recommendList.data[].id int 分类ID
data.recommendList.data[].name string 分类名称
data.recommendList.data[].parent_id int 父分类ID，0 表示一级分类
data.recommendList.data[].level int 分类层级
data.recommendList.data[].thumb string 分类图标URL
data.recommendList.data[].adv_img string 分类广告图URL
data.recommendList.data[].adv_url string 分类广告链接
data.recommendList.data[].small_adv_url string 小广告图URL
data.recommendList.total int 推荐分类总数
data.recommendList.per_page int 每页数量
data.recommendList.current_page int 当前页码
data.recommendList.last_page int 最后一页页码
data.categoryList object 全部分类列表（分页数据）
data.categoryList.data array 分类数据
data.categoryList.data[].id int 分类ID
data.categoryList.data[].name string 分类名称
data.categoryList.data[].parent_id int 父分类ID，0 表示一级分类
data.categoryList.data[].level int 分类层级
data.categoryList.data[].thumb string 分类图标URL
data.categoryList.data[].adv_img string 分类广告图URL
data.categoryList.data[].adv_url string 分类广告链接
data.categoryList.data[].small_adv_url string null 小广告图URL
data.categoryList.data[].plugin_id int 插件ID，0 表示商城主分类
data.categoryList.total int 分类总数
data.categoryList.per_page int 每页数量
data.categoryList.current_page int 当前页码
data.categoryList.last_page int 最后一页页码

5. 获取已上架商品列表

简要描述：

获取当前云店主已上架的商品列表（店主已添加的商品）。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.cloud-merchant.frontend.goods.get-goods-list

请求参数说明:

参数名 类型 说明
category_id int 分类ID，筛选指定分类下的商品
keyword string 关键词搜索，搜索商品标题
page int 页码，默认 1
order_field string 排序字段，price=价格，real_sales=真实销量，show_sales=显示销量，comment_num=评论数
order_by string 排序方向，asc=升序，desc=降序，默认 desc

返回示例:

{
    "result": 1,
    "msg": "ok",
    "data": {
        "data": [
            {
                "id": 100,
                "goods_id": 10001,
                "goods": {
                    "id": 10001,
                    "title": "夏季新款连衣裙",
                    "thumb": "https://example.com/goods/dress.jpg",
                    "price": "199.00",
                    "status": 1,
                    "plugin_id": 0,
                    "real_sales": 50,
                    "show_sales": 100,
                    "total_sales": 150,
                    "comment_num": 20
                }
            }
        ],
        "total": 1,
        "per_page": 15,
        "current_page": 1,
        "last_page": 1
    }
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data object 分页数据
data.data array 商品列表
data.data[].id int 店主商品关系ID
data.data[].goods_id int 商品ID
data.data[].goods object 商品详情
data.data[].goods.id int 商品ID
data.data[].goods.title string 商品标题
data.data[].goods.thumb string 商品封面图URL
data.data[].goods.price string 商品价格
data.data[].goods.status int 商品状态
data.data[].goods.total_sales int 总销量（真实销量+显示销量）
data.data[].goods.comment_num int 评论数
data.total int 总记录数
data.per_page int 每页数量
data.current_page int 当前页码
data.last_page int 最后一页页码

6. 获取可上架商品列表（商品池）

简要描述：

获取可上架的商品列表（商品池，未添加的商品），用于店主添加新商品。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.cloud-merchant.frontend.goods.get-goods-pool

请求参数说明:

参数名 类型 说明
category_id int 分类ID，筛选指定分类下的商品
keyword string 关键词搜索，支持商品ID或商品标题
page int 页码，默认 1
order_field string 排序字段，price=价格，real_sales=真实销量，show_sales=显示销量，comment_num=评论数
order_by string 排序方向，asc=升序，desc=降序，默认 desc

返回示例:

{
    "result": 1,
    "msg": "ok",
    "data": {
        "data": [
            {
                "id": 20001,
                "title": "男士T恤",
                "thumb": "https://example.com/goods/tshirt.jpg",
                "price": "89.00",
                "status": 1,
                "plugin_id": 0,
                "real_sales": 100,
                "show_sales": 50,
                "total_sales": 150,
                "comment_num": 30,
				"is_added":1,
            }
        ],
        "total": 50,
        "per_page": 15,
        "current_page": 1,
        "last_page": 4
    }
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data object 分页数据
data.data array 商品列表
data.data[].id int 商品ID
data.data[].title string 商品标题
data.data[].thumb string 商品封面图URL
data.data[].price string 商品价格
data.data[].status int 商品状态
data.data[].total_sales int 总销量
data.data[].comment_num int 评论数
data.data[].is_added int 上架状态，1 已上架，0 已下架
data.total int 总记录数
data.per_page int 每页数量
data.current_page int 当前页码
data.last_page int 最后一页页码

7. 上架商品

简要描述：

将商品添加到云店（上架）。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.cloud-merchant.frontend.goods.add

请求参数说明:

参数名 类型 说明
goods_id int 商品ID，必填

返回示例:

成功时返回

{
    "result": 1,
    "msg": "上架成功"
}

失败时返回

{
    "result": 0,
    "msg": "上品数量已达上限（100个），无法继续添加"
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示

8. 下架商品

简要描述：

将商品从云店移除（下架）。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.cloud-merchant.frontend.goods.remove

请求参数说明:

参数名 类型 说明
goods_id int 商品ID，必填

返回示例:

成功时返回

{
    "result": 1,
    "msg": "下架成功"
}

失败时返回

{
    "result": 0,
    "msg": "商品未上架"
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示

9. 上架/下架切换

简要描述：

快速切换商品的上架/下架状态。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.cloud-merchant.frontend.goods.toggle-show

请求参数说明:

参数名 类型 说明
goods_id int 商品ID，必填

返回示例:

成功时返回

{
    "result": 1,
    "msg": "上架成功",
    "data": {
        "is_show": 1
    }
}

或

{
    "result": 1,
    "msg": "下架成功",
    "data": {
        "is_show": 0
    }
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data.is_show int 当前状态，1=已上架，0=已下架

10. 获取云店主页数据

简要描述：

获取指定云店的主页数据，包含店主信息和店铺二维码。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.cloud-merchant.frontend.store.get-store-info

请求参数说明:

参数名 类型 说明
merchant_id int 云店主ID，必填

返回示例:

{
    "result": 1,
    "msg": "ok",
    "data": {
        "merchant_id": 123,
        "member_id": 10001,
        "avatar": "https://example.com/avatar.png",
        "nickname": "张三的云店",
        "qr_code": "https://example.com/qr/merchant_123_h5.png",
        "created_at": 1713580800
    }
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data object 店铺数据
data.merchant_id int 云店主ID,如果在这个页面点击商品，请将这个 id 带到下单接口传cloud_merchant_id给下单接口
data.member_id int 会员ID
data.avatar string 店主头像URL
data.nickname string 店铺昵称
data.qr_code string 店铺二维码URL
data.created_at int 店铺创建时间戳

11. 获取云店商品列表

简要描述：

获取指定云店的商品列表（只返回已上架的商品）。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.cloud-merchant.frontend.store.get-goods-list

请求参数说明:

参数名 类型 说明
merchant_id int 云店主ID，必填
category_id int 分类ID，筛选指定分类下的商品
keyword string 关键词搜索，支持商品ID或商品标题
page int 页码，默认 1
order_field string 排序字段，price=价格，real_sales=真实销量，show_sales=显示销量，comment_num=评论数
order_by string 排序方向，asc=升序，desc=降序，默认 desc

返回示例:

{
    "result": 1,
    "msg": "ok",
    "data": {
        "data": [
            {
                "id": 100,
                "goods_id": 10001,
                "goods": {
                    "id": 10001,
                    "title": "夏季新款连衣裙",
                    "thumb": "https://example.com/goods/dress.jpg",
                    "price": "199.00",
                    "total_sales": 150,
                    "comment_num": 20,
                    "labels": [
                        {
                            "name": "服装",
                            "color": "#FF6B6B"
                        }
                    ]
                }
            }
        ],
        "total": 10,
        "per_page": 15,
        "current_page": 1,
        "last_page": 1
    }
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data object 分页数据
data.data array 商品列表
data.data[].id int 店主商品关系ID
data.data[].goods_id int 商品ID
data.data[].goods object 商品详情
data.data[].goods.id int 商品ID
data.data[].goods.title string 商品标题
data.data[].goods.thumb string 商品封面图URL
data.data[].goods.price string 商品价格
data.data[].goods.total_sales int 总销量
data.data[].goods.labels array 商品标签
data.data[].goods.labels[].name string 标签名称
data.data[].goods.labels[].color string 标签颜色
data.total int 总记录数
data.per_page int 每页数量
data.current_page int 当前页码
data.last_page int 最后一页页码

12. 获取店铺二维码

简要描述：

获取云店的二维码，支持H5二维码和小程序码。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.cloud-merchant.frontend.store.get-qr-code

请求参数说明:

参数名 类型 说明
merchant_id int 云店主ID，必填
type int 二维码类型，1=H5二维码，2=小程序码，默认 1

返回示例:

{
    "result": 1,
    "msg": "ok",
    "data": {
        "qr_code": "https://example.com/qr/merchant_123_h5.png",
        "type": 1
    }
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data object 二维码数据
data.qr_code string 二维码图片URL
data.type int 二维码类型，1=H5二维码，2=小程序码

13. 云店主订单列表

简要描述：

获取云店主的订单列表，继承商城订单列表接口，只返回云店订单。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.cloud-merchant.frontend.order-list.index

请求参数说明:

继承商城订单列表参数，具体参数请参考商城订单接口文档

返回示例:

返回格式与商城订单列表接口一致

14. 云店主售后列表

简要描述：

获取云店主的售后/退款订单列表，继承商城售后列表接口，只返回云店订单的售后。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.cloud-merchant.frontend.refund-list.index

请求参数说明:

继承商城售后列表参数，具体参数请参考商城售后接口文档

返回示例:

返回格式与商城售后列表接口一致