分销商信息查询
请求地址
环境 | 服务地址(HTTP/HTTPS) |
---|---|
V2 正式环境(推荐) | https://gw.superboss.cc/router |
V2测试环境 | https://gw3.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
application/x-www-form-urlencoded
必填
API接口地址
全部展开
参数名
类型
描述
必填
method
string
kmt.api.dms.query.distributor.list
必填
请求参数
全部展开
参数名
类型
描述
必填
supplierCompanyId
long
供销商公司id
必填
modifiedTimeStart
string
周期 开始时间 格式类型(yyyy-MM-dd hh:mm:ss,2018-01-01 17:02:07)
非必填
modifiedTimeEnd
string
周期 结束时间 格式类型(yyyy-MM-dd hh:mm:ss,2018-01-01 17:02:07)
非必填
requestState
string
全部/待审核/已生效/已作废/已拒绝 对应01234,支持多个状态查询 ,分隔
非必填
pageNo
int
页码
必填
pageSize
int
分页大小
必填
请求示例
示例一:
{
"supplierCompanyId":1,
"modifiedTimeStart":"2018-01-01 17:02:07",
"modifiedTimeEnd":"2018-01-01 17:02:07",
"pageNo":1,
"pageSize":"20",
}
示例二:
{
"supplierCompanyId":2,
"modifiedTimeStart":"2018-01-01 17:02:07",
"modifiedTimeEnd":"2018-01-01 17:02:07",
"pageNo":1,
"pageSize":"20",
}
响应参数
全部展开
参数名
类型
描述
必填
distributorCompanyId
long
分销商公司id
必填
distributorCompanyName
string
分销商公司名
必填
remark
string
备注
非必填
contactProvince
string
详细地址-省,例如:浙江省
非必填
contactCity
string
详细地址-市,例如:杭州市
非必填
contactDistrict
string
详细地址-区,例如:滨江区
非必填
contactDetailAddress
string
详细地址-详细地址,例如:坚塔路599号
非必填
aliasName
string
简称
非必填
saleStaffId
string
业务员id
非必填
saleStaffName
string
业务员姓名
非必填
showState
int
合作状态
非必填
showStateName
string
合作状态-名称
非必填
success
boolean
示例:true
必填
trace_id
string
示例:3553483395407017
必填
响应示例
{
"remark": "备注",
"distributorCompanyId": 2,
"distributorCompanyName": "分销商公司名",
"contactProvince": "浙江省",
"contactCity": "杭州市",
"contactDistrict": "滨江区",
"contactDetailAddress": "坚塔路599号",
"aliasName": "简称",
"saleStaffId": "610659135834612",
"saleStaffName": "张三",
"success": boolean,
"trace_id": "long"
}
异常示例
{
"code": "25",
"msg": "服务方法(item.single.get:1.0)的签名无效",
"success": false,
"trace_id": "3553483395423660"
}
错误码解释
错误码 | 错误信息 | 解决方案 |
---|---|---|
content1 | content2 | content3 |