跳到主要内容

用户物流公司列表

系统相关界面​

"界面路径：【订单管理】"

请求地址​

环境服务地址(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都必须传入的参数，目前支持的公共参数有：

参数名称参数类型是否必须参数描述
methodstring是API接口名称
appKeystring是分配给应用的AppKey
timestampstring是时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟
formatstring否响应格式。默认为json格式，可选值：json
versionstring是API协议版本 可选值：1.0
sign_methodstring否签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。
signstring是签名
sessionstring是授权会话信息 （即access_token，由系统分配）

请求头​

参数名
类型
描述
必填
Content-Type
string
application/x-www-form-urlencoded;charset=UTF-8
必填

API接口地址​

参数名
类型
描述
必填
method
string
erp.trade.logistics.company.user.list
必填

请求参数​

参数名
类型
描述
必填
默认值
warehouseId
long
仓库ID

请求示例​

示例一：

{
 "warehouseId": 11232
}

响应参数​

参数名
类型
描述
必填
success
boolean
示例：true
trace_id
string
示例：3553483395407017
list
array
id
long
用户物流公司ID
name
string
物流公司名称
cloudTemplatePaperType
string
纸张类型 1： 一联单(76100)2: 一联单(76130)3: 二联单（100150）4: 标准二联单（100180）5: 三联单（100*210）
expressId
long
物流公司ID
cpCode
string
物流服务商ID
cpType
string
物流服务商业务类型 1：直营 2：加盟 3：落地配 4：直营带网点
liveStatus
int
是否停用 0 停用 1 启用
warehouseIdList
array
绑定的仓库列表
created
date
创建时间
modified
date
创建时间

响应示例​

{
    "traceId": "3895683976502069544",
    "list": [
        {
            "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
        }
    ],
    "success": true
}

异常示例​

{
    "traceId": "4071991477422416710",
    "msg": "对应仓库null不存在",
    "code": "33",
    "success": false
}

错误码解释​

错误信息错误码解决方案
资源异常,请联系管理员!400检查参数是否合法
非法参数!50检查参数类型等是否合法
唯一码数量最大支持20组!20029参数过长