基本信息

Jshop

keinx(echo@keinx.com)

2018-01-18 03:52:29

2018-12-27 15:35:12

2019-01-03 14:21:58

Jshop接口文档

商品分类

1、获取一级分类

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/FmNyixHxNq.html
  • 获取一级商品分类

  • 字段键 字段值 备注说明
    method categories.gettopcat
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean) true和false
    msg 描述 字符串(string) 状态false的时候,msg会有错误描述
    data 数据 数组(array) 二维数组一条一条的分类信息
        └id 分类ID 数字(number)
        └name 分类名称 字符串(string)
        └sort 排序 数字(number) 数字越小排名越靠前
        └image_id 分类图片ID 字符串(string) 没有的时候是null

2、获取子分类

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/FQJJzHSSJg.html
  • 获取某个一级分类下的所有子分类

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    parent_id 父级分类ID 数字(number) placeholder="非必填"
    method 调用方法 字符串(string) categories.getchildcat
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean) true或false
    msg 描述 字符串(string) 状态false的时候,msg会有错误描述
    data 数据 数组(array) 二维数组一条一条的分类信息
        └id 分类ID 数字(number)
        └name 分类名称 字符串(string)
        └sort 排序 数字(number) 数字越小排名越靠前
        └image_id 分类图片ID 字符串(string) 没有的时候是null

3、获取全部分类

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/FzyQiNziye.html
  • 获取全部分类树状形式

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    method 调用方法 字符串(string) categories.getallcat
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean) true和false
    msg 描述 字符串(string) 状态false的时候,msg会有错误描述
    data 数据 数组(array) 多维数组一条一条的分类信息

公告

1、获取公告列表

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/FizmQyNyzW.html
  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    page 页码 数字(number) 1
    pageSize 每页数量 数字(number) 5
    order 排序方法 字符串(string) id
    orderType 升序降序 字符串(string) desc
    method 调用方法 字符串(string) notice.noticeList
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean)
    msg 接口描述信息 字符串(string)
    data 数据 数组(array)
        └id 公告id 数字(number)
        └title 公告标题 字符串(string)
        └ctime 创建时间 数字(number)

2、获取公告内容

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/FNSNSxxJyU.html
  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    id 公告id 数字(number) placeholder="必填"
    method 调用方法 字符串(string) notice.noticeInfo
  • 字段别名 字段含义 字段类型 备注说明
    status 状态码 布尔型(boolean)
    msg 接口状态描述 字符串(string)
    data 数据 数组(array)
        └id 公告id 数字(number)
        └title 公告标题 字符串(string)
        └content 公告详情 字符串(string)
        └ctime 公告创建时间 数字(number)

商品

1、商品列表

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/FQNHyNJJHP.html
  • 获取商品列表接口

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    field 需要查询商品的字段 字符串(string) * 默认显示全部,自动查询出相关货品信息
    where 查询条件 字符串(string) {"marketable": 查询条件,数组形式,例如:where={"marketable": 1}
    page 当前页码 数字(number) 1 第几页
    limit 每页多少条数据 字符串(string) 10 每页多少条数据
    order 排序 字符串(string) id 只能用字符串形式排序,排序字段不可随意指定
    method 方法名 字符串(string) goods.getlist
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean) true为成功,false为失败
    msg 消息内容 字符串(string)
    data 返回数据 数组(array)
        └list 数据列表 数组(array)
            └id 商品ID 数字(number) 商品ID
            └bn 商品编码 字符串(string) 商品编码
            └name 商品名称 字符串(string) 商品名称
            └brief 商品简介 字符串(string)
            └price 销售价 浮点型(float) 2位小数
            └costprice 成本价 字符串(string)
            └image_id 默认图ID 字符串(string) 32位
            └goods_cat_id 商品分类ID 数字(number)
            └goods_type_id 商品类型ID 数字(number)
            └brand_id 品牌ID 数字(number)
            └is_nomal_virtual 是否虚拟商品 数字(number) 1普通商品,2虚拟商品
            └marketable 是否上架 字符串(string) 1=上架 2=下架
            └stock 库存 数字(number) 可销售总库存,下单时,总库存减一,冻结库存加1
            └freeze_stock 冻结库存 数字(number)
            └weight 商品重量 字符串(string) 商品重量
            └unit 商品单位 字符串(string)
            └intro 商品详情 字符串(string)
            └spes_desc 商品包含规格 字符串(string) 商品包含规格
            └comments_count 商品评论总数 数字(number)
            └view_count 浏览次数 数字(number)
            └buy_count 商品销量 字符串(string)
            └uptime 上架时间 字符串(string)
            └downtime 下架时间 字符串(string)
            └sort 排序id 数字(number)
            └ctime 创建时间 字符串(string)
            └utime 更新时间 字符串(string)
            └image_url 默认图相对路径 字符串(string)
            └products 商品货品信息 数组(array)
                └id 货品id 数字(number) 字段名:id
                └goods_id 商品id 数字(number)
                └barcode 货品条码 字符串(string)
                └sn 货品编码 字符串(string)
                └price 货品价格 浮点型(float)
                └costprice 货品成本价 字符串(string)
                └mktprice 货品市场价 字符串(string)
                └marketable 货品是否上架 数字(number) 值同商品上下架字段
                └stock 货品库存 数字(number) 库存机制同商品库存
                └freeze_stock 冻结库存 数字(number)
                └spes_desc 货品属性值 字符串(string)
                └is_defalut 是否默认货品 字符串(string) 是否默认货品 1=是 2=否,默认2
        └page 当前页码 数字(number)
        └limit 每页多少条数据 数字(number)
        └where 查询条件 字符串(string) 返回查询条件
        └order 返回排序条件 字符串(string)
        └total_page 总页数 数字(number)

2、商品详情

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lxxmyQzxVk.html
  • 具体字段参考商品列表接口

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    id 商品ID 数字(number) 1
    field 查询字段 字符串(string) *
    method 方法名 字符串(string) goods.getdetial
    token 用户登录后token 字符串(string) 用户登录后token,没有token时可以不传
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean) 1
    msg 消息 字符串(string) 查询成功
    data 数据 数组(array) ‘’
        └id 主键 数字(number) 9
        └bn 编码 字符串(string)
        └name 商品名称 字符串(string) 2018冷冬新款棉衣男士加肥加大码中长款棉服韩版潮流加厚棉袄外套
        └brief 商品简介 字符串(string) 品牌: 奢旺填充物: 仿丝棉货号: 之江A09--MY001基础风格: 青春流行上市年份季节: 2018年秋季厚薄: 常规材质成分: 聚酯纤维100%
        └price 商品销售价 浮点型(float) 300.00
        └costprice 商品成本价 浮点型(float) 320.00
        └mktprice 市场价 浮点型(float) 320.00
        └image_id 主图ID 字符串(string) 052d4af90ec88851c10982bf7fdfa763
        └goods_cat_id 分类id 数字(number) 3
        └goods_type_id 类型id 数字(number) 1
        └brand_id 品牌id 数字(number)
        └is_nomal_virtual 是否虚拟商品 数字(number) 1
        └marketable 上下架 数字(number) 1上架,2下架
        └stock 库存 数字(number) 500
        └freeze_stock 冻结库存 数字(number)
        └weight 商品重量 数字(number) 0.00
        └unit 商品单位 字符串(string)
        └intro 商品描述 字符串(string) 商品描述
        └spes_desc 规格信息 字符串(string) 规格信息
        └params 商品参数 字符串(string)
        └comments_count 总评论数 数字(number)
        └view_count 浏览量 数字(number)
        └buy_count 总销量 数字(number) 41
        └uptime 更新时间 数字(number) 1542536316
        └downtime 下架时间 数字(number) 1542536273
        └sort 排序 数字(number) 100
        └is_recommend 是否推荐 数字(number) 1
        └is_hot 是否热卖 数字(number) 1
        └label_ids 标签集合 数组(array) []
        └ctime 创建时间 字符串(string)
        └utime 更新时间 数字(number) 1544336335
        └isdel 删除标志 字符串(string)
        └brand_name 品牌名称 字符串(string)
        └cat_name 分类名称 字符串(string) 精选上衣
        └image_url 主图地址 字符串(string) https://b2c.jihainet.com/static/uploads/a4/cd/ec/5bc9a989cb351.jpg
        └product 货品列表 数组(array) 货品列表
            └id 主键 数字(number) 46
            └goods_id 商品id 数字(number) 9
            └barcode 货品条码 字符串(string)
            └sn 货品编码 数字(number) 23045242
            └price 销售价 数字(number) 300.00
            └costprice 成本价 数字(number) 320.00
            └mktprice 市场价 数字(number) 320.00
            └marketable 货品上下架状态 数字(number) 1
            └stock 货品库存 数字(number) 460
            └freeze_stock 冻结库存 数字(number) 27
            └spes_desc 货品描述 字符串(string)
            └is_defalut 是否默认 数字(number) 1
            └isdel 删除标志 字符串(string)
            └name 标题 字符串(string) 2018冷冬新款棉衣男士加肥加大码中长款棉服韩版潮流加厚棉袄外套
            └image_id 图片id 字符串(string) 052d4af90ec88851c10982bf7fdfa763
            └bn 编码 字符串(string)
            └image_path 图片地址 字符串(string) https://b2c.jihainet.com/static/uploads/a4/cd/ec/5bc9a989cb351.jpg
            └amount 总额 数字(number) 300.00
            └promotion_list 促销集合 数组(array) []
            └promotion_amount 优惠价格 数字(number)
        └album 商品相册 数组(array) 主图信息["https:\/\/b2c.jihainet.com\/static\/uploads\/a4\/cd\/ec\/5bc9a989cb351.jpg"]
        └isfav 是否收藏 布尔型(boolean) false

3、获取规格相关信息

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lQxxxiQHVP.html
  • 根据商品id,规格信息获取货品信息

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    id 商品id 字符串(string) 1
    spec 规格名称 字符串(string) 颜色:白色,尺寸:XL 颜色:白色,尺寸:XL 传如上数据,单规格时传:颜色:白色,多规格传颜色:白色,尺寸:XL
    method 调用方法 字符串(string) goods.getskudetial
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean)
    msg 消息 字符串(string)
    data 数据 数组(array)
        └id 货品id 字符串(string)
        └goods_id 商品id 字符串(string)
        └barcode 条码 字符串(string)
        └sn 货品编码 字符串(string)
        └price 货品销售价 字符串(string)
        └costprice 成本价 字符串(string)
        └mktprice 成本价 字符串(string)
        └marketable 上架状态 字符串(string)
        └stock 库存 字符串(string)
        └freeze_stock 冻结库存 字符串(string)
        └spes_desc 规格描述 字符串(string)
        └is_defalut 是否默认 字符串(string)

4、获取商品参数接口

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lzSSNNxzVX.html
  • 获取商品参数接口

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    id 商品id 数字(number) 1
    method 调用接口 字符串(string) goods.getgoodsparams
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean) 1
    msg 消息 字符串(string) 查询成功
    data 数据 数组(array) [{"name":"\u54c1\u724c","value":null}]
        └name 名称 字符串(string) 品牌
        └value 参数值 字符串(string)

5、根据货品id获取货品相关信息

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lNJzyJSNjV.html
  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    id 货品id 数字(number) 1
    method 调用方法 字符串(string) goods.getproductinfo
  • 字段别名 字段含义 字段类型 备注说明

6、获取商品评论

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lQixzmSzjU.html
  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    method 调用方法 字符串(string) goods.getgoodscomment
    goods_id 商品id 数字(number) 1 商品id
    page 页码 字符串(string) 1 获取第几页评论
    limit 每页多少条数据 字符串(string) 10
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean) 1
    msg 消息 字符串(string) 获取成功
    data 数据 数组(array) {"list":[{"id":17,"comment_id":0,"score":5,"order_id":15448389622865,"addon":null,"content":"2111","seller_content":null,"display":1,"ctime":1545120739,"user":{"mobile":"13058195480","sex":1,"birthday":"1970-01-01","avatar":"https:\/\/b2c.jihainet.co
        └list 字段标题 数组(array) [{"id":17,"comment_id":0,"score":5,"order_id":15448389622865,"addon":null,"content":"2111","seller_content":null,"display":1,"ctime":1545120739,"user":{"mobile":"13058195480","sex":1,"birthday":"1970-01-01","avatar":"https:\/\/b2c.jihainet.com\/stati
            └id 主键 数字(number) 17
            └comment_id 评论id 数字(number)
            └score 分数 数字(number) 5
            └order_id 订单号 数字(number) 15448389622865
            └addon 字段标题 字符串(string)
            └content 评论内容 字符串(string) 这是一条评论
            └seller_content 商家回复 字符串(string)
            └display 是否显示 数字(number) 1
            └ctime 创建时间 数字(number) 1545120739
            └user 用户信息 对象(object) {"mobile":"13058195480","sex":1,"birthday":"1970-01-01","avatar":"https:\/\/b2c.jihainet.com\/static\/uploads\/4d\/d7\/47\/5c00b6932f601.jpg","nickname":"","balance":"0.00","point":2,"pid":0}
                └mobile 手机号 数字(number) 13058195480
                └sex 性别 数字(number) 1男,2女
                └birthday 生日 字符串(string) 1970-01-01
                └avatar 头像 字符串(string) https://b2c.jihainet.com/static/uploads/4d/d7/47/5c00b6932f601.jpg
                └nickname 昵称 字符串(string)
                └balance 余额 数字(number) 0.00
                └point 积分 数字(number) 2
                └pid 邀请人id 数字(number)
        └count 总数 数字(number) 3
        └page 页码 数字(number) 1
        └limit 字段标题 数字(number) 5

7、商品浏览记录

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/limJQxNNjX.html
  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    method 调用方法 字符串(string) user.addgoodsbrowsing
    goods_id 商品id 字符串(string) 1
    token 登录用户token 字符串(string)
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean) 1
    data 数据 字符串(string)
    msg 消息 字符串(string)

品牌

1、品牌列表

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/FyiQiimiiX.html
  • 字段键 字段值 备注说明
    method brand.brandList
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    page 页码 数字(number) 1
    limit 每页数量 数字(number) 10
    order 排序 字符串(string) sort asc
    method 调用方法 字符串(string) brand.brandList
  • 字段别名 字段含义 字段类型 备注说明
    status 状态码 布尔型(boolean)
    msg 接口返回描述 字符串(string)
    data 数据 数组(array)
        └list 品牌列表 数组(array)
            └id 品牌id 数字(number)
            └name 品牌名 字符串(string)
            └logo 品牌logo 字符串(string)
            └sort 排序 数字(number)
        └count 数量 数字(number)

文章

1、文章分类列表

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lHiSJHmHVq.html
  • 获取文章分类列表信息

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    method 调用方法 字符串(string) articles.getArticleType
  • 字段别名 字段含义 字段类型 备注说明
    status 返回状态 布尔型(boolean) true 成功获取 false 没有数据 获取失败
    msg 返回信息说明 字符串(string) 返回信息说明
    data 返回结果集 数组(array) 以数组形式返回
        └list 分类列表 数组(array)
            └id 文章分类id 数字(number)
            └pid 上级父id 数字(number)
            └type_name 分类名称 字符串(string)
        └count 分类数量 数字(number)

2、文章列表

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lizJSSNiVg.html
  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    type_id 文章分类id 数字(number) 1 必须填写分类id
    page 当前页码 数字(number) 1 默认第一页
    limit 规定每页显示数量 数字(number) 10 默认每页返回10条数据
    method 调用方法 字符串(string) articles.getArticleList
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean) true 或 false
    msg 消息 字符串(string) 获取成功
    data 数据 数组(array) []
        └list 数据列表 数组(array) []
            └id 主键 数字(number) 6
            └title 名称 字符串(string)
            └cover 文章封面 字符串(string)
            └content 内容 字符串(string)
            └type_id 分类id 数字(number) 15
            └ctime 创建时间 数字(number) 1521873933
            └utime 更新时间 数字(number) 1532331024
            └sort 排序 数字(number) 100
        └count 总数量 数字(number) 3
        └page 页码 数字(number) 1
        └limit 每页条数 数字(number) 10

3、文章详情

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lxmiHiHxVe.html
  • 获取单个文章的详细信息

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    article_id 文章id 数字(number) 0
    method 调用方法 字符串(string) articles.getArticleDetail
  • 字段别名 字段含义 字段类型 备注说明
    status 状态码 布尔型(boolean) true获取成功 false获取失败
    msg 状态信息说明 字符串(string)
    data 数据结果集 数组(array)
        └id 文章id 数字(number)
        └title 文章标题 字符串(string)
        └content 文章内容 字符串(string)
        └type_id 文章分类id 数字(number)
        └ctime 文章创建时间 数字(number)
        └utime 文章更新时间 数字(number)

广告

1、广告位列表

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lmSHQyzmVV.html
  • 获取广告位列表

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    page 当前页码 数字(number) 1 非必填 默认第1页
    limit 每页显示数量 数字(number) 5 非必填 默认每页5条数据
    method 调用方法 字符串(string) advert.positionList
  • 字段别名 字段含义 字段类型 备注说明
    status 返回状态 布尔型(boolean) true查询成功 false没有数据
    msg 返回文字状态说明信息 字符串(string) 返回文字状态说明信息
    data 数据结果集 数组(array) 数据结果集
        └list 结果集 数组(array) 广告位id
            └id 广告位id 数字(number)
            └name 广告位名称 字符串(string)
            └code 广告模板编码 字符串(string)
        └count 获取数量 字符串(string)

2、广告列表

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lyJQmzmyVj.html
  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    code 广告模板编码 字符串(string) 必须 长度12-20 广告模板编码
    page 当前第几页 数字(number) 1 非必填 默认第一页
    limit 每页显示数量 数字(number) 5 非必填 默认每页5条数据
    method 调用方法 字符串(string) advert.getAdvertList
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean) true 或 false
    msg 消息 字符串(string) 获取成功
    data 数据 数组(array) []
        └list 列表 数组(array) []
            └id 广告id 数字(number) 10000
            └position_id 广告位id 数字(number) 10000
            └code 广告编码 字符串(string)
            └name 广告名称 字符串(string)
            └img 广告图片 字符串(string)
            └type 类型 数字(number) 1
            └val 广告地址 字符串(string)
            └sort 排序 数字(number) 100
        └count 字段标题 数字(number) 5

优惠卷

1、优惠卷列表

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lmNmzNHmVW.html
  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    method 调用方法 字符串(string) coupon.couponlist
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean)
    msg 请求状态描述 字符串(string)
    data 数据 数组(array)
        └id 优惠券id 数字(number)
        └name 优惠券名称 字符串(string)
        └status 1可领取 2不可以 数字(number)
        └exclusive 是否排他 1否 2是 数字(number)
        └stime 开始时间 数字(number)
        └etime 结束时间 数字(number)

2、优惠卷详情

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lyHHJSQyVU.html
  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    promotion_id 促销id 数字(number)
    method 调用函数 字符串(string) coupon.coupondetail
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean)
    msg 接口描述 字符串(string)
    data 数据 数组(array)
        └id 优惠券id 数字(number)
        └name 优惠券名称 字符串(string)
        └type (请忽略此参数) 数字(number)
        └status 优惠券是否启用1启用 2未启用 数字(number)
        └exclusive 是否排他 1否 2是 数字(number)
        └stime 开始时间 数字(number)
        └etime 结束时间 数字(number)

3、我领取的优惠券

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lSyJzxSSjk.html
  • 获取对应商户 我的优惠券信息 (多条)

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    token 用户id 字符串(string)
    promotion_id 促销id 数字(number) "非必填"
    display all显示全部 no_used没有使用过的 yes_used使用过的 字符串(string) "非必填"
    method 调用方法 字符串(string) coupon.usercoupon
  • 字段别名 字段含义 字段类型 备注说明
    status 返回状态 布尔型(boolean) true获取成功 false获取失败
    msg 返回状态说明 字符串(string)
    data 返回结果集 数组 数组(array)
        └coupon_code 优惠券码 字符串(string)
        └promotion_id 促销id 数字(number)
        └is_used 是否使用 1未 2是 数字(number)
        └user_id 领取用户id 数字(number)
        └used_id 使用用户id 数字(number)
        └ctime 创建时间 数字(number)
        └utime 更新时间 数字(number)
        └name 优惠券名称 字符串(string)
        └stime 开始时间 数字(number)
        └etime 结束时间 数字(number)
        └status 是否可用 数字(number)
        └overdue 是否已过期 布尔型(boolean)

4、领取优惠券

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lmHQJHHzjW.html
  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    token 用户id 数字(number) 0
    promotion_id 促销id 数字(number)
    method 调用方法 字符串(string) coupon.getcoupon
  • 字段别名 字段含义 字段类型 备注说明
    status 返回状态 布尔型(boolean) false领取失败 true领取成功
    msg 返回状态说明 字符串(string) 返回状态说明
    data 数据 数组(array)

5、输入券号领取优惠券

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lyxSNJimjP.html
  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    key 优惠券号码 字符串(string) "必填"
    method 调用方法 字符串(string) coupon.getcouponkey
  • 字段别名 字段含义 字段类型 备注说明
    status 领取状态 布尔型(boolean)
    msg 领取描述 字符串(string)
    data 数据 数组(array)

用户

1、用户账号(手机号码)密码登陆

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lJiNQmyJjj.html
  • 用户账号登陆

  • 字段键 字段值 备注说明
    method user.login 接口名称
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    mobile 手机号码 数字(number) 用户登陆的手机号码
    password 密码 字符串(string) 密码
  • 字段别名 字段含义 字段类型 备注说明
    status 类型 布尔型(boolean) 状态位
    data 用户token的值 字符串(string) 用户token的值
    msg 返回信息 字符串(string) 如果status为真的话,这个字段可能为空,如果为假的话,是错误的描述

2、手机短信登陆

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lQQzHNQJjq.html
  • 用户手机短信登陆

  • 字段键 字段值 备注说明
    method user.smslogin 用户手机短信登陆,登陆之前需获取短信验证码
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    mobile 手机号码 数字(number) 手机号码
    code 短信验证码 字符串(string) 手机上面收到的短信验证码
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean)
    msg 消息 字符串(string)
    data token的值 字符串(string) 登陆成功过后token的值

3、注册登录发送短信接口

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lzNxiyJzjg.html
  • 字段键 字段值 备注说明
    method user.sms
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    mobile 手机号码 数字(number)
    type 类型 数字(number) 1用户注册,2用户登陆,3商户申请入驻
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean)
    msg 消息 字符串(string)

4、退出

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lSHySziSje.html
  • 字段键 字段值 备注说明
    method user.logout
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    token 用户的token 字符串(string)
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean)
    msg 消息 字符串(string)

5、小程序端登陆步骤1接口

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lzzyJQySqU.html
  • 此接口会去取用户的session_key,并更新。

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    method 接口名称 字符串(string) user.wxapplogin1
    code code 字符串(string) 011arp3B0YtRnh2KnC4B0npF3B0arp32
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean) 1
    data 数据 字符串(string) user_wx表id
    msg 消息 字符串(string)

6、小程序端登陆步骤2接口

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lHSJimzyqP.html
  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    method 接口名称 字符串(string) user.wxapplogin2
    edata 加密字符串 字符串(string) rwNXkZa0lIvcuUW1nsCqSVF8EuZSPLXpU5Igr5sAV6aY8KbwUnikrXL+wKZuQrg3cdtK+EXEoo9LmuZg8fLWNlMuOzz1pdUi7aKo9pb+FnExAqiBLADDQ+BTtIJtjKhA89z8aEKlM5cP3mlS++Q1G5ipRcXthfPP7kOEp1lHABnXhP98Tzk7Rzkp5nIeUFWgRyDOnuOLqADR1E48Qa3TM0UHw7wP3yXJDnh83Bgd0IR9QJDkgGutm+Xbp5 值参见小程序端getUserInfo接口
    iv 解密向量 字符串(string) 3Gxo7axFPmsSyIc6PUfI4w== 参见小程序端getUserInfo接口
    open_id user_wx_id 字符串(string) 199 根据此值去user_wx表取session_key
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean) 1
    data 数据 数组(array) {"token":"05b3725ba7356ed35b48629f9a15e1c5"}
        └token token 字符串(string) 当登陆成功的时候,有此字段,在本地保存token即可,如果是没有绑定用户信息,那么会有user_wx_id而没有此值。
        └user_wx_id suer_wx的id 字符串(string) 当此微信没有绑定用户的时候,会返回此信息,需要在前台绑定用户。
    msg 消息 字符串(string)

支付&支付单

1、支付方式列表

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lNyixHxNqk.html
  • 获取所有可用的支付方式。

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    method 接口名称 字符串(string) payments.getlist
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean) 1
    data 数据 数组(array)
        └code 支付方式编码 字符串(string) offline
        └name 支付方式名称 字符串(string) 线下支付
        └sort 排序 数字(number) 100
        └memo 支付描述 字符串(string) 联系客服进行线下付款
        └status 状态 数字(number) 是否启用,1启用,2停用,默认1启用。
        └is_online 线上线下付款状态 数字(number) 1线上支付方式,2线下支付方式
    msg 消息 字符串(string)

2、获取支付单详情接口

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lQHzyzJHqV.html
  • 获取支付单详情接口,需要登陆

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    method 接口名称 字符串(string) payments.getinfo
    payment_id 支付单号 字符串(string)
    token token 字符串(string)
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean) 1
    data 数据 数组(array)
        └payment_id 支付单号 数字(number) 25379565570403
        └money 支付金额 数字(number) 0.10
        └user_id 用户ID 数字(number) 1
        └type 支付单类型 数字(number) 支付单类型:1订单,2充值单
        └status 状态 数字(number) 支付状态:1未支付,2支付成功,3其他
        └payment_code 支付方式编码 字符串(string) alipay
        └ip 支付者IP 字符串(string) 223.88.55.117
        └params 支付的时候,传的参数 字符串(string)
        └payed_msg 支付状态描述(支付平台回传) 字符串(string) TRADE_SUCCESS
        └trade_no 支付平台交易流水号 数字(number) 2018092622001468620510153657
        └ctime 创建时间 数字(number) 1537956557
        └utime 更新时间 数字(number) 1537956557
        └rel 支付单详情 数组(array) [{"payment_id":"25379565570403","source_id":"15379534034009","money":"0.10"}]
            └payment_id 支付单id 数字(number) 25379565570403
            └source_id 资源id 数字(number) 此值根据type的不同而关联不同的表
            └money 金额 数字(number) 0.10
    msg 消息 字符串(string)

3、支付接口

  • 测试环境(demo) https://b2c.jihainet.com/api.html
    模拟环境(mock) http://api.jihainet.com/mock/lyimiymHqj.html
  • 前台所有的支付都必须走此接口。

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    method 接口名称 字符串(string) user.pay
    ids 资源id 字符串(string) 12345,67890 可传多个值,用英文逗号分隔
    payment_code 支付方式编码 字符串(string) alipay 字典参见payments.getlist接口
    payment_type 支付类型 字符串(string) 1 支付类型,1订单,2充值单,根据此值的不同,ids的意义也不一样。当是1的时候,ids是订单号,当是2的时候,是用户id
    params 支付参数 字符串(string) 此值比较重要,是支付中需要用到的参数再次传递 微信支付-小程序支付:可以为空 微信支付公众号支付: trade_type:JSAPI_OFFICIAL 微信支付-h5端支付: trade_type:MWEB wap_url:h5端同步回调地址 当为充值单充值的时候,需要传money: money:0.1(充值金额)
  • 字段别名 字段含义 字段类型 备注说明
    status 状态 布尔型(boolean) 1
    data 数据 数组(array) 根据支付方式的不同,而返回不同的参数
    msg 消息 字符串(string)

通用接口

1、取省市区详细信息

  • 测试环境(demo) https://b2c.jihainet.com/api/common/area
    模拟环境(mock) http://api.jihainet.com/mock/lyzxNmxxqq.html
  • 获取省市区信息

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    id 地区编号 字符串(string) 0 省市区父节点id
  • 字段别名 字段含义 字段类型 备注说明
    list 读取信息 数组(array)
        └id 主键 数字(number) 110000
        └name 字段标题 字符串(string) 北京市
        └parent_id 字段标题 数字(number)

2、省市区取下级

  • 测试环境(demo) https://b2c.jihainet.com/api/common/areachildren
    模拟环境(mock) http://api.jihainet.com/mock/lNmHNNJxqg.html
  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    id 父节点id 字符串(string)
  • 字段别名 字段含义 字段类型 备注说明
    id id 数字(number) 110000
    parent_id 父节点id 数字(number)
    depth 深度 数字(number) 1
    name 名称 字符串(string) 北京市
    postal_code 。。 数字(number) 100000
    sort 排序 数字(number) 100

3、验证码

  • 测试环境(demo) https://b2c.jihainet.com/api/common/verify
    模拟环境(mock) http://api.jihainet.com/mock/lxJxQimxqe.html
  • 前台登陆失败次数太多,就会用到验证码了。

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    id 场景值 字符串(string) 1
  • 字段别名 字段含义 字段类型 备注说明

4、店铺配置

  • 测试环境(demo) https://b2c.jihainet.com/api/common/jshopconf
    模拟环境(mock) http://api.jihainet.com/mock/lJQSSyQSqW.html
  • 店铺的公开配置都取这个接口

  • 字段键 字段值 备注说明
  • 字段别名 字段含义 字段类型 是否必填 默认值 备注说明
  • 字段别名 字段含义 字段类型 备注说明

Copyright ©2016-2017 PHPRAP版权所有 由PHPRAP强力驱动