## 获取商品分类列表(categoryList) >[info] 场景说明:获取商城商品分类列表信息 ### 是否需要获取用户TOKEN `否` ***** ### 请求地址 ``` POST http://api.xxx.com/category/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`格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | parent\_id | integer | 可选 | 分类父级ID,如果需要获取全量数据,则不传 | | store\_id | integer | 可选 | 店铺ID,如果大于0,则读取店铺的分类 | | groupid | integer | 可选 | 分类分组ID,store\_id=0时有效 | | if\_show | integer | 可选 | 分类显示标识,0=只取不显示的分类,1=只取显示的分类,不传则不限制 | | querychild | boolean | 可选 | 是否读取直接下级分类(只读一级),当parent\_id>=0时有效。默认为:false | | page | integer | 可选 | 当前页,默认第一页 | | page\_size | integer | 可选 | 每一页显示多少数据,默认10条 | ### 请求示例 ``` { "appid": "您的APPID", "version": "v3", "sign_type": "md5", "timestamp": "2020-8-10 12:00:00", "format": "json", "sign": "op0987yhjmngt54rtg2wgdfvcder2765", "params": { "parent_id": 0, "querychild": true, "page": 1, "page_size": 10 } } ``` ***** ### 公共返回参数 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | code | integer | 必须 | 0=成功,其它值代表请求失败的错误代码,请参考:[公共错误码](response-code.md) | | message | string | 必须 | 请求成功/失败的描述信息 | | \+ data | array | 必须 | 返回结果,如果没有数据则返回空 | | └ list | list | 必须 | 分类类别 | | └ pagination | array | 必须 | 分页信息 | 返回`data->list`参数格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | cate\_id | integer | 必须 | 分类ID | | parent\_id | integer | 必须 | 分类父级ID | | cate\_name | string | 必须 | 分类名称 | | store\_id | integer | 必须 | 店铺ID,如果大于0,说明读取的是店铺的商品分类 | | if\_show | integer | 必须 | 分类显示标识,0=不显示的分类,1=显示的分类 | | image | string | 可选 | 分类图标URL地址 | | ad | string | 可选 | 分类广告图,只有一级分类才有 | | groupid | integer | 可选 | 分类分组 | | sort\_order | integer | 可选 | 分类排序,取值0-255之间,值越小排序越靠前 | | \+ children | list | 可选 | 当前分类的下级分类列表,当querychild=1时有效 | | └ cate\_id | integer | 必须 | 分类ID | | └ parent\_id | integer | 必须 | 分类父级ID | | └ cate\_name | string | 必须 | 分类名称 | | └ store\_id | integer | 必须 | 店铺ID | | └ if\_show | integer | 必须 | 分类显示标识,0=不显示的分类,1=显示的分类 | | └ image | string | 可选 | 分类图标URL地址 | | └ sort\_order | integer | 可选 | 分类排序,取值0-255之间,值越小排序越靠前 | 返回`data->pagination`参数格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | page | integer | 必须 | 当前页 | | page\_size | integer | 必须 | 每一页显示的数据量 | | page\_count | integer | 必须 | 总页数 | | total | integer | 必须 | 总记录数 | ### 返回数据示例 ``` { "code": 0, "message": "成功", "data": { "list": [ { "cate_id":21, "cate_name":"家用电器", "parent_id":0, "store_id":0, "if_show":1, "image":"http://www.xxx.com/data/files/mall/category/icon-21.jpg", "ad":"", "groupid":1, "sort_order":1, "children": [ { "cate_id": 211, "cate_name": "苏泊尔电饭锅", "parent_id": 21, "store_id": 0, "if_show": 1, "image": "", "sort_order": 255 } ] }, { "cate_id":22, "cate_name":"手机数码", "parent_id":2, "store_id":0, "if_show":1, "image":"http://www.xxx.com/data/files/mall/category/icon-22.jpg", "ad":"", "groupid":1, "sort_order":255, "children":[] } ], "pagination":{ "page":1, "page_size":10, "page_count":1, "total":2 } } } ```