查询箱明细
请求地址
| 环境 | 服务地址(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.detail.query
必填
请求参数
全部展开
参数名
类型
描述
必填
id
Long
箱id,可从查询箱列表接口的id字段获取;与boxCode至少传入一个
否
boxCode
string
箱码,精确查询;与id至少传入一个
否
本接口返回单箱全部商品明细,id、boxCode不能同时为空;
请求示例
示例一:按箱id查询明细
{
"id": 10001
}
示例二:按箱码查询明细
{
"boxCode": "BOX202611190001"
}
响应参数
箱内没有商品时,list返回空列表。未查询到对应商品资料时,主商家编码、商品名称等字段可能为空或不返回。
全部展开
参数名
类型
描述
必填
list
array
箱商品明细列表
必填
boxCode
string
箱码
必填
itemOuterId
string
主商家编码
否
outerId
string
商家编码;有规格的商品为规格商家编码,无规格的商品为主商家编码
否
sysItemId
Long
商品id
必填
sysSkuId
Long
规格商品id,无规格商品通常为0
否
title
string
商品名称
否
propertiesName
string
规格名称
否
num
int
装箱数量,沿用箱管理明细口径
必填
traceId
string
链路追踪Id
必填
success
boolean
是否成功,示例:true
必填
商品数量与箱管理明细一致;正常在库箱随箱内库存变化,其他状态按对应的箱明细返回。
响应示例
{
"list": [
{
"boxCode": "BOX202611190001",
"itemOuterId": "ITEM001",
"outerId": "ITEM001-RED-XL",
"sysItemId": 1001,
"sysSkuId": 2001,
"title": "示例商品",
"propertiesName": "红色;XL",
"num": 10
},
{
"boxCode": "BOX202611190001",
"itemOuterId": "ITEM002",
"outerId": "ITEM002-BLUE-L",
"sysItemId": 1002,
"sysSkuId": 2002,
"title": "示例商品二",
"propertiesName": "蓝色;L",
"num": 5
}
],
"success": true,
"traceId": "3553483395423660"
}
异常示例
示例:未传入id和boxCode
{
"code": "25",
"msg": "箱id、箱码不能同时为空",
"success": false,
"trace_id": "3553483395423660"
}
错误码解释
| 错误码 | 错误信息 | 解决方案 |
|---|---|---|
| 25 | 箱id、箱码不能同时为空 | 至少传入id、boxCode中的一个 |
| 25 | 箱id与箱码不匹配 | 确认id、boxCode指向同一箱,或只传其中一个条件 |
| 25 | 当前箱码不存在 | 确认boxCode在当前授权公司下存在 |
| 25 | 根据箱[10001]未找到箱信息! | 10001为示例箱id,请确认传入的id在当前授权公司下存在 |