查询箱列表
请求地址
| 环境 | 服务地址(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
box.query
必填
请求参数
全部展开
参数名
类型
描述
必填
boxCode
string
箱码,精确查询
否
boxTimeStart
Date
装箱开始时间,格式:yyyy-MM-dd HH:mm:ss,包含该时间
否
boxTimeEnd
Date
装箱结束时间,格式:yyyy-MM-dd HH:mm:ss,包含该时间
否
type
int
箱类型:0=普通箱,1=虚拟箱;不传查询全部类型
否
state
int
箱状态:-2=空箱,-1=已拆箱,0=待入库,1=正常,2=已出库,3=等待发货,5=虚拟箱;不传查询全部状态
否
pageNo
int
页码,默认1
否
pageSize
int
每页条数,默认40,最大500;
否
各查询条件可组合使用;不传业务查询条件时,分页查询当前授权公司的箱数据。
请求示例
示例一:按装箱时间、箱类型和箱状态查询
{
"boxTimeStart": "2026-11-19 00:00:00",
"boxTimeEnd": "2026-11-19 23:59:59",
"type": 0,
"state": 1,
"pageNo": 1,
"pageSize": 40
}
示例二:按箱码查询
{
"boxCode": "BOX202611190001",
"pageNo": 1,
"pageSize": 40
}
响应参数
未关联数据或尚未发生对应操作时,相关字段可能为空或不返回。例如:尚未出库的箱没有出库时间、没有关联供应商的箱没有供应商信息。
全部展开
参数名
类型
描述
必填
list
array
箱数据列表,无匹配记录时为空列表
必填
id
Long
箱id,可用于查询箱明细
必填
boxCode
string
箱码
必填
type
int
箱类型:0=普通箱,1=虚拟箱
必填
source
int
箱来源:-2=批量生成,0=进仓装箱,1=自由发货装箱(历史值),2=发货装箱,3=自由装箱,4=仓外装箱,5=箱导入
必填
state
int
箱状态:-2=空箱,-1=已拆箱,0=待入库,1=正常,2=已出库,3=等待发货,5=虚拟箱
必填
itemKindNum
int
商品种类数,按商品id、规格商品id去重;空箱为0
必填
itemCount
int
商品总数,明细商品装箱数量之和;空箱为0
必填
warehouseName
string
所在仓库名称
否
warehouseId
Long
所在仓库id
否
goodsSectionCode
string
货位编码;位于暂存区时显示暂存区名称
否
boxTime
string
装箱时间,格式:yyyy-MM-dd HH:mm:ss
否
operateBoxName
string
装箱人
否
outTime
string
出库/拆箱时间,格式:yyyy-MM-dd HH:mm:ss
否
operateOutName
string
出库/拆箱人
否
supplierName
string
供应商名称
否
supplierId
Long
供应商id
否
labels
string
箱标签名称,多个以英文逗号分隔
否
remark
string
备注
否
sids
string
关联系统订单号,多个以英文逗号分隔
否
logisticsCompanyName
string
快递公司名称,展示口径与箱管理列表一致
否
outSid
string
快递单号
否
otherOutCodes
string
关联其他出库单号,多个以英文逗号分隔
否
waveIds
string
关联波次号,多个以英文逗号分隔
否
assoOrderType
int
关联单据类型:0=采购单,1=其他出库单,2=采退单,3=加工单,4=收货单,5=调拨出库单
否
assoOrderCodes
string
关联单据编号,多个以英文逗号分隔
否
assoOrderShortIds
string
关联单据短号,多个以英文逗号分隔
否
receiveTime
string
收货时间,格式:yyyy-MM-dd HH:mm:ss
否
receiveName
string
收货人
否
shelveTime
string
上架时间,格式:yyyy-MM-dd HH:mm:ss
否
shelveName
string
上架人
否
printStatus
int
箱唛打印状态:0=未打印,1=已打印
必填
printNum
int
箱唛打印次数
否
printDate
string
打印时间,格式:yyyy-MM-dd HH:mm:ss
否
traceId
string
链路追踪Id
必填
total
Long
符合查询条件的箱总数
必填
success
boolean
是否成功,示例:true
必填
商品数量沿用箱管理列表口径;正常在库箱随箱内库存变化,其他状态按对应的箱明细返回。
响应示例
示例:已收货、已上架的普通箱
{
"list": [
{
"id": 10001,
"boxCode": "BOX202611190001",
"type": 0,
"source": 0,
"state": 1,
"itemKindNum": 2,
"itemCount": 15,
"warehouseName": "主仓库",
"warehouseId": 100,
"goodsSectionCode": "A-01-01",
"boxTime": "2026-11-19 10:00:00",
"operateBoxName": "张三",
"supplierName": "示例供应商",
"supplierId": 200,
"remark": "示例箱",
"assoOrderType": 0,
"assoOrderCodes": "CG202611190001",
"assoOrderShortIds": "1001",
"receiveTime": "2026-11-19 10:30:00",
"receiveName": "李四",
"shelveTime": "2026-11-19 11:00:00",
"shelveName": "王五",
"printStatus": 1,
"printNum": 2,
"printDate": "2026-11-19 10:10:00"
}
],
"total": 1,
"success": true,
"traceId": "3553483395423660"
}
异常示例
示例:传入的pageNo为0
{
"code": "20001",
"msg": "页码为空或不符合规定",
"success": false,
"trace_id": "3553483395423660"
}
错误码解释
| 错误码 | 错误信息 | 解决方案 |
|---|---|---|
| 20001 | 页码为空或不符合规定 | pageNo应传入大于0的整数,或不传使用默认页码1 |