客户基础资料查询

websocket测试

POST

请求地址/router

接口描述

获取ERP的客户基础资料

系统相关界面

界面路径：【客户】----【客户基础信息】

请求地址

|环境|服务地址(HTTP/HTTPS)| |-|-| |V2正式环境（推荐）| https://gw.superboss.cc/router| **2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**

公共参数

调用任何一个API都必须传入的参数，目前支持的公共参数有： | 参数名称 | 参数类型 | 是否必须 | 参数描述 | | --- | --- | --- | --- | | method | string | 是 | API接口名称 | | appKey | string | 是 | 分配给应用的AppKey | | timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 | | format | string | 否 | 响应格式。默认为json格式，可选值：json | | version | string | 是 | API协议版本可选值：1.0 | | sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 | | sign | string | 是 | 签名 | | session | string | 是 | 授权会话信息（即access_token，由系统分配） |

请求头

参数名

类型

描述

必填

Content-Type

string

multipart/form-data

必填

API接口地址

参数名

类型

描述

必填

method

string

erp.query.customers.list

必填

请求参数

参数名

类型

描述

必填

enableStatus

integer

客户状态 0.停用 1.正常

可选

level

integer

客户等级 1.一级 2.二级 3.三级 4.四级 5.五级

可选

nick

string

客户昵称

可选

code

string

客户编码

可选

name

string

客户名称

可选

pageSize

integer

每页多少条【默认20】

可选

pageNo

integer

第几页【默认1】

可选

请求示例

示例一： ----------------- ```` { "enableStatus":"integer", "level":"integer", "nick":string, "code":string, "name":string, "pageSize":integer, "pageNo":integer } ````

响应参数

参数名

类型

描述

traceId

string

示例：1662552886805615255

list

array

数据列表

nick

string

客户昵称

discountRate

string

折扣率百分比

code

string

客户编码

name

string

客户公司全名

remark

string

备注

int

业务主键

type

int

客户类型 0.分销商 1.经销商 2.线下渠道 3.其它 4.线上代发

invoiceTitle

string

发票抬头

level

integer

等级 1.一级 2.二级 3.三级 4.四级 5.五级

success

boolean

示例：true

page

object

数据字典

startRow

int

起始行

offsetRow

int

结束行

pageNo

int

第几页

pageSize

int

每页多少条

响应示例

``` { "list": [ { "code": "zhangsan", "address": "zhangsan", "externalCode": "zhangsan", "city": "zhangsan", "type": 1, "companyId": 12345, "district": "zhangsan", "contact": "zhangsan", "name": "zhangsan", "id": 12345, "state": "zhangsan", "contactPhone": "zhangsan", "status": 1 } ] } ```

异常示例

```` { "code": "25", "msg": "服务方法(item.single.get:1.0)的签名无效", "success": false, "trace_id": "3553483395423660" } ````

错误码解释

| 错误码 |错误信息|解决方案| |-|-|-| |content1|content2|content3|