文档
测试

查询供应商列表

POST
请求地址/router

系统相关界面

"界面路径:【采购】----【供应商管理】----【查询】"

请求地址

|环境|服务地址(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
supplier.list.query
必填

请求参数

参数名
类型
描述
必填
pageNo
integer
示例:页码 取值范围:大于零的整数。默认值为1
可选
pageSize
integer
示例:每页条数 取值范围:大于零的整数;最大值:200;默认值:40
可选
status
string
示例:合作状态,1表示合作中,2表示停止合作
可选

请求示例

```json { "id": "long" } ````

响应参数

参数名
类型
描述
total
string
总数
list
object
列表
code
string
示例:供应商编码
invoiceName
string
示例:发票抬头
city
string
示例:城市
modifierId
string
示例:修改人编号
remark
string
示例:备注
categoryName
string
示例:供应商分类
accountBank
string
示例:开户行
province
string
示例:省份
modified
string
示例:修改日期
id
string
示例:供应商编号
createrId
string
示例:建档者,也就是员工的编号
fax
string
示例:传真
email
string
示例:邮箱
qq
string
示例:QQ
zip
string
示例:邮编
bankNumber
string
示例:银行账号
address
string
示例:地址
alipay
string
示例:支付宝
contactName
string
示例:联系人名称
webAddress
string
示例:网址
created
string
示例:建档日期
billType
string
示例:账期(天)
mobile
string
示例:手机号码
wechat
string
示例:微信
tax
string
示例:税号
createrName
string
示例:建档者名称
planReceiveDay
string
示例:预计到货时长 默认0
companyId
string
示例:公司id
phone
string
示例:固话号码
taxId
string
示例:供应商税务ID
memoni
string
示例:助记符
district
string
示例:区县
name
string
示例:名称
modifierName
string
示例:修改人名称
categoryId
string
示例:供应商分类ID
status
string
示例:合作状态,1表示合作中,2表示停止合作

响应示例

```json { "total": 12345, "list": [ { "code": "zhangsan", "invoiceName": "zhangsan", "city": "zhangsan", "modifierId": 12345, "remark": "zhangsan", "categoryName": "zhangsan", "accountBank": "zhangsan", "province": "zhangsan", "modified": "@date", "id": 12345, "createrId": 12345, "fax": "zhangsan", "email": "zhangsan", "qq": "zhangsan", "zip": "zhangsan", "bankNumber": "zhangsan", "address": "zhangsan", "alipay": "zhangsan", "contactName": "zhangsan", "webAddress": "zhangsan", "created": "@date", "billType": "zhangsan", "mobile": "zhangsan", "wechat": "zhangsan", "tax": "zhangsan", "createrName": "zhangsan", "planReceiveDay": 1, "companyId": 12345, "phone": "zhangsan", "taxId": "zhangsan", "memoni": "zhangsan", "district": "zhangsan", "name": "zhangsan", "modifierName": "zhangsan", "categoryId": "zhangsan", "status": 1 } ] } ```

异常示例

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

错误码解释

| 错误码 |错误信息|解决方案| |-|-|-| |25|服务方法(supplier.list.query:1.0)的签名无效|签名参数错误|