查询唯一码
系统相关界面
"界面路径:【仓储】----【唯一码管理】"
请求地址
环境 | 服务地址(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都必须传入的参数,目前支持的公共参数有:
参数名称 | 参数类型 | 是否必须 | 参数描述 |
---|---|---|---|
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
application/x-www-form-urlencoded;charset=UTF-8
必填
API接口地址
参数名
类型
描述
必填
method
string
erp.item.unique.code.query
必填
请求参数
参数名
类型
描述
必填
默认值
sids
string
系统订单号,多个逗号隔开,最多支持20组
shortIds
string
内部单号,多个逗号隔开,最多支持20组
afterSaleOrderCodes
string
售后单号,多个逗号隔开,最多支持20组
uniqueCodes
string
唯一码号,多个逗号隔开,最多支持20组
updateStart
string
波次唯一码更新时间-起始 格式:yyyy-MM-dd HH:mm:ss
updateEnd
string
波次唯一码更新时间-截止 格式:yyyy-MM-dd HH:mm:ss
consignStart
string
订单发货时间-起始 格式:yyyy-MM-dd HH:mm:ss
consignEnd
string
订单发货时间-截止 格式:yyyy-MM-dd HH:mm:ss
noNeedTotal
boolean
是否不需要查询总数(默认为false会查询总数。分页调取时,除了第一次调用需要总数,后面的几次都不需要再获取总数,可以传true,接口速度会更快)
codeType
integer
唯一码类型 1(单);2(多);3(备)
createStart
string
波次唯一码创建时间-起始 格式:yyyy-MM-dd HH:mm:ss
createEnd
string
波次唯一码创建时间-截止 格式:yyyy-MM-dd HH:mm:ss
waveId
long
波次号
type
integer
唯一码类型,0 波次唯一码;1(订单唯一码);2(商品唯一码)
pageSize
int
页数, 默认40,最大支持500
pageNo
int
页码
请求示例
示例一:
{
"pageNo":1,
"pageSize":40
}
响应参数
参数名
类型
描述
必填
list
array
唯一码列表
codeType
integer
默认0;1(单);2(多);3(备)
orderId
long
子订单id
created
long
创建时间
sysItemId
long
系统主商品ID
refundStatus
string
WAIT_SELLER_AGREE --待卖家同意退款 WAIT_BUYER_RETURN_GOODS--待买家退货 WAIT_SELLER_CONFIRM_GOODS--待卖家确认收货 SELLER_REFUSE_BUYER--卖家同意退款 CLOSED--退款关闭 SUCCESS--退款成功 NO_REFUND--未退款
positionStockRegion
string
分拣库区
sid
long
系统订单号
sysSkuId
long
系统商品skuID (注意,纯商品是-1)
uniqueCode
string
唯一码
modified
long
修改时间
outerId
string
平台商家编码
positionNo
string
分拣货位
printTime
long
打印时间
status
integer
唯一码状态 1-等待采购, 2-等待拣选, 3-已拣选, 4-等待收货, 5-已收货, 6-已出库, 7-已取消, 8-已下架, 9-已出库未收货, 10-待入库, 11-在库, 12-已作废, 13-已验货, 14-已退回, 15-已采退
waveId
long
波次号
必填
ICCID
string
iccid编码
必填
serialNumberStr
string
唯一码流水号
必填
mainOuterId
string
主商家编码
必填
skuOuterId
string
规格商家编码
必填
sellingPrice
double
销售价
必填
costPrice
double
成本价
必填
weight
double
重量
必填
itemBatchNo
string
商品批次号
必填
productionDate
date
效期
必填
itemPeriodCast
string
主商品保质期
必填
skuPeriodCast
string
规格商品保质期
必填
warehouseId
long
仓库id
必填
stockPosition
integer
库存位置
必填
goodsSectionId
long
货位id
必填
goodsSectionCode
string
货位编码
必填
boxCode
string
箱码
必填
printNum
integer
打印次数
必填
customPrintTime
date
自定义打印时间
必填
afterSaleOrderCode
string
售后工单编号
必填
saleReturnOrderCode
string
销退入库单编号
必填
warehouseEntryCode
string
关联收货单
必填
purchaseReturnCode
string
采退单
必填
businessCode
string
采购单
必填
otherWarehousingOrderCode
string
其他入库单编号
必填
otherOutboundOrderCode
string
其他出库单编号
必填
success
boolean
示例:true
trace_id
string
示例:3553483395407017
total
long
总数
响应示例
{
"traceId": "3669319614952014527",
"list": [
{
"iCCID": "ICCID",
"codeType": 3,
"orderId": 0,
"sysItemId": 607817348897280,
"num": 1,
"goodsSectionId": 0,
"sellingPrice": 0.0,
"productionDate": 1718726400000,
"uniqueCode": "baolsOpen124",
"modified": 946656000000,
"boxCode": "boxCode",
"serialNumberStr": "33-3",
"printNum": 0,
"created": 1718784620000,
"costPrice": 0.0,
"waveId": 0,
"itemPeriodCast": "0",
"stockPosition": 2,
"itemBatchNo": "itemBatchNo",
"sysSkuId": 0,
"mainOuterId": "baolsOpen1",
"warehouseId": 69583,
"outerId": "baolsOpen1",
"status": 5
}
],
"total": 1,
"success": true
}
异常示例
{
"code": "25",
"msg": "服务方法(erp.item.unique.code.query:1.0)的签名无效",
"success": false,
"trace_id": "3553483395423660"
}
错误码解释
错误信息 | 错误码 | 解决方案 |
---|---|---|
资源异常,请联系管理员! | 400 | 检查参数是否合法 |
非法参数! | 50 | 检查参数类型等是否合法 |
系统订单号数量最大支持20组! | 20003 | 参数过长 |
内部单号数量最大支持20组! | 20005 | 参数过长 |
售后单号数量最大支持20组! | 20006 | 参数过长 |
唯一码类型不合法![1(单);2(多);3(备)] | 50 | 枚举值不合法 |
是否查询总数枚举值不合法![true/false] | 50 | 枚举值不合法 |
系统订单号格式不正确! | 20009 | 检查参数是否合法 |
内部订单号格式不正确 | 20011 | 检查参数是否合法 |
售后单号格式不正确 | 20012 | 检查参数是否合法 |