当前位置: API文档
goods.Category.search(平台类目查询)
1.接口说明
1.1 接口描述:获取ERP平台类目数据 |
1.2 适用版本:客户端 V1.4.2.6及以上版本 |
1.3 增量获取: |
1.4 时间跨度:起止时间跨度不超过30天 |
1.5注意事项:【权限校验】:店铺权限 1.为了达到保护用户隐私数据安全的目的,本接口不返回淘系及系统供销平台货品数据,相关平台规则点击这里,淘系及系统供销平台数据获取办法点击这里。 2.本接口不返回类目下的平台货品信息,需要到平台货品查询接口进行类目关联 |
2.调用场景
2.1 举例说明:自研商城、SCM、SRM、财务系统、SAP等系统的对接 |
3.请求参数说明
3.1 请求地址
环境 | HTTP地址 |
---|---|
测试环境 | http://47.92.239.46/openapi |
正式环境 | http://wdt.wangdian.cn/openapi |
3.2 公共请求参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
卖家账号 | sid | String | 是 | 卖家账号, 由旺店通分配 | |
接口账号 | key | String | 是 | 由旺店通分配appkey, 在发送的数据中对应 key 字段,获取方式点击这里 | |
盐 | salt | String | 是 | 由旺店通分配appsecret,是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt. | |
接口名称 | method | String | 是 | 调用的接口名称 | |
版本号 | v | String | 是 | 1.0 | |
秒级时间戳 | timestamp | int | 是 | 秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。 | |
签名 | sign | String | 是 | 签名 | |
分页大小 | page_size | int | 否 | 分页大小,分页查询必传 | |
分页编号 | page_no | int | 否 | 分页编号,分页查询必传,标准接口page_no从0开始 | |
是否计算查询结果的总条数 | calc_total | int | 否 | 是否计算查询结果的总条数, 需要计算则1, 否则填0 |
3.3 业务请求参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
查询参数 | params | Map<String, Object> | 是 | 查询参数 | |
分页 | pager | pager | 是 | 分页 |
params
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
店铺编号 | shop_no | String | 20 | 否 | 店铺编号 |
开始时间 | start_time | String | 40 | 是 | 开始时间(最后修改时间) |
结束时间 | end_time | String | 40 | 是 | 结束时间(最后修改时间) |
pager
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
分页大小 | page_size | Int | 4 | 否 | 分页大小 |
页号 | page_no | Int | 4 | 否 | 从0开始 |
4.响应参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
状态码 | status | Int | 是 | 状态码,0表示正常 | |
错误信息 | message | String | 是 | 无错误信息不返回 | |
货品分类数据 | data | Map<String, Object> | 是 | 货品分类数据 |
data
响应参数说明示例值或者格式、具体含义、使用方法及注意事项
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
货品类目数据信息 | category_list | List<Map<String, Object>> | 是 | 货品类目数据信息 | |
总数 | total_count | Int | 11 | 是 | 查询条件总单据数 |
category_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
唯一键 | rec_id | Int | 11 | 是 | 唯一键 |
平台id | platform_id | Int | 11 | 是 | 平台id,点击链接查看平台代码表 |
店铺id | shop_id | Int | 11 | 是 | 店铺id |
店铺编号 | shop_no | String | 20 | 是 | 店铺编号 |
佣金系数 | commission_factor | Decimal(19,4) | 是 | 佣金系数 | |
状态 | status | Int | 1 | 是 | 状态 0:正常 1:类目已删除 2:无效类目 |
类目id | cid | String | 40 | 是 | 类目id |
父级分类id | parent_id | String | 40 | 是 | 父级分类id |
是否根节点 | is_leaf | Int | 1 | 是 | 是否根节点 |
类目名称 | category_name | String | 64 | 是 | 类目名称 |
记录了从根元素到当前元素的ID,以逗号分隔 | path | String | 1024 | 是 | 记录了从根元素到当前元素的ID,以逗号分隔 |
5.请求示例
json格式请求报文 | [{"start_time":"2022-10-01 00:00:00","end_time":"2022-10-10 00:00:00"}] |
PHP | <?php header("Content-Type: text/html; charset=UTF-8"); date_default_timezone_set("Asia/Shanghai"); require_once('wdtsdk.php'); $client = new WdtErpClient("url", "wdtapi3", "appkey", "secret"); $parMap = new stdClass(); $parMap->start_time = "2022-10-01 00:00:00"; $parMap->end_time = "2022-10-10 00:00:00"; $parMap->shop_no="test"; $pager = new Pager(10, 0, true); $data = $client->pageCall("goods.Category.search", $pager, $parMap); ?> |
JAVA | |
C# |
6.响应示例
6.1 正常响应示例
JSON | { "status": 0, "data": { "category_list": [{ "commission_factor": 0.0000, "shop_id": 28, "path": "0,30,50010158,", "category_name": "夹克", "parent_id": "30", "platform_id": 3, "is_leaf": 1, "rec_id": 532, "cid": "50010158", "status": 0, "shop_no": "zlc_test" }], "total_count": 19 } } |
6.2 异常响应示例
JSON | { "status": 100, "message": "您的查询时间过宽,查询时间不能大于30天" } |