销售出库查询
系统相关界面
界面路径:【交易】----【订单查询】
请求地址
| 环境 | 服务地址(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
application/x-www-form-urlencoded;charset=UTF-8
必填
API接口地址
全部展开
参数名
类型
描述
必填
method
string
erp.trade.outstock.simple.query
必填
请求参数
全部展开
参数名
类型
描述
必填
默认值
sid
string
系统订单号,多个逗号隔开
tid
string
平台订单号,多个逗号隔开
timeType
string
查询的时间类型:[created:下单时间]--[pay_time:付款时间]--[consign_time:发货时间]--[audit_time:审核时间]--[upd_time:修改时间];与startTime、endTime同时使用,时间跨度建议不超过一天。为空时,默认为修改时间 ,归档订单(queryType参数传1时)不支持audit_time, upd_time
startTime
string
起始时间:格式yyyy-MM-dd HH:mm:ss,与timeType、endTime同时使用,时间跨度建议不超过一天
endTime
string
截止时间:格式yyyy-MM-dd HH:mm:ss,与timeType、startTime同时使用,时间跨度建议不超过一天
userIds
string
店铺ID
pageSize
integer
每页多少条,最大支持200,不能小于20
20
pageNo
integer
页码
1
status
string
系统状态,对应响应参数的sysStatus订单系统状态(支持多个,逗号隔开).WAIT_BUYER_PAY:待付款,WAIT_AUDIT:待审核,WAIT_FINANCE_AUDIT:待财审,FINISHED_AUDIT:审核完成, WAIT_EXPRESS_PRINT:待打印快递单,WAIT_PACKAGE:待打包,WAIT_WEIGHT:待称重,WAIT_SEND_GOODS:待发货, WAIT_DEST_SEND_GOODS:待供销商发货,SELLER_SEND_GOODS:卖家已发货,FINISHED:交易完成,CLOSED:交易关闭
tagIds
string
查询指定标签ID集合,多个逗号隔开,最多支持十组
exceptIds
string
自定义异常标签,多个逗号隔开,最多支持十组
exceptionStatus
string
系统异常标签,多个逗号隔开,最多支持十组
onlyContain
string
异常查询状态:1:仅包含 2:排除 3:同时包含
types
string
订单类型,多个逗号隔开1=货到付款;2=纯平台订单(包含平台单拆出去的手工单);3=平台订单;4=线下订单;5=纯系统手工单(不包含平台单拆出去的手工单);6=预售订单;7=合并订单;8=拆分订单;9=加急订单;10=空包订单;11=合单提示;12=门店订单;13=换货订单;14=补发订单;16=海外仓订单;17=Lazada;18=报损单;19=领用单;20=调整单;21=客户订单;22=天猫直送;23=平台预售;24=京东直发;25=京东供销;33=分销订单;34=供销订单;35=京配订单;38=唯品会订单;37=唯品会订单JIT;36=平台分销;49=拼多多工厂代发;50=天猫淘宝店铺预售;51=抖音厂商代发;53=亚马逊FBA;54=亚马逊FBM;55=亚马逊多渠道;56=奇门订单;57=得物普通现货;58=得物极速现货;60=全款预售;61=得物直发订单;63=淘宝厂商代发订单;68=天猫国际直邮;99=出库单;62=Lazada-FBL;65=BTAS订单;69=阿里代销;0=普通订单;66=平台拆单;39=BIC订单;48=多级分销;46=档口订单;70=花城农夫帮卖订单;15=跨境订单;26=天猫当日发货;27=天猫24小时发货;28=天猫当日达;29=天猫次日达;30=天猫三日达;31=天猫四日达;32=天猫五日达;52=平台分销;72=快麦通代发;73=1688分销小站;74=速卖通全托管;79=TEMU;80=希音;75=分销订单(明确供销商);76=含拆单标记的订单;77=1688分销小站(分销);78=o2o订单
consignedType
integer
发货方式 0.非ERP发货 1.ERP发货
buyerNick
string
买家ID
queryType
integer
0.三个月内订单 1.三个月之前订单
0
outSids
string
运单号,多个逗号隔开
useHasNext
boolean
传true时不会返回total(不统计总数), 返回hasNext用以判断是否有下一页数据,传false时按原来逻辑只返回total
useCursor
boolean
传true时开启游标查询 , 仅queryType不为1时有效
cursor
string
useCursor传true时,第一次查询该参数不传,之后的每次查询传上一次接口返回的cursor
请求示例
示例一:
{
"pageNo": "number",
"userIds": "string",
"timeType": "string",
"pageSize": "number",
"startTime": "string",
"endTime": "string",
"tid": "string",
"sid": "string",
"status": "string"
}
响应参数
全部展开
参数名
类型
描述
必填
success
boolean
示例:true
trace_id
string
示例:3553483395407017
list
array
list
type
string
订单类型,多个逗号1=货到付款; 3=平台订单; 4=线下订单; 6=预售订单; 7=合并订单; 8=拆分订单; 9=加急订单; 10=空包订单; 11=合单提示; 12=门店订单; 13=换货订单; 14=补发订单; 16=海外仓订单; 17=Lazada; 18=报损单; 19=领用单; 20=调整单; 21=客户订单; 22=天猫直送; 23=平台预售; 24=京东直发; 25=京东供销; 33=分销订单; 34=供销订单; 35=京配订单; 36=平台分销; 50=天猫淘宝店铺预售; 51=抖音厂商代发; 53=亚马逊FBA; 54=亚马逊FBM; 55=亚马逊多渠道; 56=奇门订单; 57=得物普通现货; 58=得物极速现货; 60=全款预售; 61=得物直发订单; 62=Lazada-FBL;66=平台拆单 99=出库单
receiverCountry
string
收件国家,跨境订单使用(淘系、拼多多订单不返回)
receiverState
string
收件省份(淘系、拼多多订单不返回)
receiverCity
string
收件市(淘系、拼多多订单不返回)
receiverDistrict
string
收件区县(淘系、拼多多订单不返回)
receiverStreet
string
收件街道(淘系、拼多多订单不返回)
receiverAddress
string
收件详细地址(淘系、拼多多订单不返回)
receiverZip
string
收件邮编(淘系、拼多多订单不返回)
receiverMobile
string
收件人手机号(淘系、拼多多订单不返回)
receiverName
string