跳到主要内容

销售出库单查询

系统相关界面

"界面路径:【仓储】--【波次】--【销售出库单】"

请求地址

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

参数名称参数类型是否必须参数描述
methodstringAPI接口名称
appKeystring分配给应用的AppKey
timestampstring时间戳,时区为GMT+8,例如:2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟
formatstring响应格式。默认为json格式,可选值:json
versionstringAPI协议版本 可选值: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.wave.logistics.order.query
必填

请求参数

全部展开
参数名
类型
描述
必填
默认值
userIds
string
店铺ID列表,多个用逗号分隔
statusList
string
销售出库单状态列表,多个用逗号分隔,10-待处理,20-预处理完成,30-发货中,50-已发货,70-已关闭,90-已作废
timeType
integer
时间类型,1-创建时间,2-发货时间,3-下单时间,4-审核时间,5-承诺时间,6-打印时间 系统单号、内部单号、平台单号、物流单号、波次号为空时,必须设置时间范围查询
timeBegin
long
开始时间(时间戳,单位:毫秒)系统单号、内部单号、平台单号、物流单号、波次号为空时,必须设置时间范围查询
timeEnd
long
结束时间(时间戳,单位:毫秒)系统单号、内部单号、平台单号、物流单号、波次号为空时,必须设置时间范围查询
sids
string
系统单号列表,多个用逗号分隔,最多50个
shortIds
string
内部单号列表,多个用逗号分隔,最多50个
tids
string
平台单号列表,多个用逗号分隔,最多50个
outSids
string
物流单号列表,多个用逗号分隔,最多50个
waveIds
string
波次号列表,多个用逗号分隔,最多50个
pageNo
integer
页码
1
pageSize
integer
每页数量,最大200
40

请求示例

示例一:

{
"timeType": 2,
"timeBegin": 1609459200000,
"timeEnd": 1612137599000,
"userIds": "123456,789012",
"statusList": "10,20,30",
"pageNo": 1,
"pageSize": 40
}

示例二:

{
"timeType": 2,
"timeBegin": 1609459200000,
"timeEnd": 1612137599000,
"userIds": "123456,789012",
"statusList": "10,20,30",
"sids": "202401010001,202401010002",
"shortIds": "SH001,SH002",
"tids": "TB202401010001,TB202401010002",
"outSids": "SF1234567890,SF0987654321",
"waveIds": "1001,1002",
"pageNo": 1,
"pageSize": 40
}

响应参数

全部展开
参数名
类型
描述
必填
list
array
销售出库单列表
id
long
销售出库单id
userId
long
店铺id
shopName
string
店铺名称
sid
string
系统单号
shortId
string
内部单号
tid
string
平台单号
outSid
string
快递单号
createTime
date
创建时间
modifyTime
date
修改时间
outTime
date
出库时间
payTime
date
付款时间
status
integer
销售出库单状态,10-待处理,20-预处理完成,30-发货中,50-已发货,70-已关闭,90-已作废
statusName
string
销售出库单状态名称
receiverCountry
string
收件国家
receiverState
string
收件省
receiverCity
string
收件市
receiverDistrict
string
收件区
receiverStreet
string
收件街道
receiverAddress
string
收件地址
receiverName
string
收件人
receiverMobile
string
收件手机号
receiverPhone
string
收件固话
buyerMessage
string
买家留言
sellerMemo
string
卖家备注
sysMemo
string
系统备注
payment
decimal
订单金额
logisticsCompanyId
long
快递公司id
logisticsCompanyName
string
快递公司名称
netWeight
string
订单净重
volume
string
订单体积
theoryPostFee
string
理论运费
actualPostFee
string
实际运费
warehouseId
long
仓库id
warehouseName
string
仓库名称
waveId
long
波次号
itemNum
integer
商品数量
itemKindNum
integer
商品种类数量
tradeTagList
array
订单标签列表
details
array
销售出库单明细列表
logisticsOrderId
long
销售出库单id
itemOuterId
string
主商品编码
skuOuterId
string
规格商家编码
sysTitle
string
商品名称
sysSkuPropertiesName
string
规格属性
sysPicPath
string
图片链接
num
integer
数量
type
integer
商品类型,1:普通商品,2:套件本身, 3:套件子商品,4:加工商品本身,5:加工子商品,6:组合商品本身,7:组合子商品,8:新版包材商品
isGift
integer
是否赠品,0-否,1-是
isPick
integer
是否拣选验货,0-免拣、免验,1-拣选、免验,2-拣选、验货,3-免拣、验货
isNonConsign
integer
是否不发货,0-否,1-是
isVirtual
integer
是否虚拟商品,0-否,1-是
weight
double
重量
volume
double
体积
priceImport
double
成本价
relatedDetailId
long
关联子订单id
total
long
总记录数
pageNo
integer
当前页码
pageSize
integer
每页数量
success
boolean
是否成功
trace_id
string
追踪ID

响应示例

{
"traceId": "4115985342831359490",
"success": true,
"total": 100,
"pageNo": 1,
"pageSize": 40,
"list": [
{
"id": 123456789,
"userId": 100001,
"shopName": "测试店铺",
"sid": "202401010001",
"shortId": "SH001",
"tid": "TB202401010001",
"outSid": "SF1234567890",
"createTime": "2024-01-01 10:00:00",
"modifyTime": "2024-01-01 11:00:00",
"outTime": "2024-01-01 12:00:00",
"payTime": "2024-01-01 09:00:00",
"status": 30,
"statusName": "发货中",
"receiverCountry": "CN",
"receiverState": "浙江省",
"receiverCity": "杭州市",
"receiverDistrict": "西湖区",
"receiverStreet": "文三路",
"receiverAddress": "文三路123号",
"receiverName": "",
"receiverMobile": "",
"receiverPhone": "",
"buyerMessage": "请尽快发货",
"sellerMemo": "重要客户",
"sysMemo": "系统备注",
"payment": 199.00,
"logisticsCompanyId": 1,
"logisticsCompanyName": "顺丰速运",
"netWeight": "1.5",
"volume": "0.5",
"theoryPostFee": "15.00",
"actualPostFee": "15.00",
"warehouseId": 10,
"warehouseName": "杭州仓",
"waveId": 1001,
"itemNum": 2,
"itemKindNum": 1,
"tradeTagList": [],
"details": [
{
"logisticsOrderId": 123456789,
"itemOuterId": "ITEM001",
"skuOuterId": "SKU001",
"sysTitle": "测试商品",
"sysSkuPropertiesName": "颜色:红色;尺码:L",
"sysPicPath": "https://example.com/pic.jpg",
"num": 2,
"type": 0,
"isGift": 0,
"isPick": 1,
"isNonConsign": 0,
"isVirtual": 0,
"weight": 1.5,
"volume": 0.5,
"priceImport": 100.00,
"relatedDetailId": 987654321
}
]
}
]
}

异常示例

{
"code": "25",
"msg": "服务方法(erp.wave.logistics.order.query:1.0)的签名无效",
"success": false,
"trace_id": "3553483395423660"
}
{
"code": "32",
"msg": "请选择时间类型!",
"success": false,
"trace_id": "3553483395423661"
}
{
"code": "33",
"msg": "单页数量不能超过200!",
"success": false,
"trace_id": "3553483395423662"
}
{
"code": "33",
"msg": "波次号最多不能超过50个",
"success": false,
"trace_id": "3553483395423663"
}
{
"code": "9",
"msg": "销售出库单查询失败!",
"success": false,
"trace_id": "3553483395423664"
}

错误码解释

错误信息错误码解决方案
资源异常,请联系管理员!400检查参数是否合法
销售出库单查询失败!9业务逻辑错误,请联系管理员
请选择时间类型!32未设置单号时,timeType参数必填
请输入开始时间!32未设置单号时,timeBegin参数必填且大于0
请输入结束时间!32未设置单号时,timeEnd参数必填且大于0
单页数量不能超过200!33pageSize参数最大值为200
波次号最多不能超过50个33waveIds参数最多不能超过50个
系统单号最多不能超过50个33sids参数最多不能超过50个
平台单号最多不能超过50个33tids参数最多不能超过50个
内部单号最多不能超过50个33shortIds参数最多不能超过50个
物流单号最多不能超过50个33outSids参数最多不能超过50个

状态说明

销售出库单状态(status):

  • 10:待处理
  • 20:预处理完成
  • 30:发货中
  • 50:已发货
  • 70:已关闭
  • 90:已作废

时间类型(timeType):

  • 1:下单时间
  • 2:付款时间
  • 3:发货时间
  • 4:审核时间
  • 5:修改时间

商品类型(type):

  • 1:普通商品
  • 2:套件本身
  • 3:套件子商品
  • 4:加工商品本身
  • 5:加工子商品
  • 6:组合商品本身
  • 7:组合子商品
  • 8:新版包材商品