文档

测试

获取商城设计首页数据

websocket测试

POST

GetShopHomePage

接口描述

获取商城设计首页数据

请求参数

参数名

类型

描述

必填

dataJson

string

暂空（无用）-预留

必填

响应参数

参数名

类型

描述

必填

ret

number

0为成功，大于0为失败；示例：0

必填

msg

string

跟据错误编号，消息描述，示例：ok

必填

err_code

number

错误编号，示例：0

必填

data

array

数据列表类型对像数组 [ {navBar 导航组 } {imgSingle 图片}{imgWindow 图片分组} {imgSlide 图片轮播}{blank 辅助空白}{search 搜索框 } {video 视频组}{groupPurchase 拼团 } {goods 商品组 }]

必填

search 搜索框

参数名

类型

描述

必填

type

string

示例：search

必填

name

string

示例：搜索框

必填

value

object

数据字典

必填

style

string

搜索框样式【round:圆弧 radius:圆角 square:方形】示例：round

必填

keywords

string

搜索框内提示文本示例：请输入关键字

必填

blank 辅助空白

参数名

类型

描述

必填

type

string

示例：blank

必填

name

string

示例：辅助空白

必填

value

object

数据字典

必填

height

number

空白区高度示例：20

必填

background_color

string

空白区背景颜色示例：#FFFFFF

必填

video 视频组

参数名

类型

描述

必填

type

string

示例：video

必填

name

string

示例：视频组

必填

value

object

数据字典

必填

autoplay

boolean

是否自动播放示例：false

必填

list

array

数据列表

必填

image

string

视频封面示例：http://localhost:6020/Upload/home_page/home_123/product_1574067352.jpg

必填

url

string

视频地址示例：http://wxsnsdy.tc.qq.com/105/20210/snsdyvideodownload?filekey=30280201010421301f0201690402534804102ca905ce620b1241b726bc41dcff44e00204012882540400

必填

navBar 导航组

参数名

类型

描述

必填

type

string

示例：navBar

必填

name

string

示例：导航组

必填

value

object

数据字典

必填

limit

number

每行数量【3，4，5】示例：4

必填

list

array

数据列表

必填

text

string

导航按钮文字示例：我的订单

必填

image

string

导航按钮图标示例：http://localhost:6020/Upload/home_page/home_123/product_1574066956.jpg

必填

link_type

string

点击类型【url 链接 ,product 产品,spell_group_goods 拼团商品,forms 自定表单,product_class 产品分类,spell_group_class 拼团分类 ,live_plan 直播计划】示例：forms

必填

link_value

string

点击类型：url 时，为跳转链接, 示例：http://xxxxx

必填

link_value

int

点击类型：product 时，为产品ID, 示例：10002

必填

link_value

int

点击类型：spell_group_goods时，为拼团商品ID, 示例：8

必填

link_value

object

点击类型：forms 为数据字典

必填

is_login

boolean

是否需要登录示例：true

必填

name

string

表单类型示例：myOrder 注表单内容未确认，待确认，已确认【SpellGroupHomePage{团购主页}】

必填

type_name

string

表单类型名示例：我的订单

必填

link_value

int

点击类型：product_class 时，为产品分类ID, 示例：1

必填

link_value

int

点击类型：spell_group_class 时，为拼团分类ID, 示例：1

必填

link_value

int

点击类型：live_plan 时，为直播计划ID(也是直播间ID) , 示例：1

必填

imgSingle 图片

参数名

类型

描述

必填

type

string

示例：imgSingle

必填

name

string

示例：图片

必填

value

object

数据字典

必填

image

string

图片示例：http://localhost:6020/Upload/home_page/home_123/product_1574066956.jpg

必填

link_type

string

点击类型【url 链接 ,product 产品,spell_group_goods 拼团商品,forms 自定表单,product_class 产品分类,spell_group_class 拼团分类 ,live_plan 直播计划,wx_live 微信直播】示例：forms

必填

link_value

string

点击类型：url 时，为跳转链接, 示例：http://xxxxx

必填

link_value

int

点击类型：product 时，为产品ID, 示例：10002

必填

link_value

int

点击类型：spell_group_goods时，为拼团商品ID, 示例：8

必填

link_value

object

点击类型：forms 为数据字典

必填

is_login

boolean

是否需要登录示例：true

必填

name

string

表单类型示例：myOrder 注表单内容未确认，待确认，已确认【SpellGroupHomePage{团购主页}】

必填

type_name

string

表单类型名示例：我的订单

必填

link_value

int

点击类型：product_class 时，为产品分类ID, 示例：1

必填

link_value

int

点击类型：spell_group_class 时，为拼团分类ID, 示例：1

必填

link_value

int

点击类型：live_plan 时，为直播计划ID(也是直播间ID) , 示例：1

必填

link_value

int

点击类型：wx_live 时，为微信直播间ID(也房间号) , 示例：1

必填

imgWindow 图片分组

参数名

类型

描述

必填

type

string

示例：imgWindow

必填

name

string

示例：图片分组

必填

value

object

数据字典

必填

style

number

布局方式【0：1左3右， 2：1行2个，3：1行3个，4：1行4个】示例：0

必填

margin

number

图片间距示例：0

必填

list

array

数据列表

必填

image

string

图片示例：http://localhost:6020/Upload/home_page/home_123/product_1574066956.jpg

必填

link_type

string

必填

link_value

string

点击类型：url 时，为跳转链接, 示例：http://xxxxx

必填

link_value

int

点击类型：product 时，为产品ID, 示例：10002

必填

link_value

int

点击类型：spell_group_goods时，为拼团商品ID, 示例：8

必填

link_value

object

点击类型：forms 为数据字典

必填

is_login

boolean

是否需要登录示例：true

必填

name

string

表单类型示例：myOrder 注表单内容未确认，待确认

必填

type_name

string

表单类型名示例：我的订单

必填

link_value

int

点击类型：product_class 时，为产品分类ID, 示例：1

必填

link_value

int

点击类型：spell_group_class 时，为拼团分类ID, 示例：1

必填

link_value

int

点击类型：live_plan 时，为直播计划ID(也是直播间ID) , 示例：1

必填

width

int

宽度

必填

height

int

高度

必填

link_value

int

点击类型：wx_live 时，为微信直播间ID(也房间号) , 示例：1

必填

imgSlide 图片轮播

参数名

类型

描述

必填

type

string

示例：imgSlide

必填

name

string

示例：图片轮播

必填

value

object

数据字典

必填

duration

number

切换时间（毫秒）示例：2500

必填

list

array

数据列表

必填

image

string

图片示例：http://localhost:6020/Upload/home_page/home_123/product_1574066956.jpg

必填

link_type

string

必填

link_value

string

点击类型：url 时，为跳转链接, 示例：http://xxxxx

必填

link_value

int

点击类型：product 时，为产品ID, 示例：10002

必填

link_value

int

点击类型：spell_group_goods时，为拼团商品ID, 示例：8

必填

link_value

object

点击类型：forms 为数据字典

必填

is_login

boolean

是否需要登录示例：true

必填

name

string

表单类型示例：myOrder 注表单内容未确认，待确认，已确认【SpellGroupHomePage{团购主页}】

必填

type_name

string

表单类型名示例：我的订单

必填

link_value

int

点击类型：product_class 时，为产品分类ID, 示例：1

必填

link_value

int

点击类型：spell_group_class 时，为拼团分类ID, 示例：1

必填

link_value

int

点击类型：live_plan 时，为直播计划ID(也是直播间ID) , 示例：1

必填

link_value

int

点击类型：wx_live 时，为微信直播间ID(也房间号) , 示例：1

必填

groupPurchase 拼团

参数名

类型

描述

必填

type

string

示例：groupPurchase

必填

name

string

示例：拼团

必填

value

object

数据字典

必填

title

string

标题示例：拼团

必填

limit

number

显示数量可以不处理，这是服务器自动获取数据最大值示例：10 注：非总数量，只是显示最大数量

必填

list

array

数据列表

必填

number

拼团商品ID 示例：9

必填

price

number

拼团商品价格示例：80

必填

name

string

拼团商品名示例：七分裤

必填

image

string

拼团商品图片示例：http://localhost:6020/Upload/Product/10003/product_1570728082.jpg

必填

subtitle

string

拼团商品标题示例：甚至三厢一非顶不可在末枯要

必填

stime

string

开始时间示例：2019-10-27 14:33

必填

etime

string

结束时间示例：2019-11-30 00:00

必填

state

number

当前状态【1拼团中 2未开始 3已结束】示例：1

必填

goods 商品组

参数名

类型

描述

必填

type

string

示例：goods

必填

name

string

示例：商品组

必填

value

object

数据字典

必填

title

string

标题示例：热门

必填

limit

number

显示数量可以不处理，这是服务器自动获取数据最大值示例：10 注：非总数量，只是显示最大数量

必填

look_more

boolean

是否查看更多示例：false

必填

type

string

商品来源【auto 自动获取，choose 手动选择】示例：choose

必填

class_id

number

自动获取数据来源的分类ID ，0全部分类，大于0为指定分类ID 示例：0

必填

display

string

显示类型【list 列表平铺，slide 横向滚动】示例：slide

必填

column

number

分列数量【1单列 2两列 3三列】示例：3

必填

list

array

数据列表

必填

number

商品/产品ID 示例：10001

必填

price

number

价格示例：120

必填

name

string

商品名称示例：七分裤

必填

image

string

商品图片示例：http://localhost:6020/Upload/Product/10001/product_1563180572.jpg

必填

subtitle

string

商品副标题示例：三厢天下顶下奇正要

必填

market_price

number

商品市场价示例：120

必填

name

必填

说明 / 示例

{ "ret": 0, "msg": "ok", "err_code": 0, "data": [{ "type": "navBar", "name": "导航组", "value": { "limit": 4, "list": [{ "text": "我的订单", "image": "http://localhost:6020/Upload/home_page/home_123/product_1574066956.jpg", "link_type": "forms", "link_value": { "is_login": true, "name": "myOrder", "type_name": "我的订单" } }, { "text": "我的拼团", "image": "http://localhost:6020/Upload/home_page/home_123/product_1574066988.jpg", "link_type": "forms", "link_value": { "is_login": true, "name": "mySpellGroup", "type_name": "我的拼团" } }] } }, { "type": "imgSingle", "name": "图片", "value": { "image": "http://localhost:6020/Upload/home_page/home_123/product_1574067015.jpg", "link_type": "product", "link_value": 10002 } }, { "type": "search", "name": "搜索框", "value": { "style": "round", "keywords": "请输入关键字搜索" } }, { "type": "groupPurchase", "name": "拼团", "value": { "title": "拼团", "limit": 10, "list": [{ "id": 9, "price": 80.0, "name": "七分裤", "image": "http://localhost:6020/Upload/Product/10003/product_1570728082.jpg", "subtitle": "甚至三厢一非顶不可在末枯要", "stime": "2019-10-27 14:33", "etime": "2019-11-30 00:00", "state": 1 }] } }, { "type": "imgWindow", "name": "图片分组", "value": { "style": 0, "margin": 0, "list": [{ "image": "http://localhost:6020/Upload/home_page/home_123/product_1574067233.jpg", "link_type": "product", "link_value": 10001, "width": 800, "height": 604 }, { "image": "http://localhost:6020/Upload/home_page/home_123/product_1574067236.jpg", "link_type": "spell_group_goods", "link_value": 9, "width": 750, "height": 400 }, { "image": "http://localhost:6020/Upload/home_page/home_123/product_1574067239.jpg", "link_type": "product", "link_value": 10002, "width": 750, "height": 400 }, { "image": "http://localhost:6020/Upload/home_page/home_123/product_1574067243.jpg", "link_type": "product", "link_value": 10003, "width": 750, "height": 400 }] } }, { "type": "imgSlide", "name": "图片轮播", "value": { "duration": 2500, "list": [{ "image": "http://localhost:6020/Upload/home_page/home_123/product_1574067302.jpg", "link_type": "url", "link_value": "https://www.baidu.com/" }, { "image": "http://localhost:6020/Upload/home_page/home_123/product_1574067307.jpg", "link_type": "url", "link_value": "https://www.qq.com/" }] } }, { "type": "video", "name": "视频组", "value": { "autoplay": false, "list": [{ "image": "http://localhost:6020/Upload/home_page/home_123/product_1574067352.jpg", "url": "http://wxsnsdy.tc.qq.com/105/20210/snsdyvideodownload?filekey=30280201010421301f0201690402534804102ca905ce620b1241b726bc41dcff44e00204012882540400" }] } }, { "type": "blank", "name": "辅助空白", "value": { "height": 20, "background_color": "#FFFFFF" } }, { "type": "goods", "name": "商品组", "value": { "title": "热门", "limit": 10, "look_more": false, "type": "choose", "class_id": 0, "display": "slide", "column": 3, "list": [{ "id": 10001, "price": 120.0, "name": "七分裤", "image": "http://localhost:6020/Upload/Product/10001/product_1563180572.jpg", "subtitle": "三厢天下顶下奇正要", "market_price": 120.0 }, { "id": 10002, "price": 100.0, "name": "七分裤3", "image": "http://localhost:6020/Upload/Product/10002/product_1566290453.jpg", "subtitle": "亚硝酸", "market_price": 120.0 }, { "id": 10003, "price": 100.0, "name": "七分裤", "image": "http://localhost:6020/Upload/Product/10003/product_1570728082.jpg", "subtitle": "甚至三厢一非顶不可在末枯要", "market_price": 120.0 }] } }] }

上一篇获取商品信息

nextDoc 获取商品列表