API文档介绍

微猫API采用简化REST风格的设计。请求类型只有GET和POST的区分。每个API根据不同的类型都有固定的表达方式,非常容易区分。响应结果采用规范友好的JSON数据格式。

定义

https://www.wemart.cn

认证

微猫API支持授权免登录调用所有API,需要使用shop_id和SECRET_KEY做为凭证。由微猫生成并分配给商户。调用时,需根据签名生成算法生成sign并作为参数一起使用。

签名规则

  • 1. 将所有传递参数,按ascii码排序后用&串到一起,如:shop_id=7&mobile=186xxxx
  • 2. 再用&接上secret_key,如:shop_id=7&mobile=186xxxx&Kb98OdLm36vVpdn0Pp4x5OVB6SDovUmh
  • 3. 将此字符串进行md5编码,得到签名字符串,如:sign = md5('shop_id=7&mobile=18602337250&Kbg6OdLm36vVpdn0Pp4x5OVB6SDovUmh')

生成签名(用于测试你的签名是否正确)

状态码 描述

shop_id

string
店铺ID

secret_key

string
密钥

mobile

string
手机号

定义

POST /api/v1/buyer/auth/sign/update

返回示例

{
    "code": 0,
    "msg": "成功",
    "data": "168833A3453BF9742A93DF4B9F0EADD5" // 签名字符串
}

错误码

状态码 描述

0

正常

1001

请求类型错误

1004

参数错误

1007

未登录

返回示例

{
    "msg": "成功",
    "code": 0
}

帐户登录

请求参数 描述

username

string
帐户名称

password

string
密码

remember

int
是否记住帐号,0否,1是

返回

返回参数 描述

account

string
帐户名称

nickname

string
帐户昵称

user_type

string
用户类型

admin_id

int
用户ID

定义

POST /api/v1/user/auth/login/create

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "account": "13333333333",  // 帐号
        "remember": "",  // 是否记住登录信息
        "nick_name": "张亚娟",  // 用户昵称
        "user_type": "admin",  // 用户类型,admin, seller,buyer
        "admin_id": 212,  // 管理员ID
        "shop_id": 7  // 店铺ID
    }
}

登录店铺

说明
请求参数 描述

shop_id

string
店铺ID

返回

返回参数 描述

domain

string
二级域名

logo_url

string
Logo地址

shop_name

string
店铺名称

group_id

int
权限分组ID

定义

POST /api/v1/channel/shop/auth/login/create

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "domain": "shop10086",  // 二级域名
        "logo_url": "http://imgcache1.qiniudn.com/32dbdf3a-2902-2ce7-0129-25a1acff",  // 店铺LOGO地址
        "admin_id": 212,  // 店铺创建人ID
        "shop_name": "又一个精致的店铺",  // 店铺名称
        "shop_id": 7,  // 店铺ID
        "group_id": 26  // 帐号分组ID
    }
}

帐号信息

当前登录的帐号信息
请求参数 描述

返回

返回参数 描述

status

int
帐号状态,1为正常

account

string
帐号名称

group_id

int
帐号权限组ID

nick_name

string
昵称

定义

POST /api/v1/user/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "status": 1,  // 帐号状态,1为正常,0为冻结
        "account": "13333333333",  // 帐号
        "group_id": 26,  // 帐号分组ID
        "nick_name": "张亚娟",  // 昵称
        "company": "",  // 公司名称
        "real_name": "",  // 真实姓名
        "create_time": "1519896797", 帐号创建时间
        "mobile_no": "",  // 电话
        "admin_id": 212,  // 管理员ID
        "email_address": "",  // 邮箱地址
        "token": ""  //
    }
}

创建商品

请求参数 描述

goods_name

string
商品名称

category_id

optional, int
分类ID

sku_json

json string
sku数据对象

images_json

json string
图片数据对象

brand_id

optional, int
品牌ID

goods_type

optional, int
商品类型,1为实物,2为虚拟物品

warehouse_id

optional, int
仓库ID

shipping_template_id

optional, int
运费模板ID

share_text

optional, string
分享文案

detail

optional, string
详细介绍

group_id_json

optional, json string
分组ID

tags_json

optional, json string
标签

定义

POST /api/v1/goods/edit/create

返回示例

{
    "code": 0,
    "msg": "成功"
}

修改商品

请求参数 描述

goods_id

string
商品ID

goods_name

string
商品名称

category_id

optional, int
分类ID

sku_json

json string
sku数据对象

images_json

json string
图片数据对象

brand_id

optional, int
品牌ID

goods_type

optional, int
商品类型,1为实物,2为虚拟物品

warehouse_id

optional, int
仓库ID

shipping_template_id

optional, int
运费模板ID

share_text

optional, string
分享文案

detail

optional, string
详细介绍

group_id_json

optional, json string
分组ID

tags_json

optional, json string
标签

定义

POST /api/v1/goods/edit/update

返回示例

{
    "code": 0,
    "msg": "成功"
}

商品列表

请求参数 描述

goods_name

optional, string
商品名称关键字

category_id

optional, int
分类ID

brand_id

optional, int
品牌ID

group_id

optional, int
分组ID

is_on_shelf

optional, int
是否上架,1为上架,0为下架

page_index

optional, int
页码

page_size

optional, int
每页条数

supplier_id

optional, int
是否分销商品,0不是,1是

定义

GET /api/v1/goods/list/admin/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "list": [
            {
                "last_update_time": "1515668037",  // 最后更新时间
                "min_price": 1,  // 最低价格(单位:分)
                "is_on_shelf": 1,  // 是否上架状态,1是,0否
                "shipping_template_id": 0,  // 运费模板ID
                "goods_id": "G00NIYTEOV",  // 商品ID
                "goods_name": "测试商品名称2",  // 商品名称
                "sales": 0,  // 销量
                "warehouse_id": 0,  // 仓库ID
                "brand_id": 0,  // 品牌ID
                "shop_id": 7,  // 店铺ID
                "create_time": "1515578451",  // 创建时间
                "stock": 200,  // 库存
                "images": "http://imgcache1.qiniudn.com/bacc4cef-9b37-bff5-1c07-c910dc2b",  // 图片
                "category_id": 1,  // 分类ID
                "max_price": 1,  // 最高价格(单位:分)
                "goods_type": 1,  // 商品类型,1为实物,2为虚拟商品
                "supplier_id": 0,  // 供货商ID,0即为自营商品,>0即为分销商品
                "is_change": 1     // 供货商品信息是否变更(0:未变更 1: 变更)
            }
        ]
        "total_num": 2  // 总条数
    }
}

商品详情

请求参数 描述

id

string
商品ID

定义

GET /api/v1/goods/edit/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "shop_id": 7,  // 店铺ID
        "supplier_id": 1,  // 供货商ID,0为自营
        "is_on_shelf": 1,  // 是否上架,1是,0否
        "share_text": "",  // 分享文案
        "goods_name": "测试商品名称2",  // 商品名称
        "goods_id": "G00NIYTEOV",  // 商品ID
        "group_id_list": [],  // 分组ID列表
        "current_sku": "",  // 当前SKU数据
        "sku_properties_list": [  // sku属性
            {
                "id": 8,
                "value": [
                    {
                        "id": 9,
                        "name": "红色"  // 属性值
                    }
                ],
                "name": "颜色"  // 属性名
            }
        ],
        "detail": "哈哈哈",  // 商品详情
        "sku_data_list": [  // SKU数据列表
            {
                "market_price": 0,  // 市场价格
                "sku_id": "S005UK6K43",  // SKU ID
                "properties": [  // 属性
                    {
                        "id": 8,
                        "value": {
                            "id": 9,
                            "name": "红色"
                        },
                        "name": "颜色"
                    }
                ],
                "image": "http://imgcache1.qiniudn.com/bacc4cef-9b37-bff5-1c07-c910dc2b",  // SKU图片地址
                "bar_code": "",  // 商品编码
                "price": 1,  // 单价(单位:分)
                "money_unit": "CNY",  // 货币类型
                "sales": 0,  // 销量
                "stock": 200  // 库存
            }
        ],
        "min_price": 1,  // 最低价格(单位:分)
        "brand": {  // 品牌数据
            "id": 1,  // 品牌ID
            "name_zh": "耐克", // 中文名称
            "name_en": "NIKE" // 英文名称
        },
        "shipping_template_id": 0,  // 运费模板ID
        "images_data": [  // 图片数据
            {
                "type": "1",  // 图片host类型,默认为1
                "key": "bacc4cef-9b37-bff5-1c07-c910dc2b"  // 图片三方存储的key
            }
        ],
        "images": [  // 图片列表
            "http://imgcache1.qiniudn.com/bacc4cef-9b37-bff5-1c07-c910dc2b"
        ],
        "category": { // 分类
            "id": 1,
            "name": "电器"
        },
        "max_price": 1,  // 最高价格(单位:分)
        "stock": 200  // 库存
    }
}

商品上下架

请求参数 描述

goods_id

string
商品ID,多个用,号分隔

is_on

int
是否上架,1是上架,0为下架

定义

POST /api/v1/goods/on_shelf/update

返回示例

{
    "code": 0,
    "msg": "成功"
}

商品加入分组

请求参数 描述

goods_id

string
商品ID,多个用,号分隔

group_id

string
分组ID,多个用,号分隔

定义

POST /api/v1/goods/to_group/create

返回示例

{
    "code": 0,
    "msg": "成功"
}

移除商品分组

请求参数 描述

goods_id

string
商品ID,多个用,号分隔

定义

POST /api/v1/goods/to_group/delete

返回示例

{
    "code": 0,
    "msg": "成功"
}

分类列表

请求参数 描述

定义

GET /api/v1/goods/category

返回示例

{
    "code": 0,
    "msg": "成功",
    "data": [
        {
            "parent_id": 0,
            "category_id": 101,
            "name": "服饰配件",
            "child": []
        }
    ]
}

创建分组

请求参数 描述

name

string
分组名称

定义

POST /api/v1/goods/group/create

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "last_id": 153
    }
}

修改分组

请求参数 描述

group_id

int
分组ID

name

string
分组名称

定义

POST /api/v1/goods/group/update

返回示例

{
    "code": 0,
    "msg": "成功"
}

分组列表

请求参数 描述

page_index

optional,int
页码

page_size

optional,int
每页条数

定义

GET /api/v1/goods/group/page/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "row_count": 29,  // 总条数
        "list": [
            {
                "shop_id": 7,  // 店铺ID
                "group_id": 153,  // 分组ID
                "create_time": "1515999358",  // 创建时间
                "name": "2018年2",  // 分组名称
                "description": ""  // 分组介绍
            }
        ]
    }
}

删除分组

请求参数 描述

group_id

string
分组ID,多个用,号分隔

定义

POST /api/v1/goods/group/delete

返回示例

{
    "msg": "成功",
    "code": 0
}

分组的商品数量

请求参数 描述

group_id

int
分组ID

定义

GET /api/v1/goods/group/goods_num/query

返回示例

{
    "code": 0,
    "msg": "成功",
    "data": {
        "count": 10
    }
}

移除分组里所有商品

请求参数 描述

group_id

int
分组ID

定义

POST /api/v1/goods/group/goods/delete

返回示例

{
    "code": 0,
    "msg": "成功"
}

订单列表

请求参数 描述

search_key

optional, string
搜索关键字,包含:订单ID,父订单ID,收货人手机,收货人姓名(姓名是模糊匹配)

status

optional, int
订单状态,多个用,号分隔,1未支付,2已支付,3已发货,4已收货,10已完成,-1过期,-2取消/关闭

start_time

optional, string
订单创建的开始时间

end_time

optional, string
订单创建的结束时间

page_index

optional, int
页码

page_size

optional, int
每页条数

定义

GET /api/v1/order/list/admin/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "row_count": 32,
        "list": [
            {
                "province": "上海市",  // 收货人所在省
                "sku_list": [  // sku列表
                    {
                        "buy_vol": 1,  // 购买数量
                        "sku_id": "S00CV9D1YQ",  // sku id
                        "goods_name": "id_testrergegeg",  // 商品名称
                        "price": 1,  // 单价(单位:分)
                        "bar_code": "",  // 自定义商品编码
                        "properties": [],  // sku属性
                        "is_apply_sales": 1,  // 是否有售后申请,0未申请,1已申请,默认为0
                        "image": "http://imgcache1.qiniudn.com/8de38cc7-3e84-17de-0a36-14c9c3bc"  // sku图片地址
                    }
                ],
                "street": "亮秀路9号",  // 收货人地址
                "city": "上海市",  // 收货人城市
                "supplier_id": 0,  // 供货商ID
                "district": "浦东新区",  // 收货人地区
                "shop_name": "唯一的店",  // 店铺名称
                "create_time": "1525949262",  // 订单创建时间
                "is_apply_sales": -1,  // 是否有售后申请,0未申请,1已申请,默认为0
                "zip_code": "",  // 邮编
                "status": -2,  // 订单状态,1未支付,2已支付,3已发货,4已收货,10已完成,-1过期,-2取消/关闭
                "pay_amount": 1,  // 实付金额,(单位:分)
                "order_id": "12018051018474208232",  // 订单ID
                "sale_channel": 1,  // 售卖渠道,默认为1,1为在线商城
                "city_no": 73,  // 收货人城市编号
                "parent_order_id": "P62018051018474208225",  // 父订单ID
                "shipping_fee": 0,  // 运费(单位:分)
                "name": "茅铸锋",  // 收货人姓名
                "mobile": "17681698044",  // 收货人电话
                "shop_id": "7",  // 店铺ID
                "status_text": "已关闭",  // 订单状态文本说明
                "buyer_id": "oZ9XDvzY8IGYd_eZ--XQha5tJHk0"  // 买家ID
            }
        ]
    }
}

订单详情

请求参数 描述

order_id

string
订单ID

定义

GET /api/v1/order/detail/admin/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "logistics": {  // 物流信息
            "tracking_no": "",  // 物流单号
            "shipper_code": "",  // 快递公司编码
            "remark": "",  // 备注
            "create_time": "",  // 发货时间
            "shipper_name": ""  // 快递公司名称
        },
        "order_remark": "",  // 订单备注
        "buyer_data": {  // 买家信息
            "scene_type": "wechat",  // 场景类型,wechat,web
            "buyer_id": "oZ9XDvzY8IGYd_eZ--XQha5tJHk0"  // 买家ID
        },
        "left_time": 0,  // 过期剩余时间,单位秒
        "sku_list": [  // sku列表
            {
                "parent_order_id": "P62018051018474208225",  // 父订单ID
                "buy_vol": 1,  // 购买数量
                "sku_id": "S00CV9D1YQ",  // sku id
                "goods_id": "G00IVQJZAG",  // 商品ID
                "goods_name": "id_testrergegeg",  // 商品名称
                "order_id": "12018051018474208232",  // 订单ID
                "bar_code": "",  // 自定义商品编码
                "price": 1,  // 单价(单位:分)
                "properties": [],  // sku属性
                "ext_json": "",  // 扩展数据
                "is_apply_sales": 1,  // 是否有售后申请,0未申请,1已申请,默认为0
                "shipping_fee": 0,  // 运费(单位:分)
                "image": "http://imgcache1.qiniudn.com/8de38cc7-3e84-17de-0a36-14c9c3bc"  // sku图片
            }
        ],
        "create_time": "1525949262",  // 订单创建时间
        "shop_name": "唯一的店",  // 店铺名称
        "supplier_id": 0,  // 供货商ID,0为自营订单
        "discount_shipping_fee": 0,  // 运费折扣金额
        "order_amount": 1,  // 订单金额(订单商品金额合计)(单位:分)
        "is_apply_sales": -1,  // 是否有售后申请,0未申请,1已申请,默认为0
        "status": -2,  // 订单状态,1未支付,2已支付,3已发货,4已收货,10已完成,-1过期,-2取消/关闭
        "pay_amount": 1,  // 实付金额(单位:分)
        "order_id": "12018051018474208232",  // 订单ID
        "sale_channel": 1,  // 售卖渠道,默认为1,1为在线商城
        "discount_coupon": 0,  // 优惠券折扣金额(单位:分)
        "payment": {  // 支付信息
            "trade_no": "4200000117201805106351007834",  // 支付系统订单号
            "pay_type": "3",  // 支付类型,1为支付宝,3为微信
            "pay_type_text": "微信",  // 支付类型文本
            "pay_time": "1525949268"  // 支付时间
        },
        "discount_amount": 0,  // 折扣金额,和运费折扣,优惠券折扣是并列关系,并不是包含关系(单位:分)
        "parent_order_id": "P62018051018474208225",  // 父订单ID
        "shipping_fee": 0,  // 运费(单位:分)
        "shipping_address": {  // 收货地址
            "province": "上海市",
            "city": "上海市",
            "city_no": 73,
            "street": "亮秀路9号",
            "name": "茅铸锋",
            "district": "浦东新区",
            "mobile": "17681698044",
            "id_card": "33052119941019401X",
            "zip_code": ""
        },
        "status_text": "已关闭"  // 订单状态文本
    }
}

订单营销信息

请求参数 描述

parent_order_id

string
母订单ID

定义

GET /api/v1/order/activity/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": [
        {
            "parent_order_id": "P72018011918222005809",  // 父订单ID
            "activity_id": 50,  // 营销活动ID
            "detail": {  // 营销活动数据
                "status": "进行中",  // 状态
                "activity_id": 50,  // 营销活动ID
                "code": "5558923895",  // 编号
                "name": "测试哈哈哈",  // 营销活动名称
                "activity_type": "m_coupon",  // 营销类型
                "start_time": "1516118400",  // 开始时间
                "description": "满1减0.01",  // 营销活动介绍
                "limit_vol": 8,  // 限领个数
                "shop_id": 7,  // 店铺ID
                "end_time": "1517328000",  // 结束时间
                "apply_to": [  // 适用范围
                    {
                        "scope_type": "all",  // 范围类型,all所有商品,some_goods部分商品,category指定分类,group指定分组
                        "scope_value": [  // 范围值,类型为all时,值为空,类型为some_goods时,值为goods_id,多个用,号创建,category和group同理
                            ""
                        ]
                    }
                ],
                "is_use": 1, // 是否使用, 1是,这里都为1
                "stock": 999,  // 库存,只有activity_type为m_coupon时有效
                "end_time_day": 0,  // 结果时间,以天为单位
                "condition": [  // 使用条件
                    {
                        "discount_type": "amount",  // 折扣类型,amount现金,percent打几折,free_shipping_fee免运费
                        "limit_amount": 100,  // 满足使用条件金额,没有条件金额,值为0
                        "discount_value": 1  // 折扣值,amount对应现金金额,percent对应打折数,free_shipping_fee为0
                    }
                ],
                "discount_amount": 1 // 计算后的折扣实际金额,(单位:分)
            },
            "shop_id": 7,  // 店铺ID
            "type": "m_coupon",  // 类型
            "type_txt": "优惠券/优惠码"  // 类型说明
        }
    ]
}

快递公司列表

请求参数 描述

shipper_name

optional, string
快递公司名称

定义

GET /api/v1/cfg/shipper/query

返回示例

{
    "code": 0,
    "msg": "成功",
    "data": [
        {
            "shipper_code": "AJ",
            "logis_id": 371,
            "shipper_name": "安捷快递"
        }
    ]
}

发货

请求参数 描述

order_id

string
订单ID

shipper_code

string
快递公司编号

shipper_name

string
快递公司名称

tracking_no

string
快递单号

定义

POST /api/v1/order/send/create

返回示例

{
    "code": 0,
    "msg": "成功"
}

售后订单列表

请求参数 描述

search_key

optional, string
搜索关键字,含apply_id, order_id

refund_type

optional, int
售后类型,1为退款,2为退货退款,3为换货

apply_status

optional, int
申请状态,1为未审核,2为通过审核,-1为拒绝

refund_status

optional, int
退款状态,0等待退款,1为正在退款中,2为已完成退款, -1为退款失败

page_index

optional, int
页码

page_size

optional, int
每页条数

定义

GET /api/v1/order/refund/list/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "row_count": 9,  // 总条数
        "list": [
            {
                "buy_vol": 1,  // 购买数量
                "sku_id": "S00YJVLH2R",  // sku id
                "goods_name": "测试商品名称324324",  // 商品名称
                "refund_status": -1,  // 退款状态
                "order_id": "72018011917322705765",  // 订单ID
                "image": "http://imgcache1.qiniudn.com/bacc4cef-9b37-bff5-1c07-c910dc2b",  // sku图片地址
                "properties": [  // sku属性
                    {
                        "id": "cn00",
                        "value": {
                            "id": "cv00",
                            "name": "blue"
                        },
                        "name": "color"
                    },
                    {
                        "id": "cn01",
                        "value": {
                            "id": "cv01",
                            "name": "324"
                        },
                        "name": "size"
                    }
                ],
                "price": 1,  // 商品单价(单位:分)
                "bar_code": "",  // 自定义商品编码
                "create_time": "1516355090", // 售后申请时间
                "shop_id": 7,  // 店铺ID
                "apply_id": "201801191744445774455792376140",  // 售后申请ID
                "apply_reason_id": 1,  // 售后申请原因ID
                "apply_remark": "",  // 售后申请备注
                "apply_status": 1,  // 售后申请状态, 1为未审核,2为通过审核,-1为拒绝
                "refund_type": 1,  // 退款状态,0等待退款,1为正在退款中,2为已完成退款, -1为退款失败
                "buyer_id": "oL0cS0bXgTkRcI_yUEr9MW3Z1Fkc"  // 买家ID
            }
        ]
    }
}

售后详情

请求参数 描述

apply_id

string
售后订单ID

定义

GET /api/v1/order/refund/detail/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "sku_id": "S00YJVLH2R",  // sku id
        "refund_status": -1,  // 退款状态,0等待退款,1为正在退款中,2为已完成退款, -1为退款失败
        "approve_remark": "",  // 审核备注
        "image": "http://imgcache1.qiniudn.com/bacc4cef-9b37-bff5-1c07-c910dc2b",  // sku图片
        "refund_amount": 801,  // 退款金额(单位:分)
        "admin_id": -1,  // 管理员ID
        "create_time": "1516355090",  // 售后申请时间
        "approve_time": "",  // 售后审核时间
        "refund_status_text": "",  // 退款状态文本
        "apply_status": 1,  // 申请状态,1为未审核,2为通过审核,-1为拒绝
        "buy_vol": 1,  // 购买数量
        "apply_remark": "",  // 申请备注
        "refund_trade_no": "",  // 退款交易号
        "refund_type_text": "退款",  // 退款状态文本
        "refund_money": -1,  // 退款金额(废弃)(单位:分)
        "goods_name": "测试商品名称324324", // 商品名称
        "order_id": "72018011917322705765",  // 订单ID
        "price": 1,  // 单价(单位:分)
        "bar_code": "", // 自定义商品编码
        "apply_status_text": "审核中",  // 申请状态文本
        "refund_complete_time": "",  // 退款成功时间
        "properties": [  // sku属性
            {
                "id": "cn00",
                "value": {
                    "id": "cv00",
                    "name": "blue"
                },
                "name": "color"
            },
            {
                "id": "cn01",
                "value": {
                    "id": "cv01",
                    "name": "324"
                },
                "name": "size"
            }
        ],
        "shop_id": 7,  // 店铺id
        "apply_id": "201801191744445774455792376140", // 申请ID
        "apply_reason_id": 1,  // 申请原因ID
        "refund_type": 1,  // 售后类型,1为退款,2为退货退款,3为换货
        "buyer_id": "oL0cS0bXgTkRcI_yUEr9MW3Z1Fkc"  // 买家ID
    }
}

售后审核

请求参数 描述

apply_id

string
售后订单ID

apply_status

int
审核状态,2通过,-1拒绝

approve_money

int
审核退款金额

approve_remark

optional, string
审核备注

定义

POST /api/v1/order/refund/approve/create

返回示例

{
    "code": 0,
    "msg": "成功"
}

售后退款

请求参数 描述

apply_id

string
售后订单ID

定义

POST /api/v1/order/refund/refund_submit/create

返回示例

{
    "code": 0,
    "msg": "成功"
}

创建营销

请求参数 描述

name

string
营销名称

activity_type

string
营销类型 m_coupon 优惠券 full_cut 满减

start_time

string
开始时间

apply_to

json string
营销规则适用范围

condition

json string
营销规则使用条件及对应的折扣

description

optional, string
描述

end_time

optional, string
结束时间 end_time 与end_time_day 中必传一个

end_time_day

optional, int
结束时间天数 end_time 与end_time_day 中必传一个

discount_amount

optional, int
折扣金额,当activity_type为m_coupon时有效

stock

optional, int
库存,当activity_type为m_coupon时有效

limit_vol

optional, int
限领张数,当activity_type为m_coupon时有效

定义

POST /api/v1/plugins/promotion/create

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "last_id": 2
    }
}

修改营销

请求参数 描述

activity_id

int
营销ID

name

string
营销名称

activity_type

string
营销类型 m_coupon 优惠券 full_cut 满减

start_time

string
开始时间

apply_to

json string
营销规则适用范围

condition

json string
营销规则使用条件及对应的折扣

description

optional, string
描述

end_time

optional, string
结束时间 end_time 与end_time_day 中必传一个

end_time_day

optional, int
结束时间天数 end_time 与end_time_day 中必传一个

discount_amount

optional, int
折扣金额,当activity_type为m_coupon时有效

stock

optional, int
库存,当activity_type为m_coupon时有效

limit_vol

optional, int
限领张数,当activity_type为m_coupon时有效

定义

POST /api/v1/plugins/promotion/update

返回示例

{
    "msg": "成功",
    "code": 0
}

营销列表

请求参数 描述

activity_id

int
营销ID

activity_type

string
营销类型,m_coupon优惠券,full_cut满减

name

string
营销名称

定义

GET /api/v1/plugins/promotion/page/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "row_count": 21,  // 总条数
        "list": [
            {
                "stock": 19,  // 库存,只有当activity_type为m_coupon时有效
                "status": 2,  // 状态,
                "activity_id": 129,  //  活动ID
                "name": "3.14",  // 活动名称
                "discount_total_amount": 0,  // 总优惠金额(单位:分)
                "discount_amount": 12,  // 优惠金额, 只有当activity_type为m_coupon时有效(单位:分)
                "start_time": "1520956800",  // 开始时间
                "limit_vol": 1,  // 限领数量,只有当activity_type为m_coupon时有效
                "use_count": 0, // 使用次数
                "shop_id": 7,  // 店铺ID
                "end_time": "1521388800",  // 结束时间
                "apply_to": [  // 适用范围
                    {
                        "scope_type": "all",  // 范围类型,all所有商品,some_goods部分商品,category指定分类,group指定分组
                        "scope_value": [  // 范围值,类型为all时,值为空,类型为some_goods时,值为goods_id,多个用,号创建,category和group同理
                            ""
                        ]
                    }
                ],
                "receive_count": 1,  // 领取次数
                "activity_type": "m_coupon",  // 活动类型,m_coupon优惠券,full_cut满购满减
                "end_time_day": 5,  // 结束时间,天数
                "condition": [  // 使用条件
                    {
                        "discount_type": "amount",  // 折扣类型,amount现金,percent打几折,free_shipping_fee免运费
                        "limit_amount": 100,  // 满足使用条件金额,没有条件金额,值为0
                        "discount_value": 1  // 折扣值,amount对应现金金额,percent对应打折数,free_shipping_fee为0
                    }
                ],
                "description": "白色情人节"  // 活动介绍
            }
        ]
    }
}

营销详情

请求参数 描述

activity_id

int
营销ID

定义

GET /api/v1/plugins/promotion/detail/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "stock": 0, // 库存,只有当activity_type为m_coupon时有效
        "status": "进行中",  // 状态
        "activity_id": 2,  // 活动ID
        "name": "测试修改2",  // 活动名称
        "discount_amount": 0,  // 优惠金额, 只有当activity_type为m_coupon时有效
        "start_time": "1515585600",  // 开始时间
        "limit_vol": 0,  // 限领数量,只有当activity_type为m_coupon时有效
        "shop_id": 7,  // 店铺ID
        "end_time": "1516190400",  // 结束时间
        "apply_to": [  // 适用范围
            {
                "scope_type": "all",  // 范围类型,all所有商品,some_goods部分商品,category指定分类,group指定分组
                "scope_value": [  // 范围值,类型为all时,值为空,类型为some_goods时,值为goods_id,多个用,号创建,category和group同理
                    ""
                ]
            }
        ],
        "activity_type": "full_cut",  // 活动类型, m_coupon优惠券,full_cut满购满减
        "end_time_day": 1,  // 结束时间,天数
        "condition": [  // 使用条件
            {
                "discount_type": "amount",  // 折扣类型,amount现金,percent打几折,free_shipping_fee免运费
                "limit_amount": 100,  // 满足使用条件金额,没有条件金额,值为0
                "discount_value": 1  // 折扣值,amount对应现金金额,percent对应打折数,free_shipping_fee为0
            }
        ],
        "description": "测试修改数据2"  // 活动介绍
    }
}

删除营销

请求参数 描述

activity_id

int
营销ID

定义

POST /api/v1/plugins/promotion/delete

返回示例

{
    "msg": "成功",
    "code": 0
}

收支明细

请求参数 描述

order_id

optional, string
订单ID或交易号

type

optional, int
交易类型,1是收入,2支付,3是提现

start_time

optional, string
明细产生的开始时间

end_time

optional, string
明细产生的结束时间

page_index

optional, int
页码

page_size

optional, int
每页条数

定义

GET /api/v1/fm/balance/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "row_count": 114,
        "list": [
            {
                "trade_no": "4200000066201801218203814894",  // 支付系统订单号
                "op_amount": 0,  // 金额(单位:分)
                "order_id": "72018012116190106200",  // 订单ID
                "create_time": "1516687529",  // 创建时间
                "shop_id": 7,  // 店铺ID
                "detail_id": 152,  // 编号
                "type": 1  // 类型,1订单收入,2为订单退款,  3为提现支出
            }
        ]
    }
}

明细合计

请求参数 描述

order_id

optional, string
订单ID或交易号

type

optional, int
交易类型,1是收入,2支付,3是提现

start_time

optional, string
明细产生的开始时间

end_time

optional, string
明细产生的结束时间

定义

GET /api/v1/fm/balance/count/query

返回示例

{
    "code": 0,
    "msg": "成功",
    "data": {
        "balance": 7,  // 余额(单位:分)
        "income": 1,  // 收入(单位:分)
        "out": 2  // 支出(单位:分)
    }
}

保存收款帐号

请求参数 描述

account_type

string
帐户类型,1支付宝,2银行卡

owner_name

string
帐户持有者姓名

account

string
银行或支付宝帐号

re_account

string
确认帐号

bank_type

optional, int
银行卡类型,1企业,2个人, account_type=2时必须

bank_name

optional, string
开户银行, account_type=2时必须

bank_province

optional, string
开户行所在省份, account_type=2时必须

bank_city

optional, string
开户行所在城市, account_type=2时必须

bank_branch_name

optional, string
开户行支行, account_type=2时必须

定义

POST /api/v1/fm/withdraw/account/create

返回示例

{
    "code": 0,
    "msg": "成功"
}

查询收款帐号

请求参数 描述

定义

GET /api/v1/fm/withdraw/account/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": [
        {
            "bank_province": "",  // 银行所在省, account_type为2(银行卡)时有效
            "bank_name": "",  // 银行名称, account_type为2(银行卡)时有效
            "account": "1245263511",  // 帐号
            "owner_name": "saddas",  // 持有者姓名
            "account_type": 2,  // 帐号类型, 1支付宝,2银行卡
            "bank_city": "",  // 银行所在城市, account_type为2(银行卡)时有效
            "bank_branch_name": "",  // 银行运行名称, account_type为2(银行卡)时有效
            "bank_type": 1,  // 银行卡所属类型, 1表示企业,2表示个人, account_type为2(银行卡)时有效
            "shop_id": 7,  // 店铺ID
            "create_time": "1512290248",  // 创建时间
            "is_use": 1  // 是否使用,1是,0否
        }
    ]
}

创建客户信息

请求参数 描述

name

string
客户姓名

mobile

string
客户手机

email

optional, string
客户邮箱

sex

optional, int
性别,1为男,2为女,-1为未知,默认为-1

birthday

optional, string
生日

origin

optional, int
顾客信息来源,1为购买商品,2为手工录入,3为批量导入

remark

optional, string
备注信息

tag

optional, string
标签,多个标签之间用逗号隔开

shipping_address

optional, json string
收货地址

定义

POST /api/v1/crm/customer/create

返回示例

{
    "code": 0,
    "msg": "成功"
}

修改客户信息

请求参数 描述

customer_id

string
客户ID

name

string
客户姓名

mobile

string
客户手机

email

optional, string
客户邮箱

sex

optional, int
性别,1为男,2为女,-1为未知,默认为-1

birthday

optional, string
生日

origin

optional, int
顾客信息来源,1为购买商品,2为手工录入,3为批量导入

remark

optional, string
备注信息

tag

optional, string
标签,多个标签之间用逗号隔开

shipping_address

optional, json string
收货地址

定义

POST /api/v1/crm/customer/update

返回示例

{
    "code": 0,
    "msg": "成功"
}

客户列表

请求参数 描述

search_key

optional, string
搜索关键字 name 或mobile

filter_data

optional, json string
自定义搜索条件

order_by

optional, string
排序方式 (字段 排序方式) order_count, order_amount, last_order_time eg:order_count desc(订单数 降序)

page_index

optional, int
页码

page_size

optional, int
每页数量
filter_data参数 描述

filter_type

string
适用范围类型预设值, order_time、order_count、order_amount、buy_count、tag、customer

filter_symbol

string
过滤符号,=,>,<,>=,<=,!=

filter_value

string
过滤值,可以是实际值,也可以是一个字符串表述。当filter_type 为customer时,new(新顾客),older(老顾客) 当filter_type为order_time时,filter_value可以有的值为:last_week(最近一周), last_month(最近一月),last_3_month(最近三月),last_year(最近一年),2018-02-26|2018-02-28(自定义时间)

定义

GET /api/v1/crm/customer/page/query

返回示例

{
    "code": 0,
    "msg": "成功",
    "data": {
        "row_count": 100, // 总条数
        "list": [
            {
                "customer_id": 10086,  // 客户ID
                "name": "张三",  // 客户姓名
                "mobile": "18602337250",  // 电话
                "order_count": 100,  // 成交订单数
                "order_amount": 100,  // 成交金额(单位:分)
                "origin": "购买",  // 客户来源, 1为购买商品,2为手工录入,3为批量导入
                "last_order_time": "2018-02-22 00:00:00"  // 最后创建订单时间
            }
        ]
    }
}

客户详情

请求参数 描述

customer_id

string
客户ID

定义

GET /api/v1/crm/customer/detail/query

返回示例

{
    "code": 0,
    "msg": "成功",
    "data": {
        "name": "张三",  // 客户姓名
        "wechat_nickname": "微信昵称", // 微信昵称
        "wechat_id": "微信id",  // 微信ID
        "mobile": "18602337250", // 电话
        "email": "onlyfu@wemart.cn",  // 邮箱
        "remark": "备注说明", // 备注
        "sex": 1, // 性别,1为男,2为女,-1为未知,默认为-1
        "birthday": "2018-02-22",  // 生日
        "order_amount": 100,  // 成交订单金额(单位:分)
        "order_count": 100, // 成交订单数
        "order_refund_amount": 100,  // 合计退款金额(单位:分)
        "order_refund_count": 100,  // 合计退款订单数
        "last_order_time": "5分钟前",  // 最后下单时间
        "last_order_origin": "微信",  // 最后订单来源
        "tags": [  // 标签
            "vip"
        ],
        "shipping_address": {  // 收货地址
            "province": "吉林省",
            "city": "通化市",
            "city_no": 55,
            "street": "123321",
            "name": "qwer_8",
            "district": "通化县",
            "mobile": "18103761376",
            "zip_code": ""
        }
    }
}

删除客户

请求参数 描述

customer_id

json string
客户ID, list

定义

POST /api/v1/crm/customer/delete

返回示例

{
    "code": 0,
    "msg": "成功"
}

客户最近订单

请求参数 描述

name

string
客户名称

定义

GET /api/v1/crm/customer/last_order/query

返回示例

{
    "code": 0,
    "msg": "成功",
    "data": {
        "order_id": "",  // 订单ID
        "parent_order_id": "",  // 父订单ID
        "create_time": "",  // 订单创建时间
        "status": 2,  // 订单状态
        "pay_amount": 1,  // 实付金额(单位:分)
        "sku_list": [  // sku列表
            {
                "parent_order_id": "P72018011918222005809",
                "buy_vol": 1,  // 购买数量
                "sku_id": "S00OVKU6QY",  // sku id
                "goods_id": "G004M3MAF4",  // 商品ID
                "goods_name": "测试商品",  // 商品名称
                "order_id": "72018011918222005818",
                "price": 1,  // 单价(单位:分)
                "properties": [  // sku属性
                    {
                        "id": "cn00",
                        "value": {
                            "id": "cv00",
                            "name": "红色"
                        },
                        "name": "颜色"
                    },
                    {
                        "id": "cn01",
                        "value": {
                            "id": "cv11",
                            "name": "m"
                        },
                        "name": "尺码"
                    }
                ],
                "image": "http://imgcache1.qiniudn.com/6ec1a050-93ac-e27c-a60c-5b4744b2"  // sku图片地址
            }
        ]
    }
}

创建检索过滤条件

请求参数 描述

name

string
自定义搜索名称

filter_data

json string
过滤条件
filter_data参数 描述

filter_type

string
适用范围类型预设值, order_time、order_count、order_amount、buy_count、tag、customer

filter_symbol

string
过滤符号,=,>,<,>=,<=,!=

filter_value

string
过滤值,可以是实际值,也可以是一个字符串表述。 当filter_type 为customer时,new(新顾客),older(老顾客) 当filter_type为order_time时,filter_value可以有的值为:last_week(最近一周),last_month(最近一月),last_3_month(最近三月),last_year(最近一年),2018-02-26|2018-02-28(自定义时间)

定义

POST /api/v1/crm/customer/search/create

返回示例

{
    "code": 0,
    "msg": "成功"
}

修改检索过滤条件

请求参数 描述

customer_id

int
条件id

name

string
自定义搜索名称

filter_data

json string
过滤条件
filter_data参数 描述

filter_type

string
适用范围类型预设值, order_time、order_count、order_amount、buy_count、tag、customer

filter_symbol

string
过滤符号,=,>,<,>=,<=,!=

filter_value

string
过滤值,可以是实际值,也可以是一个字符串表述。 当filter_type 为customer时,new(新顾客),older(老顾客) 当filter_type为order_time时,filter_value可以有的值为:last_week(最近一周),last_month(最近一月),last_3_month(最近三月),last_year(最近一年),2018-02-26|2018-02-28(自定义时间)

定义

POST /api/v1/crm/customer/search/create

返回示例

{
    "code": 0,
    "msg": "成功"
}

删除检索过滤条件

请求参数 描述

condition_id

int
条件id

定义

POST /api/v1/crm/customer/search/create

返回示例

{
    "code": 0,
    "msg": "成功"
}

检索过滤条件列表

请求参数 描述

定义

GET /api/v1/crm/customer/search/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": [
        {
            "name": "修改",  // 过滤条件名称
            "filter_value": "vip",  // 值
            "filter_type": "tag",  // 类型
            "shop_id": 7,  // 店铺ID
            "create_time": "1519696532",  // 创建时间
            "filter_symbol": "=",  // 符号
            "condition_id": 2  // 条件ID
        }
    ]
}

创建客户标签

请求参数 描述

customer_id

json list string
客户id, ['xxx']

tag

json list string
标签,['xxx']

定义

POST /api/v1/crm/customer/tag/create

返回示例

{
    "code": 0,
    "msg": "成功"
}

删除客户标签

请求参数 描述

customer_id

json list string
客户id, ['xxx']

tag_id

json list string
标签ID,['xxx']

定义

POST /api/v1/crm/customer/tag/delete

返回示例

{
    "code": 0,
    "msg": "成功"
}

所有客户标签列表

请求参数 描述

定义

GET /api/v1/crm/customer/tag/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": [
        {
            "name": "false",  // 标签名称
            "tag_id": "ac351fa3d25e2c43e32929e478b45ba3"  // 标签ID
        }
    ]
}

客户标签列表

请求参数 描述

定义

GET /api/v1/crm/customer/tag/customer/query

返回示例

{
    "code": 0,
    "msg": "成功",
    "data": "data": [
        {
            "name": "vip",
            "tag_id": "0dad95f2066cd3dbe61f9e744aa54540"
        }
    ]
}

首页数据

请求参数 描述

scene_type

int
场景类型,1为小程序,0为h5

定义

GET /api/v1/dm/theme_page/homepage/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "last_update_time": "1520843069",
        "auto_id": 4195,
        "is_home_page": 1,
        "component_data": [
            {
                "comp_id": 30,
                "comp_content": {
                    "overlay": "4.284",
                    "auto": true,
                    "module": [
                        {
                            "action_2": "购买",
                            "text": "若山顶的云雾",
                            "action_1": "浏览",
                            "imgUrl": "http://7fvdme.com1.z0.glb.clouddn.com/3aeb7e89-e76a-7d4e-3b7a-f33b7e30",
                            "title": "樱花"
                        },
                        {
                            "action_2": "购买",
                            "text": "若山顶的云雾",
                            "action_1": "浏览",
                            "imgUrl": "http://7fvdme.com1.z0.glb.clouddn.com/3aeb7e89-e76a-7d4e-3b7a-f33b7e30",
                            "title": "樱花"
                        }
                    ],
                    "timeout": "5",
                    "position": "center center",
                    "margin": "4.284"
                },
                "comp_type": 4,
                "componentKey": "componenta0b19f56-3703-728a-9e65-4d56ea124864",
                "comp_name": "首焦轮播图片2",
                "create_time": "1498199719",
                "comp_key": "hero_image_slider_2",
                "theme_id": 0,
                "page_id": 0,
                "comp_image": "http://imgcache1.qiniudn.com/9873b56f-9ea5-c2b6-49a2-1210925e",
                "scene_type": 1
            }
        ],
        "page.copy_theme_id": 196,
        "dom": "
", "create_time": "1518079520", "page.last_update_time": "1518079520", "copy_theme_id": 196, "shop_id": 7, "page_name": "这是首页", "publish_theme_id": 518, "scene_type": 1, "page_id": "PG005NKLEQ", "page.shop_id": 7 } }

初始化模板

请求参数 描述

scene_type

int
场景类型,1为小程序,0为h5

定义

POST /api/v1/dm/theme_page/init/create

返回示例

{
    "code": 0,
    "msg": "成功"
}

提交微信审核

请求参数 描述

定义

POST /api/v1/plugins/mini_app/auth/publish/create

返回示例

{
    "code": 0,
    "msg": "成功"
}

审核状态

请求参数 描述

定义

GET /api/v1/plugins/mini_app/auth/publish/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "status": 2,
        "auditid": 431319647,
        "audit_time": 1521796156,
        "errcode": 0,
        "errmsg": "ok"
    }
}

发布上线

请求参数 描述

定义

POST /api/v1/plugins/mini_app/auth/online/create

返回示例

{
    "code": 0,
    "msg": "成功"
}

获取小程序二维码

请求参数 描述

定义

GET /api/v1/plugins/mini_app/auth/qrcode/query

返回示例

图片数据

创建页面

请求参数 描述

copy_theme_id

int
模板副本id

page_name

string
页面名字

page_index

optional, int
页面顺序

component_data

json list string
页面组件数据

dom

string
基础DOM

定义

POST /api/v1/dm/theme_page/create

返回示例

{
    "msg": "成功",
    "code": 0
}

修改页面

请求参数 描述

page_id

int
页面id

copy_theme_id

int
模板副本id

page_name

string
页面名字

page_index

optional, int
页面顺序

component_data

json list string
页面组件数据

dom

string
基础DOM

定义

POST /api/v1/dm/theme_page/save/create

返回示例

{
    "msg": "成功",
    "code": 0
}

删除页面

请求参数 描述

page_id

int
页面id

copy_theme_id

int
模板副本id

定义

POST /api/v1/dm/theme_page/delete

返回示例

{
    "msg": "成功",
    "code": 0
}

页面重命名

请求参数 描述

page_id

int
页面id

copy_theme_id

int
模板副本id

page_name

string
页面名称

定义

POST /api/v1/dm/theme_page/rename/create

返回示例

{
    "msg": "成功",
    "code": 0
}

设置主页

请求参数 描述

page_id

int
页面id

copy_theme_id

int
模板副本id

scene_type

int
场景类型,0为商城,1为小程序

定义

POST /api/v1/dm/theme_page/homepage/update

返回示例

{
    "msg": "成功",
    "code": 0
}

默认组件列表

请求参数 描述

定义

GET /api/v1/cfg/dm/component/query

返回示例

{
    "msg": "成功",
    "code": 0
}

创建导航

请求参数 描述

copy_theme_id

int
主题副本ID

nav_data

json dict string
导航页面信息

定义

POST /api/v1/dm/navigation/create

返回示例

{
    "msg": "成功",
    "code": 0
}

修改导航

请求参数 描述

copy_theme_id

int
主题副本ID

nav_data

json dict string
导航页面信息

定义

POST /api/v1/dm/navigation/update

返回示例

{
    "msg": "成功",
    "code": 0
}

删除导航

请求参数 描述

copy_theme_id

int
主题副本ID

定义

POST /api/v1/dm/navigation/delete

返回示例

{
    "msg": "成功",
    "code": 0
}

导航列表

请求参数 描述

copy_theme_id

optional, int
主题副本ID

page_index

optional, int
页码

page_size

optional, int
每页数量

定义

GET /api/v1/dm/navigation/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "row_count": 1,
        "list": [
            {
                "last_update_time": "1513583925",
                "copy_theme_id": 1,
                "shop_id": 97,
                "create_time": "1513582029",
                "nav_data": [
                    {
                        "url": "/index",
                        "name": "首页",
                        "child": [
                            {
                                "url": "/woman",
                                "name": "女装区",
                                "child": []
                            },
                            {
                                "url": "/man",
                                "name": "男装",
                                "child": []
                            }
                        ]
                    },
                    {
                        "url": "/other",
                        "name": "其他",
                        "child": []
                    }
                ]
            }
        ]
    }
}

创建管理员

请求参数 描述

nick_name

string
管理员昵称

group_id

int
管理员分组ID

account

string
管理员帐号

password

string
帐号密码

定义

POST /api/v1/user/admin/create

返回示例

{
    "msg": "成功",
    "code": 0
}

修改管理员

请求参数 描述

admin_id

int
管理员ID

nick_name

string
管理昵称

group_id

int
管理员分组ID

account

string
管理员帐号

password

string
帐号密码

定义

POST /api/v1/user/admin/update

返回示例

{
    "msg": "成功",
    "code": 0
}

管理员列表

请求参数 描述

search_key

optional, string
帐号关键字

page_index

optional, int
页码

page_sie

optional, int
每页条数

定义

GET /api/v1/user/admin/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "row_count": 2,
        "list": [
            {
                "qq_account": "",
                "status": 1,
                "account": "yuiitsu",
                "group_id": 1,
                "name": "三级",
                "nick_name": "yuiitsu",
                "company": "",
                "real_name": "",
                "create_time": "1512981909",
                "mobile_no": "",
                "admin_id": 164,
                "email_address": ""
            }
        ]
    }
}

管理员详情

请求参数 描述

admin_id

int
管理员ID

定义

GET /api/v1/user/admin/detail/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "qq_account": "",
        "status": 0,
        "account": "357503003@qq.com",
        "group_id": 9,
        "nick_name": "357503003",
        "company": "",
        "real_name": "",
        "group_name": "财务",
        "create_time": "1513064909",
        "mobile_no": "",
        "admin_id": 180,
        "email_address": ""
    }
}

删除管理员

请求参数 描述

admin_id

int
管理员ID

定义

POST /api/v1/user/admin/delete

返回示例

{
    "msg": "成功",
    "code": 0
}

冻结/解冻管理员

请求参数 描述

admin_id

int
管理员ID

定义

POST /api/v1/user/admin/freeze/update

返回示例

{
    "msg": "成功",
    "code": 0
}

创建管理员分组

请求参数 描述

name

string
分组名称

power

json list string
权限列表

定义

POST /api/v1/user/admin/group/create

返回示例

{
    "msg": "成功",
    "code": 0
}

修改管理员分组

请求参数 描述

group_id

string
分组名称

name

string
分组名称

power

json list string
权限列表

定义

POST /api/v1/user/admin/group/update

返回示例

{
    "msg": "成功",
    "code": 0
}

删除管理员分组

请求参数 描述

group_id

string
分组名称

定义

POST /api/v1/user/admin/group/delete

返回示例

{
    "msg": "成功",
    "code": 0
}

管理员分组列表

请求参数 描述

name

optional, string
分组名称关键字

page_index

optional, int
页码

page_size

optional, int
每页条数

定义

GET /api/v1/user/admin/group/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": {
        "row_count": 2,
        "list": [
            {
                "last_update_time": "1512369576",
                "name": "飞速",
                "power": "12",
                "shop_id": 7,
                "create_time": "1512369576",
                "group_id": 2
            },
            {
                "last_update_time": "1512372674",
                "name": "一级",
                "power": "32",
                "shop_id": 7,
                "create_time": "1512369126",
                "group_id": 1
            }
        ]
    }
}

权限树

请求参数 描述

定义

GET /api/v1/user/auth/power/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": [
        {
            "index": "1",
            "group": "0",
            "parent_id": 0,
            "path": "/goods/",
            "child": [
                {
                    "group": "0"
                    "index": "1"
                    "name": "商品管理"
                    "parent_id": "goods"
                    "path": "/goods/list"
                    "power_id": "list"
                }
            ],
            "power_id": 1,
            "name": "商品"
        }
    ]
}

管理员菜单

请求参数 描述

定义

GET /api/v1/user/auth/menu/query

返回示例

{
    "msg": "成功",
    "code": 0,
    "data": [
        {
            "index": "1",
            "group": "0",
            "parent_id": 0,
            "path": "/goods/",
            "child": [
                {
                    "group": "0"
                    "index": "1"
                    "name": "商品管理"
                    "parent_id": "goods"
                    "path": "/goods/list"
                    "power_id": "list"
                }
            ],
            "power_id": 1,
            "name": "商品"
        }
    ]
}