当前位置: API文档
goods_class_query.php(查询货品分类)
1.接口说明
1.1 接口描述:查询旺店通ERP内的货品分类信息 1.2 适用版本:客户端 V2.4.5.0及以上版本 |
2.调用场景
| 2.1 查询货品分类 |
3.请求参数说明
3.1 请求地址
| 环境 | HTTP地址 |
|---|---|
| 测试环境 | https://sandbox.wangdian.cn/openapi2/goods_class_query.php |
| 正式环境 | https://api.wangdian.cn/openapi2/goods_class_query.php |
3.2 公共请求参数
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 卖家账号 | sid | String | 是 | 购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。 | |
| 接口账号 | appkey | String | 是 | 本开放平台“自助对接”功能模块内自助申请,获取方式点击这里 | |
| 时间戳 | timestamp | int | 是 | 北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。 | |
| 签名 | sign | String | 是 | API输入参数签名结果,签名算法介绍单击这里 |
3.3 业务请求参数
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 分类名称 | class_name | varchar | 否 | 分类名称 | |
| 分页大小 | page_size | varchar | 否 | 每页返回条数,传参范围1~100,不传此参数默认page_size=40,使用举例单击这里 | |
| 分类页号 | page_no | varchar | 否 | 页号,不传默认从0页开始 |
4.响应参数
4.1 公共响应参数
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 错误码 | code | int | 40 | 是 | 状态码:0表示成功,其他表示失败 |
| 错误描述 | message | varchar | 255 | 是 | 错误描述 |
| 数据条数 | total_count | int | 10 | 否 | 只有,page_no = 0 时才返回的符合条件的数据总条数,用来分页 |
| 货品分类列表 | goods_class | data[ ] | 是 | 货品分类信息 |
4.2 业务响应参数
goods_class
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 分类主键 | class_id | int | 11 | 是 | 分类主键id |
| 分组id | parent_id | int | 11 | 是 | 货品分组id, ERP内自定义设置(路径:ERP→货品→货品分类),返回货品分类的上层分组id |
| 是分类还是分类组 | is_leaf | tinyint | 4 | 是 | 是分类 |
| 分类名称 | class_name | varchar | 64 | 是 | 分类名称 |
| 路径 | path | varchar | 1024 | 是 | 路径 |
| 最后修改时间 | modified | datetime | datetime | 是 | 最后修改时间 |
| 创建时间 | created | datetime | datetime | 是 | 创建时间 |
6.响应示例
6.1 正常响应示例
{"code":"0",
"message":"",
"total_count":1,
"goods_class":[{"class_id":"5",
"parent_id":"-1",
"is_leaf":"1",
"class_name":"PDA",
"path":"-1,5,",
"modified":"2018-11-2613:47:34",
"created":"2018-11-26 13:47:34"
}]} |
6.2 异常响应示例
{
"code": 1007,
"message": "接口appkey已停用【解决办法:联系商务人员,重新开启接口appkey】 "
} |