订单查询(非淘系)
系统相关界面
界面路径:【交易】----【订单查询】
接口备注
此接口不包含淘系订单数据,如需获取淘系订单,需申请奇门appkey获取。注:各平台敏感信息受平台政策影响会有不返回或者加密返回的情况,如有需要接入前可确认 点击前往奇门申请说明
请求地址
环境 | 服务地址(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.list.query
必填
请求参数
全部展开
参数名
类型
描述
必填
默认值
sid
string
系统订单号,多个逗号隔开
tid
string
平台订单号,多个逗号隔开
timeType
string
查询的时间类型:[created:下单时间]--[pay_time:付款时间]--[consign_time:发货时间]--[audit_time:审核时间]--[upd_time:修改时间];与startTime、endTime同时使用,时间跨度建议不超过一天。为空时,默认为付款时间
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
系统异常标签,多个逗号隔开,最多支持十 组
types
string
订单类型,多个逗号0=普通订单;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=出库单
onlyContain
string
异常查询状态:1:仅包含 2:排除 3:同时包含
consignedType
integer
发货方式 0.非ERP发货 1.ERP发货
buyerNick
string
买家ID
queryType
integer
订单查询范围类型 0.三个月内订单 1.三个月之前订单
0
outSids
string
运单号,多个逗号隔开
useHasNext
boolean
传true时不会返回total(不统计总数), 返回hasNext用以判断是否有下一页数据,传false时按原来逻辑只返回total
请求示例
示例一:
{
"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
paymentDiff
double
订单差额=系统实付金额-平台实收金额 区间值
buyerNick
string
平台订单上的买家昵称
threePlTiming
integer
3PL有时效订单标,值true 或者 false
type
string
订单类型,多个逗号0=普通订单;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=出库单
receiverCity
string
收件市
invoiceRemark
string
发票备注
poNos
string
唯品会po单号
packmaCost
double
包材成本
receiverPhone
string
收件人固话
expressCode
string
快递公司的编码
payment
string
应付金额(系统里添加商品会相应增加)
payAmount
string
订单买家已付金额(单位:元)
必填
adjustFee
string
手工调整订单价格
isExcep
integer
是否异常订单 1.异常订单 0.否
exceptIds
string
自定义异常标签,多个逗号隔开
exceptNames
array
自定义异常名称列表
receiverZip
string
收件邮编
isTmallDelivery
integer
天猫直送,值true 或者 false
buyerTaxNo
string
买家税号
isHalt
integer
是否挂起订单 1.是 0.否
warehouseId
long
仓库编号
isRefund
long
1.是 0.否 是否存在退款,退款关闭或者退款成功时该数据不返回
receiverState
string
收件省份
orders
array
订单商品明细集合
sysSkuPropertiesName
string
系统SKU的规格属性名称
discountRate
double
折扣率
discountFee
string
优惠金额
payTime
long
付款时间
numIid
string
平台商品数字编号
num
integer
子订单商品数量
source
string
订单来源 tb,tm,jd,sys
shortTitle
string
商品简称
sysTitle
string
系统商品的标题
type
integer
0 普通商品 1 赠品 是否是赠品不能根据type来判断,而要根据giftNum>0 来判断 2 套件商品 3 组合商品 4 加工商品
suits
array
套件明细(每个套件的实付金额、数量)
sysSkuPropertiesName
string
系统SKU的规格属性名称
discountRate
double
折扣率
discountFee
string
优惠金额
payTime
long
付款时间
numIid
string
平台商品数字编号
num
integer
子订单商品数量
source
string
订单来源 tb,tm,jd,sys
shortTitle
string
商品简称
sysTitle
string
系统商品的标题
type
integer
0 普通商品 1 赠品 是否是赠品不能根据type来判断,而要根据giftNum>0 来判断 2 套件商品 3 组合商品 4 加工商品
cost
double
该商品总成本价
必填
outerSkuId
string
外部skuID
必填
combineId
long
如果是套件单品,则该字段的值为其所属的套件子订单的id,否则为0
必填
payAmount
string
商品买家实付金额
必填
tid
string
所属订单的平台编号
必填
consignTime
long
子订单发货时间
必填
isPresell
integer
是否为预售订单 0:正常订单,1:是预售;2预售转正常;3:系统预售
必填
price
string
商品销售价
必填
updTime
long
数据更新时间
必填
giftNum
integer
赠品的order数量
必填
stockStatus
string
当前子订单的库存状态,如库存正常(NORMAL),库存不足(INSUFFICIENT)
必填
modified
long
子订单平台的修改时间
必填
payment
string
实付金额, 公式: 实付金额 = 应付金额 - 优惠金额
必填
id
long
子订单系统编号
必填
adjustFee
string
手工调整金额
必填
skuId
string
平台规格编号
必填
created
string
下单时间
必填
insufficientCanceled
integer
是否取消库存缺货异常(INSUFFICIENT,EMPTY,EXCEP):0 否,1 是
必填
taobaoId
long
订单店铺的平台ID
必填
sysOuterId
string
系统商家编码,如果是商品则为商品的商家编码,如果为SKU则为SKU的商家编码
必填
saleFee
string
分销金额
必填
picPath
string
平台商品图片链接
必填
volume
double
单个商品体积
必填
sysItemRemark
string
系统规商品备注
必填
companyId
long
公司编号
必填
netWeight
double
子订单中单个商品净重
必填
unit
string
系统商品数量单位
必填
isVirtual
integer
是否虚拟商品,虚拟商品不需要申请库存,发货时也不需要消费库存、归还库存
必填
status
string
子订单平台状态
必填
sysConsigned
integer
是否在系统发货 0.否 1.是 2.其他erp发货
必填
refundStatus
string
子订单退款状态
必填
oid
long
子订单平台编号(淘宝有,京东没有)