获取商品分类列表

接口描述：

  • 获取商品分类列表。

请求 URL：

  • http|https://host/api/v1/goods_category/method/get.goods.category.list/

请求方式：

  • GET
  • POST

是否授权：

  • 需要授权

业务参数：

参数名 类型 是否必须 范围值 默认值 示例值 描述
goods_category_id integer 否 egt:0 0 1 商品分类编号
level integer 否 egt:0 0 商品分类深度
goods_total integer 否 in:0,1 0 1 是否获取关联商品数 0=否 1=是
is_layer integer 否 in:0,1 0 1 是否返回本级分类 0=否 1=是

响应参数：

参数名 类型 是否返回 示例值 描述
status integer 是 200 状态码
message string 是 success 消息信息
data array 否 [] 返回数组
data 类型 是否返回 示例值 描述
goods_category_id integer 是 1 商品分类编号
parent_id integer 是 0 商品分类上级编号
name string 是 男装、女装 商品分类名称
name_phonetic string 是 n 商品分类名称首拼
alias string 是 服装 商品分类别名
alias_phonetic string 是 f 商品分类别名首拼
category_pic string 是 //image.jpg 商品分类图片
category_ioc string 是  商品分类图标
keywords string 是 关键词 商品分类关键词
description string 是 描述 商品分类描述
category_type integer 是 0 商品分类类型(自定义)
sort integer 是 50 商品分类排序值
is_navi integer 是 0 是否显示到导航 0=否 1=是
status integer 是 1 是否显示 0=否 1=是
children_total integer 是 0 该分类下关联商品的合计
level integer 是 0 该分类的层级深度

响应示例：

  1. {
  2.   "status": 200,
  3.   "message": "success",
  4.   "data": [
  5.     {
  6.       "goods_category_id": 1,
  7.       "parent_id": 0,
  8.       "name": "男装、女装",
  9.       "name_phonetic": "n",
  10.       "alias": "服装",
  11.       "alias_phonetic": "f",
  12.       "category_pic": "//image.jpg",
  13.       "category_ioc": "",
  14.       "keywords": "关键词",
  15.       "description": "描述",
  16.       "category_type": 0,
  17.       "sort": 50,
  18.       "is_navi": 0,
  19.       "status": 1,
  20.       "children_total": 0,
  21.       "level": 0
  22.     },
  23.     {
  24.       "goods_category_id": 2,
  25.       "parent_id": 0,
  26.       "name": "数码产品",
  27.       "name_phonetic": "s",
  28.       "alias": "3C",
  29.       "alias_phonetic": "3",
  30.       "category_pic": "//image.jpg",
  31.       "category_ioc": "",
  32.       "keywords": "关键词",
  33.       "description": "描述",
  34.       "category_type": 0,
  35.       "sort": 50,
  36.       "is_navi": 0,
  37.       "status": 1,
  38.       "children_total": 0,
  39.       "level": 0
  40.     }
  41.   ]
  42. }

备注:

  1. 该接口支持条件搜索，如果不带入业务参数则使用默认值。

  2. goods_category_id参数值为 0 表示获取所有分类，如果参数值非 0 表示从指定的编号开始获取。

参数示例： 假设某个分类列表：

  1. 最顶层分类(ID=0)
  2. ├─ A1 // (ID=1)
  3. │  └─ A2
  4. │     └─ A3
  5. └─ B1
  6.    └─ B2
  7.       └─ B3

  1. 不传入level参数时表示返回所有层级的分类列表。

  2. 当level值为 0 时返回A1 B1，值为 1 时返回A1 A2 B1 B2，值为 2 时返回A1 A2 A3 B1 B2 B3；

  3. 当goods_category_id值为A1(ID=1)，并且level值为 0 时返回A1，值为 1 时返回A1 A2，因为is_layer参数默认为 1，所以会返回本级。如果将is_layer参数值设为 0 并且level值为 0 时返回A2，值为 1 时返回A2 A3。