## 获取商品列表(goodsList) >[info] 场景说明:获取一定数量的商城在售的商品列表信息。如果需要根据条件获取更复杂的商品数据,请使用:搜索商品数据(goodsRearch)接口 ### 是否需要获取用户TOKEN `否` ***** ### 请求地址 ``` POST http://api.xxx.com/goods/list ``` ### 公共请求参数 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | appid | string | 必须 | 平台提供的唯一APPID | | version | string | 必须 | 接口版本号,固定填:v3 | | sign\_type | string | 必须 | 签名类型,目前只支持md5 | | timestamp | string | 必须 | 发起时间戳,格式为:yyyy-mm-dd hh::ii::ss | | format | string | 必须 | 返回的数据格式,只支持json | | sign | string | 必须 | 请求参数的签名,请参考:[签名规则](signature.md) | | token | string | 必须 | 访问TOKEN | | params | string | 必须 | 请求参数的集合,除公共参数外,所有请求参数都必须放在这个参数中传递,json\_encode后送入 | 应用请求参数`params`格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | cate\_id | integer | 可选 | 商品分类ID,包含下级分类的商品 | | store\_id | integer | 可选 | 店铺ID,如果不传,则不限制 | | keyword | string | 可选 | 关键词,模糊查询 | | recommended | integer | 可选 | 推荐标识,1=推荐的商品,0=非推荐的商品 | | orderby | string | 可选 | 排序,参考:排序取值说明 | | page | integer | 可选 | 当前页 | | page\_size | integer | 可选 | 每页读取多少条记录,默认10条 | >[info] orderby排序取值说明:"sales|desc"=销量从高到低,"price|desc"=价格从高到低,"price|asc"=价格从低到高,"views|desc"=点击量从高到低,"add\_time|desc"=上架时间从近到远,"add\_time|asc"=上架时间从远到近,"comments|desc"=评论数从多到少 ### 请求示例 ``` { "appid": "您的APPID", "version": "v3", "sign_type": "md5", "timestamp": "2020-8-10 12:00:00", "format": "json", "sign": "op0987yhjmngt54rtg2wgdfvcder2765", "params": { "cate_id": 21, "orderby": "price|desc" } } ``` ***** ### 公共返回参数 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | code | integer | 必须 | 0=成功,其它值代表请求失败的错误代码,请参考:[公共错误码](response-code.md) | | message | string | 必须 | 请求成功/失败的描述信息 | | \+ data | array | 必须 | 返回结果,如果没有数据则返回空 | | └ list | list | 必须 | 商品列表 | | └ pagination | array | 必须 | 分页信息 | 返回`data->list`参数格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | goods\_id | integer | 必须 | 商品ID | | goods\_name | string | 必须 | 商品名称 | | cate\_id | integer | 必须 | 分类ID | | cate\_name | string | 必须 | 分类名称 | | store\_id | integer | 必须 | 店铺ID | | store\_name | string | 必须 | 店铺名称 | | brand | string | 可选 | 品牌 | | default\_spec | integer | 必须 | 规格ID,默认SKU | | spec\_qty | integer | 必须 | SKU规格数量,如果大于0说明是多规格,可以再通过[规格接口](goods-specs.md)获取规格详细数据 | | price | decimal | 必须 | 默认SKU的商品价格 | | mkprice | decimal | 可选 | 市场价格 | | stock | integer | 必须 | 默认SKU的库存量 | | default\_image | string | 必须 | 商品主图 | | recommended | integer | 可选 | 是否为推荐商品 | | views | integer | 可选 | 点击量 | | sales | integer | 可选 | 销售量 | | collects | integer | 可选 | 收藏量 | | comments | integer | 可选 | 评论量 | | add\_time | string | 必须 | 商品发布时间,格式:yyyy-mm-dd hh:ii:ss | 返回`data->pagination`参数格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | page | integer | 必须 | 当前页 | | page\_size | integer | 必须 | 每一页显示的数据量 | | page\_count | integer | 必须 | 总页数 | | total | integer | 必须 | 总记录数 | ### 返回数据示例 ``` { "code": 0, "message": "成功", "data": { "list": [ { "goods_id": 123, "goods_name": "Midea/美的 BCD-213TM(E) 节能静音家用三开门小冰箱小型电冰箱", "cate_id": 1219, "cate_name": "冰箱", "store_id":2, "store_name": "演示店铺", "brand": "美的", "recommended": 1, "default_image": "http://www.xxx.com/data/files/store_2/goods/20181121212111599.jpg", "default_spec": 135, "price": 149.99, "mkprice": 200.00, "stock": 500, "views": 100, "sales": 20, "collects": 89, "comments": 5, "add_time": "2020-1-9 15:40:49" }, { "goods_id": 124, "goods_name": "Haier/海尔 BCD-206STPA 206升三门冷藏小型家用节能小冰箱软冷冻", "cate_id": 1219, "cate_name": "冰箱", "store_id":2, "store_name": "演示店铺", "brand": "海尔", "recommended": 1, "default_image": "http://www.xxx.com/data/files/store_2/goods/20181121212111597.jpg", "default_spec": 136, "price": 249.99, "mkprice": 300.00, "stock": 600, "views": 130, "sales": 26, "collects": 59, "comments": 8, "add_time": "2020-4-9 10:46:40" } ], "pagination": { "page":1, "page_size":10, "page_count":1, "total":2 } } } ```