当前位置: API文档
reason_query.php(查询原因列表)
1.接口说明
1.1 接口描述:查询原因列表 |
1.2 适用版本:客户端 V2.4.8.0及以上版本 |
2.调用场景
2.1 查询原因列表 |
3.请求参数说明
3.1 请求地址
环境 | HTTP地址 |
---|---|
测试环境 | https://sandbox.wangdian.cn/openapi2/reason_query.php |
正式环境 | https://api.wangdian.cn/openapi2/reason_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_id | varchar | 否 | 原因类型 | |
分页大小 | page_size | int | 否 | 每页返回的数据条数,输入值范围1~100,不传本参数输入值默认为40,使用举例单击这里 | |
页号 | page_no | int | 否 | page_no页的数据,不传值默认从第1页开始 |
4.响应参数
4.1 公共响应参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
错误码 | code | int | 40 | 是 | 状态码:0表示成功,其他表示失败 |
错误描述 | message | varchar | 255 | 是 | 错误描述 |
数据条数 | total_count | int | 10 | 否 | 只有,page_no = 0 时才返回的符合条件的数据总条数,用来分页 |
原因列表 | reasonlist[ ] | data | 是 | 原因列表 |
4.2 业务响应参数
reasonlist
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
原因类型 | class_id | smallint | 6 | 是 | 原因类型 |
原因 | title | varchar | 64 | 是 | 原因 |
优先级 | priority | tinyint | 1 | 是 | 原因优先级 |
是否内置标记 | is_builtin | tinyint | 1 | 是 | 是否内置标记 0:否 1:是 |
原因主键id | reason_id | smallint | 6 | 是 | 原因主键id |
内置字段 | parent_id | smallint | 6 | 是 | 内置字段(忽略) |
是否禁用 | is_disabled | tinyint | 1 | 是 | 是否禁用 |
修改时间 | modified | datetime | 是 | 修改时间 | |
创建时间 | created | datetime | 是 | 创建时间 |
5.请求示例
6.1 正常响应示例
JSON | { "code": 0, "total_count": 1, "message": "ok", "reasonlist": [ { "class_id": "4", "created": "2020-04-23 14:20:18", "is_builtin": "0", "is_disabled": "0", "modified": "2023-06-21 17:42:29", "priority": "15", "reason_id": "32", "title": "七天无理由退款" } ] } |
JSON | { "code": 1007, "message": "接口appkey已停用【解决办法:联系商务人员,重新开启接口appkey】 " } |