物流预警任务增量查询接口
系统相关界面
"界面路径:【数据】----【快递揽收信息】"
请求地址
| 环境 | 服务地址(HTTP/HTTPS) |
|---|---|
| V2正式环境(推荐) | https://gw.superboss.cc/router |
2022年4月1日以后申请的APP Key,统一使用V2正式环境的请求地址:https://gw.superboss.cc/router
请求头
全部展开
参数名
类型
描述
必填
Content-Type
String
application/x-www-form-urlencoded;charset=UTF-8
必填
API接口地址
全部展开
参数名
类型
描述
必填
method
String
erp.report.logistics.task.list.query
必填
请求参数
全部展开
参数名
类型
描述
必填
startTime
Long
开始时间戳(毫秒)
必填
endTime
Long
结束时间戳(毫秒)
必填
lastTime
Long
上次查询的最后时间戳(用于增量查询)
选填
pageSize
Integer
分页大小(1-2000)
必填
响应参数
全部展开
参数名
类型
描述
必填
items
Array
物流任务数据列表
必填
hasMore
Boolean
是否还有更多数据
必填
totalCount
Long
当前返回的数据总数
必填
nextTime
Long
下次查询的时间戳
必填
items数据结构
全部展开
参数名
类型
描述
必填
sid
String
系统订单号
必填
outSid
String
运单号
必填
cpCode
String
物流公司代码,参考cpCodeEnum枚举
必填
logisticsCompany
String
物流公司全称
必填
tid
String
平台订单号
必填
sourceId
Integer
分销商id,用于区分供分销订单
选填
shopId
String
店铺ID
必填
shopName
String
店铺名称
必填
warehouseId
String
仓库ID
必填
warehouseName
String
仓库名称
必填
source
String
订单来源
必填
tradeSource
String
订单平台,参考tradeSourceEnum枚举
必填
sendState
String
发货省份
必填
sendCity
String
发货城市
必填
receiverState
String
收货省份/州
必填
receiverCity
String
收货城市
必填
isMaster
Integer
是否为主运单(1:是,0:否)
必填
expressType
Integer
快递单类型(0:普通订单 1:快递子母单母单 2:快递子母单子单)
必填
consignStatus
Integer
发货状态(1:未发货 2:已发货)
必填
sysStatus
String
系统状态
必填
payTime
Long
支付时间,时间戳(毫秒)
必填
consignTime
Long
发货时间,时间戳(毫秒),默认值946656000000
选填
ptConsignTime
Long
平台发货时间,时间戳(毫秒),默认值946656000000
必填
acceptTimeoutTime
Long
揽收超时时间,时间戳(毫秒),默认值946656000000
必填
acceptUpdateTimeoutTime
Long
揽收更新超时时间,时间戳(毫秒),默认值946656000000
必填
traceUpdateTimeoutTime
Long
轨迹更新超时时间,时间戳(毫秒),默认值946656000000
必填
totalTraceNum
Integer
总轨迹数量
必填
transportTraceNum
Integer
运输轨迹数量
必填
acceptAfterTraceNum
Integer
揽收后轨迹数量
必填
lastLogisticsWeight
Integer
最新物流状态权重,参考lastLogisticsWeightEnum枚举
必填
lastLogisticsStatus
String
最新物流状态,参考物流状态对照表
选填
lastSubLogisticsStatus
String
最新物流状态,参考物流状态对照表
选填
masterOutSid
String
主运单号
必填
handleStatus
Integer
处理状态(1:已处理,0:未处理)
必填
enableStatus
Integer
启用状态(1:启用)
必填
logisticsSubscribeStatus
Integer
物流订阅状态(0:订阅失败 1:订阅成功 2:订阅中)
必填
subscribeFailMsg
String
订阅失败原因
选填
payAcceptTimeoutTime
Long
支付揽收超时时间,时间戳(毫秒),默认值946656000000
必填
created
Long
创建时间,时间戳(毫秒)
必填
modified
Long
修改时间,时间戳(毫秒)
必填
请求示例
示例一:
{
"startTime": 1640995200000,
"endTime": 1641081600000,
"lastTime": 1641078000000,
"pageSize": 50
}
响应示例
{
"traceId" : "5336236713275309417",
"nextTime" : 1768443375000,
"hasMore" : true,
"totalCount" : 1,
"success" : true,
"items" : [ {
"sourceId" : 0,
"payTime" : 1767669900000,
"sendState" : "浙江省",
"source" : "2",
"receiverCity" : "延边朝鲜族自治州",
"tid" : "5663749838239862-rrjedv",
"traceUpdateTimeoutTime" : 946656000000,
"consignTime" : 1767679994000,
"isMaster" : 1,
"modified" : 1767679994000,
"handleStatus" : 0,
"shopId" : "900029341",
"tradeSource" : "sys",
"acceptUpdateTimeoutTime" : 946656000000,
"created" : 1767669984000,
"expressType" : 0,
"transportTraceNum" : 0,
"consignStatus" : 2,
"totalTraceNum" : 0,
"outSid" : "K_707979297088000",
"acceptAfterTraceNum" : 0,
"warehouseId" : "12162",
"receiverState" : "吉林省",
"enableStatus" : 1,
"acceptTimeoutTime" : 1767766394000,
"masterOutSid" : "K_707979297088000",
"cpCode" : "YTO",
"sendCity" : "杭州市",
"lastLogisticsWeight" : 0,
"shopName" : "斑斑测试店铺简称",
"warehouseName" : "默认仓库",
"sid" : "5663720255467000",
"sysStatus" : "FINISHED",
"logisticsCompany" : "圆通速递",
"logisticsSubscribeStatus" : 0,
"subscribeFailMsg" : "快递助手返回订阅失败",
"payAcceptTimeoutTime" : 946656000000,
"ptConsignTime" : 1767679994000
}]
}
异常示例
{
"code": "35",
"msg": "接口调用频繁,请限制调用次数!",
"success": false,
"trace_id": "3553483395423660"
}
错误码解释
| 错误码 | 错误信息 | 解决方案 |
|---|---|---|
| 25 | 服务方法(erp.report.logistics.task.list.query:1.0)的签名无效 | 签名参数错误 |
| 35 | 接口调用频繁,请限制调用次数! | 接口限流 |
其他说明
物流状态对照表
| 序号 | 物流主状态 | 状态描述 | 物流子状态 | 子状态描述 |
|---|---|---|---|---|
| 1 | WAIT_ACCEPT | 待接收 | RECEIVE | 接单中 |
| WAIT_ACCEPT | 待接收 | |||
| 2 | ACCEPT | 已接收 | ACCEPT | 已接收 |
| 3 | TRANSPORT | 运输中 | TRANSPORT | 运输中 |
| SEND_ON | 转单或修改地址转寄 | |||
| ARRIVE_CITY | 到达目的城市 | |||
| 4 | DELIVERING | 派件中 | DELIVERING | 派件中 |
| STA_INBOUND | 已放入快递柜或驿站 | |||
| 5 | AGENT_SIGN | 已代签收 | AGENT_SIGN | 已代签收 |
| 6 | SIGN | 已签收 | SIGN | 已签收 |
| STA_SIGN | 从快递柜或者驿站取出 | |||
| RETURN_SIGN | 退回签收 | |||
| 7 | FAILED | 包裹异常 | FAILED | 包裹异常 |
| REFUSE_SIGN | 拒收 | |||
| DELIVER_ABNORMAL | 派件异常 | |||
| RETENTION | 滞留件 | |||
| ISSUE | 问题件 | |||
| RETURN | 退回件 | |||
| DAMAGE | 破损 | |||
| CANCEL_ORDER | 揽件取消 |