出库单查询

系统相关界面

"界面路径：【交易】----【出库单】"

请求地址

环境	服务地址(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.list.query

必填

请求参数

参数名

类型

描述

必填

warehouseIds

string

仓库ID，多个逗号隔开，最多支持20组！

sids

string

系统订单号，多个逗号隔开，最多支持20组！

tids

string

平台订单号，多个逗号隔开，最多支持20组！

status

string

出库单状态 WAIT：待出库订单，FINISH：已出库订单

必填

pageSize

integer

pageSize

pageNo

integer

页码

请求示例

示例一：

{
 "pageNo":"1",
 "pageSize":"10"
}

响应参数

参数名

类型

描述

必填

success

boolean

示例：true

trace_id

string

示例：3553483395407017

total

long

总数

list

array

paymentDiff

double

订单差额=系统实付金额-平台实收金额区间值

buyerNick

string

平台订单上的买家昵称

threePlTiming

integer

3PL有时效订单标，值true 或者 false

type

string

订单类型

receiverCity

string

收件市

invoiceRemark

string

发票备注

poNos

string

唯品会po单号

packmaCost

double

包材成本

receiverPhone

string

收件人固话

expressCode

string

快递公司的编码，不做持久化处理

payment

string

实付金额

payAmount

string

商品买家已付金额

必填

adjustFee

string

手工调整订单价格

isExcep

integer

是否异常订单

receiverZip

string

收件邮编

isTmallDelivery

integer

天猫直送，值true 或者 false

buyerTaxNo

string

买家税号

isHalt

integer

是否挂起订单

warehouseId

long

仓库编号

isRefund

long

是否包含退款订单

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 加工商品

tid

string

所属订单的平台编号

isPresell

integer

是否为预售订单 0:正常订单，1：是预售；2预售转正常；3：系统预售

consignTime

long

子订单发货时间

outerSkuId

string

outer_sku_id

sysSkuPropertiesAlias

string

系统SKU规格属性别名

price

string

商品销售价

updTime

long

数据更新时间

giftNum

integer

赠品的order数量

stockNum

integer

分配的库存数量

stockStatus

string

当前子订单的库存状态,如库存正常(NORMAL),库存不足(INSUFFICIENT)

modified

long

子订单平台的修改时间

payment

string

实付金额, 公式: 实付金额 = 应付金额 - 优惠金额

payAmount

string

商品买家已付金额

必填

long

子订单系统编号

adjustFee

string

手工调整金额

skuId

string

平台规格编号

created

long

下单时间

insufficientCanceled

integer

是否取消库存缺货异常（INSUFFICIENT,EMPTY,EXCEP）：0 否，1 是

taobaoId

long

订单店铺的平台ID

diffStockNum

integer

缺货数量=num-stockNum（不需要持久化）

sysSkuRemark

string

系统规格备注

sysOuterId

string

系统商家编码，如果是商品则为商品的商家编码，如果为SKU则为SKU的商家编码

saleFee

string

分销金额

exceptions

array

子订单异常信息

volume

double

单个商品体积

picPath

string

平台商品图片链接

sysItemRemark

string

系统规商品备注

companyId

long

公司编号

unit

string

系统商品数量单位

netWeight

double

子订单中单个商品净重

osGiftCount

string

前N有礼赠品数量

oldStatus

string

子订单旧的平台状态，不做持久化，一般用于订单同步更新时的判断比较

warehouseId

long

子订单商品库存操作时的仓库ID,要保证与所属trade中的warehouseId一致

isVirtual

integer

是否虚拟商品，虚拟商品不需要申请库存，发货时也不需要消费库存、归还库存

status

string

子订单平台状态

sysConsigned

integer

是否在系统发货 1 是，0 否

soid

string

子订单平台编号（由于某些平台的子订单号为字符类型，需要用此字段保存，后续可将oid修改为String类型）

refundStatus

string

子订单退款状态 CLOSED：退款关闭 NO_REFUND：未退款 SELLER_CONTINUE_CONSIGN：卖家已发货退款 SELLER_REFUSE_BUYER：卖家拒绝退款 WAIT_SELLER_AGREE：待卖家同意退款 WAIT_BUYER_RETURN_GOODS：待买家退货 WAIT_SELLER_CONFIRM_GOODS：待卖家确认收货 SUCCESS：退款成功

oid

long

子订单平台编号(淘宝有,京东没有)

itemSysId

long

匹配到的系统商品ID

title

string

商品标题

sid

long

所属主订单的系统编号

forcePackNum

integer

强制验货数量

acPayment

string

不变的实付金额, 进来后不变

sysStatus

string

订单系统状态

sysItemOuterId

string

系统主商家编码，暂不做持久化

osSortNum

string

前N有礼中奖名次，获得奖品的订单才会有该字段

skuPropertiesName

string

规格属性名

skuUnit

string

系统规格计量单位

cost

double

商品成本价 cost*num 该商品总成本价

isCancel

integer

是否作废，未发货的子订单与所属的trade保持一致

salePrice

string

分销价格

oldPrice

string

原商品销售价，在套件转单品去匹配赠品时候使用

identCode

string

识别码

combineId

long

如果是套件单品,则该字段的值为其所属的套件子订单的id,否则为0

userId

long

订单所属店铺用户ID

ptConsignTime

long

平台发货时间

totalFee

string

应付金额, 公式: 应付金额 = 商品数量 * 商品单价 + 手工调整价

sysPicPath

string

系统商品图片链接

skuSysId

long

匹配到的系统规格ID

outerId

string

商家编码，不做持久化，仅仅只是为了系统订单添加商品使用

endTime

long

子订单的交易结束时间

estimateConTime

long

预计发货时间

refundId

string

平台退款编号

divideOrderFee

string

平台实付(平台分摊之后的实付金额)

必填

orderExt

object

order扩展信息

必填

orderRemark

string

订单商品备注

必填

orderStockProducts

list

生产信息

必填

batchNo

string

批次号

必填

productionDate

long

生产日期

必填

expressCompanyId

long

快递公司的编号，不做持久化处理

status

string

订单的平台状态

isUrgent

integer

是否是加急订单

theoryPostFee

double

理论运费

warehouseName

string

仓库名称

hasSuit

boolean

是否含有套件

itemNum

integer

订单下的商品数量

sourceTrade

object

sourceTrade

receiverDistrict

string

收件区县

taxFee

string

税费

isHandlerMessage

integer

是否处理买家留言： 0：未处理 1：已处理

grossProfit

double

毛利润

postFee

string

邮费

receiverMobile

string

收件人手机号

singleItemKindNum

integer

商品单品种类, 最小粒度

userId

long

店铺用户编号

itemKindNum

integer

订单下的商品种类数

exceptMemo

string

异常备注

ptConsignTime

long

平台发货时间

buyerMessage

string

平台订单上的买家留言

unifiedStatus

string

各平台状态映射后的统一状态

excep

long

订单级别的系统异常，参考itemExcep 目前不明确供销商”、“分销商反审核”、“分销商未付款“

shortId

long

订单短号

discountFee

string

优惠

sellerFlagString

string

匹配规则用，用逗号分开

payTime

long

付款时间

mobileTail

string

手机后四位尾号

source

string

订单来自哪个平台，例如 tb(淘宝或者天猫平台),jd(京东平台),sys(系统手工订单)

tradePurchaseAmount

double

订单实收金额

tid

string

平台订单号

invoiceFormat

integer

发票类型 1普通 2增值

consignTime

long

发货时间

isPresell

integer

是否为预售订单：0:正常订单，1：是预售；2预售转正常；3：系统预售

receiverCountry

string

收件国家，跨境订单使用

updTime

long

数据库最后更新时间

stockStatus

string

库存状态

modified

string

订单在平台上的修改时间

invoiceType

string

发票类型

created

long

下单时间

taobaoId

long

平台的卖家账户

weight

double

重量

auditMatchRule

integer

智能审核规则匹配结果

sysOuterId

string

订单下第一个匹配系统商品的子订单的系统商家编码，若都没有匹配，则直接取第一个商品的平台商家编码

saleFee

string

分销金额

exceptions

array

订单的异常信息

outSid

string

运单号

receiverAddress

string

收件详细地址

volume

double

订单体积

companyId

long

公司编号

netWeight

double

订单净重，由子订单综合计算得出，参照Order#netWeight

sellerMemo

string

平台上的卖家备注

chSysStatus

string

订单系统状态的中文说明

destName

string

订单归属于哪里分销系统里记为供销商nname（不持久化）

invoiceName

string

发票抬头

subSource

string

次来源地 jd 保存订单来源

sysMemo

string

订单系统备注

shopName

string

店铺名称

sid

long

系统订单号

cancelFrom

integer

供销订单使用,分销作废来源 0,取消分销属性 1，分销订单作废

sysStatus

string

订单的系统状态，平台订单的系统状态由所有平台子订单综合计算得出

manualPaymentAmount

double

手工支付金额

fxIsUpload

integer

分销订单是否在系统上传（供销订单用）

promiseService

string

承诺服务类型，会有多个服务值，以英文半角逗号","切割，其中 tmallpromise.arrival.timing 代表到货承诺时效 tmallpromise.consign.timing代表发货承诺时效

cost

double

订单总成本价,所有商品总成本价之和

isCancel

integer

是否为作废订单

receiverName

string

收件人姓名

timeoutActionTime

long

平台timeout_action_time

isHandlerMemo

integer

是否处理卖家备注： 0：未处理 1：已处理

isCancelDistributorAttribute

integer

是否是取消分销属性触发的订单同步，如果是1，则不需要匹配供应商，因为是取消分销属性

tradeFrom

string

订单来源，例如手机端或者PC端

platformPaymentAmount

double

平台支付金额

totalFee

string

总额

needInvoice

integer

需要开具发票 1开启，0关闭

wlbTemplateType

integer

供销订单用

timingPromise

string

服务身份标识

sourceName

string

订单来源于哪里分销系统里记为分销商name（不持久化）

invoiceKind

string

发票种类（ 1 电子发票 2 纸质发票）

endTime

long

完结时间

必填

acPayment

string

不变的实付金额

必填

scalping

integer

是否空单; 1=是; 0=否;

必填

tradeTags

array

订单自定义标签集合

必填

long

标签id

必填

tagName

string

标签名称

必填

remark

string

标签备注

必填

type

Integer

标签类型: 0普通标签, 1自定义异常, 2便签, 3系统标签

必填

splitType

integer

拆单类型 -1:未拆单 1:拆单

必填

splitSid

long

如果split_type等于1。则对应拆单的主单的sid。否则为0

必填

templateId

long

快递模板id

必填

templateName

string

快递模板名称

必填

isPackage

integer

订单是否打包

必填

expressCompanyName

string

快递公司名称

必填

响应示例

{
    "total":"int",
    "list":[{
	"paymentDiff": "int",
	"buyerNick": "string",
	"threePlTiming": "int",
	"type": "string",
	"receiverCity": "string",
	"invoiceRemark": "string",
	"poNos": "string",
	"packmaCost": "int",
	"receiverPhone": "string",
	"expressCode": "string",
	"payment": "string",
	"adjustFee": "string",
	"isExcep": "int",
	"receiverZip": "string",
	"isTmallDelivery": "int",
	"buyerTaxNo": "string",
	"isHalt": "int",
	"warehouseId": "int",
	"isRefund": "int",
	"receiverState": "string",
	"expressCompanyId": "int",
	"status": "string",
	"isUrgent": "int",
	"theoryPostFee": "int",
	"warehouseName": "string",
	"hasSuit": "bool",
	"itemNum": "int",
	"sourceTrade": {}
	"receiverDistrict": "string",
	"taxFee": "string",
	"isHandlerMessage": "int",
	"grossProfit": "int",
	"postFee": "string",
	"receiverMobile": "string",
	"singleItemKindNum": "int",
	"userId": "int",
	"itemKindNum": "int",
	"exceptMemo": "string",
	"ptConsignTime": long,
	"buyerMessage": "string",
	"unifiedStatus": "string",
	"excep": "int",
	"shortId": "int",
	"discountFee": "string",
	"sellerFlagString ": "string",
	"payTime": long,
	"mobileTail": "string",
	"source": "string",
	"tradePurchaseAmount": "int",
	"tid": "string",
	"invoiceFormat": "int",
	"consignTime": long,
	"isPresell": "int",
	"receiverCountry": "string",
	"updTime": long,
	"stockStatus": "string",
	"modified": "string",
	"invoiceType": "string",
	"created": long,
	"taobaoId": "int",
	"weight": "int",
	"auditMatchRule": "int",
	"sysOuterId": "string",
	"list": [{
		"sysSkuPropertiesName": "string",
		"discountRate": "int",
		"discountFee": "string",
		"payTime": long,
		"numIid": "string",
		"num": "int",
		"source": "string",
		"shortTitle": "string",
		"sysTitle": "string",
		"type": "int",
		"tid": "string",
		"isPresell": "int",
		"consignTime": long,
		"outerSkuId": "string",
		"sysSkuPropertiesAlias": "string",
		"price": "string",
		"updTime": long,
		"giftNum": "int",
		"stockNum": "int",
		"stockStatus": "string",
		"modified": "string",
		"payment": "string",
		"id": "int",
		"adjustFee": "string",
		"skuId": "string",
		"created": long,
		"insufficientCanceled": "int",
		"taobaoId": "int",
		"diffStockNum": "int",
		"sysSkuRemark": "string",
		"sysOuterId": "string",
		"saleFee": "string",
		"exceptions": ["string", "first"
			"string", "second"
			"string", "third"
		],
		"volume": "int",
		"picPath": "string",
		"sysItemRemark": "string",
		"companyId": "int",
		"unit": "string",
		"netWeight": "int",
		"osGiftCount": "string",
		"oldStatus": "string",
		"warehouseId": "int",
		"isVirtual": "int",
		"status": "string",
		"sysConsigned": "int",
		"soid": "string",
		"refundStatus": "string",
		"oid": "int",
		"itemSysId": "int",
		"title": "string",
		"sid": "int",
		"forcePackNum": "int",
		"acPayment": "string",
		"sysStatus": "string",
		"sysItemOuterId": "string",
		"osSortNum": "string",
		"skuPropertiesName": "string",
		"skuUnit": "string",
		"cost": "int",
		"isCancel": "int",
		"salePrice": "string",
		"oldPrice": "string",
		"identCode": "string",
		"combineId": "int",
		"userId": "int",
		"ptConsignTime": long,
		"totalFee": "string",
		"sysPicPath": "string",
		"skuSysId": "int",
		"outerId": "string",
		"endTime": "string",
		"estimateConTime": "string",
		"refundId": "string",
	}]
	"saleFee": "string",
	"exceptions": ["string", "first"
		"string", "second"
		"string", "third"
	]
	"outSid": "string",
	"receiverAddress": "string",
	"volume": "int",
	"companyId": "int",
	"netWeight": "int",
	"sellerMemo": "string",
	"chSysStatus": "string",
	"destName": "string",
	"invoiceName": "string",
	"subSource": "string",
	"sysMemo": "string",
	"shopName": "string",
	"sid": "int",
	"cancelFrom": "int",
	"sysStatus": "string",
	"manualPaymentAmount": "int",
	"fxIsUpload": "int",
	"promiseService": "string",
	"cost": "int",
	"isCancel": "int",
	"receiverName": "string",
	"timeoutActionTime": "string",
	"isHandlerMemo": "int",
	"isCancelDistributorAttribute": "int",
	"tradeFrom": "string",
	"platformPaymentAmount": "int",
	"totalFee": "string",
	"needInvoice": "int",
	"wlbTemplateType": "int",
	"timingPromise": "string",
	"sourceName": "string",
	"invoiceKind": "string",
}],
	"success": "boolean",
	"trace_id": "long"
}

异常示例

{
    "code": "25",
    "msg": "服务方法(erp.trade.outstock.list.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}

错误码解释

错误码	错误信息	解决方案
400	资源异常,请联系管理员!	检查参数是否合法
50	非法参数!	检查参数类型等是否合法
20017	仓库ID数量最大支持20组!	检查参数是否合法
20009	系统订单号数量最大支持20组！	检查参数是否合法
20010	平台订单号格式不正确	检查参数是否合法
20018	平台订单号数量最大支持20组!	检查参数是否合法
50	出库单状态不合法！[WAIT：待出库订单，FINISH：已出库订单]字段：[status];	检查参数是否合法
20002	页数为空或不符合规定	检查参数是否合法
30076	出库单查询失败	检查参数是否合法

系统相关界面​

请求地址​

公共参数​

请求头​

API接口地址​

请求参数​

请求示例​

响应参数​

响应示例​

异常示例​

错误码解释​

系统相关界面

请求地址

公共参数

请求头

API接口地址

请求参数

请求示例

响应参数

响应示例

异常示例

错误码解释