goods/list.json

简介

获取商品列表

请求接口

请求方式

post

是否需要登录后才可使用

接口响应返回数据的格式

json

## 请求参数 | 参数名称 | 类型 | 示例值 | 必须 | 描述 | | ------------ | ------------ | ------------ | ------------ | ------------ | | storeid | int | 1 | 是 | 商铺编号,要获取的数据是属于哪个商铺的 | | typeid | int | 1 | 否 | 哪个分类的商品。如果不传,则是查询这个商店中所有的商品 | | title | String | 白菜 | 否 | 要搜索的商品名字,可模糊搜索。
比如搜索白菜,可以搜索白菜花、白菜叶、白菜根 | | orderBy | int | 1 | 否 | 返回商品列表的排序方式
0: 默认排序方式,也就是根据商家后台自定义的商品排序,来进行的排序
1: 按总销量由高往低来排序
2: 最新商品,按发布时间,由高往低来排序,最后发布的商品在最前面。
如果不传此参数,默认按照 0 进行排序 | | everyNumber | int | 15 | 否 | 每页显示多少条数据。取值 1~100,最大显示100条数据,若传入超过100,则只会返回100条。
若不传,默认显示15条 | | currentPage | int | 1 | 否 | 要获取第几页的列表数据,如要查看第2页,则这里传入 2。如果不传,默认获取第一页的 | | token | String | dff4214c-4eca-42b8-ad9c-b95afd6374c0 | 否 | 当前操作用户的唯一标识。可用 [login/getToken.json](19770.html) 获取 | ## 返回结果 #### 返回示例 ```` { "result": 1, "info": "成功", "list": [ { "id": 8, "title": "花生", "inventory": 10, "putaway": 1, "sale": 0, "units": "", "price": 300, "originalPrice": 800, "addtime": 1581986730, "storeid": 1, "typeid": 1, "titlepic": "http://www.xxxx.com/123.jpg ", "userBuyRestrict": 0 }, { "id": 9, "title": "土豆", "inventory": 500, "putaway": 1, "sale": 0, "units": "个", "price": 900, "originalPrice": 800, "addtime": 1581987167, "storeid": 1, "typeid": 1, "titlepic": "http://www.xxxx.com/123.jpg ", "userBuyRestrict": 0 } ], "page": { "limitStart": 4, "allRecordNumber": 8, "currentPageNumber": 3, "everyNumber": 2, "lastPageNumber": 4, "nextPage": "...", "upPage": "...", "lastPage": "...", "firstPage": "...", "haveNextPage": true, "haveUpPage": true, "currentLastPage": false, "currentFirstPage": false, "upPageNumber": 2, "nextPageNumber": 4, "upList": [ { "href": "...", "pageNumber": 1, "title": "1" }, { "href": "...", "pageNumber": 2, "title": "2" } ], "nextList": [ { "href": "...", "pageNumber": 4, "title": "4" } ] } } ```` #### 返回字段说明 | 参数名称 | 类型 | 示例值 | 描述 | | ------------ | ------------ | ------------ | ------------ | | result | int | 1 | 执行情况。
1:执行成功;
0:执行失败 | | info | String | success | 若result为0,这里返回失败的原因
若result为1,是执行成功,这里没有什么用 | | list | JSONArray | | 商品列表 | | page | JSONObject | | 分页信息 | ##### list 中每项的值说明 | 参数名称 | 类型 | 示例值 | 描述 | | ------------ | ------------ | ------------ | ------------ | | id | int | 1 | 商品的id编号 | | title | String | 猪肉 | 商品的名称 | | inventory | int | 100 | 库存数量,有多少库存 | | putaway | int | 1 | 是否上架在售,1出售中,0已下架 | | sale | int | 10 | 已售数量。这个并不是真实的数量,有假的数量在内。这里是真实的已售数量跟商家管理后台中编辑商品时,自定义增加的假销售数量的和 | | units | String | 个 | 计量单位。如个、斤、条,限制5字符 | | price | int | 100 | 单价,单位是分,购买需要支付的价格 | | originalPrice | int | 100 | 原价,单位是分,仅仅只是看的,使用场景一般就是 显示出来一个原价,加一条删除线的效果 | | addtime | int | 1581919619 | 商品添加时间,10位时间戳 | | storeid | int | 1 | 店铺的id,该商品是属于哪个店铺的 | | typeid | int | 1 | 分类的id,该商品所属哪个分类的 | | titlepic | String | http://www.xxxx.com/123.jpg | 商品的标题图片(列表图片)比如在商品列表页面中所显示的商品图 | | userBuyRestrict | int | 0 | 用户购买限制。如果值是0,则可以任意购买,没有什么限制,如果是1,则代表每个用户只能购买一个,如果是2,代表每个用户只能购买2个以内,不超过2个。 只要是下单了,未退单成功的,都算是购买了 | ##### page 中每项的值说明 | 参数名称 | 类型 | 示例值 | 描述 | | ------------ | ------------ | ------------ | ------------ | | allRecordNumber | int | 30 | 列表总共有多少条信息 | | currentPageNumber | int | 1 | 当前第几页,当前的页数 | | lastPageNumber | int | 5 | 最后一页的页码、共有多少页 | | haveUpPage | Boolean | true | 是否有上一页 | | haveNextPage | Boolean | true | 是否有下一页 | | upList | JSONArray | | 上几页,如果有上几页,这里才会有数据,最多显示当前页数向前的三页。 | | nextList | JSONArray | | 下几页,如果有下几页,这里才会有数据,最多显示当前页数向后的三页。 | ##### upList、nextList 中每项的值说明 | 参数名称 | 类型 | 示例值 | 描述 | | ------------ | ------------ | ------------ | ------------ | | pageNumber | int | 3 | 上几页中,其中某页的页数 |