文档
测试

用户快递公司列表

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
erp.trade.logistics.company.user.list
必填

请求参数

参数名
类型
描述
必填
warehouseId
long
仓库ID
可选

请求示例

示例一: ----------------- ```` { "warehouseId":11111 } ````

响应参数

参数名
类型
描述
必填
list
object
数据字典
必填
id
long
用户快递公司ID
必填
name
string
用户快递公司名称
必填
cloudTemplatePaperType
string
纸张类型,1: 一联单(76*100),2: 一联单(76*130),3: 二联单(100*150),4: 标准二联单(100*180),5: 三联单(100*210)
必填
expressId
long
快递公司Id
必填
cpCode
string
物流服务商ID
必填
cpType
string
物流服务商业务类型 1:直营 2:加盟 3:落地配 4:直营带网点
必填
printerName
string
打印机名称
必填
liveStatus
int
是否停用
必填
enableStatus
int
状态 0 停用 1 启用
必填
created
int
创建时间
必填
modified
int
更新时间
必填
expressName
string
快递公司名称
必填
warehouseIdList
array
仓库id列表
必填
prioritySort
运费优先级排序
必填
success
boolean
示例:true
必填
trace_id
string
示例:3553483395407017
必填

响应示例

``` { "traceId": "3895639858597952906", "success": true, "list": [ { "cpCode": "STO", "cpType": 2, "created": 1698507161000, "warehouseIdList": [ 85692 ], "companyId": 10438, "name": "申通快递", "modified": 1722220123000, "id": 121, "cloudTemplatePaperType": 2, "enableStatus": 1, "liveStatus": 1, "expressId": 100 }, { "cpCode": "YUNDA", "cpType": 2, "created": 1687157756000, "warehouseIdList": [ 85692 ], "companyId": 10438, "name": "韵达快递", "modified": 1722223766000, "id": 49, "cloudTemplatePaperType": 2, "enableStatus": 1, "liveStatus": 1, "expressId": 102 }, { "cpCode": "JBD", "created": 1722219922000, "warehouseIdList": [ 85692 ], "companyId": 10438, "name": "京邦达快递", "modified": 1722219922000, "id": 275, "cloudTemplatePaperType": 1, "enableStatus": 1, "liveStatus": 1, "expressId": 313 }, { "cpCode": "ZTO", "cpType": 2, "created": 1687157634000, "warehouseIdList": [ 85692 ], "companyId": 10438, "name": "中通快递", "modified": 1722222782000, "id": 46, "cloudTemplatePaperType": 2, "enableStatus": 1, "liveStatus": 1, "expressId": 500 }, { "cpCode": "YTGJ", "cpType": 2, "created": 1721981650000, "warehouseIdList": [ 85692 ], "companyId": 10438, "name": "圆通国际", "modified": 1721981650000, "id": 272, "cloudTemplatePaperType": 2, "enableStatus": 1, "liveStatus": 1, "expressId": 1239 }, { "cpCode": "OTHER", "created": 1722219842000, "warehouseIdList": [ 85692 ], "companyId": 10438, "name": "菜鸟相关物流", "modified": 1722219842000, "id": 274, "cloudTemplatePaperType": 1, "enableStatus": 1, "liveStatus": 1, "expressId": 5300000110730 } ] } ```

异常示例

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

错误码解释

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