当前位置: API文档

wms.stockout.Sales.queryWithDetail(销售出库单查询)

¥标准

1.接口说明

1.1 接口描:获取ERP销售出库单信息
1.2 适用版本:客户端 V1.4.1.3及以上版本
1.3 增量获取:支持
1.4 时间跨度:start_time和end_time最大跨度为60分钟。

1.5注意事项:权限校验:【店铺、仓库权限】

为了达到保护用户隐私数据安全的目的本接口不返回淘系及系统供销平台订单数据相关平台规则点击这里淘系及系统供销平台数据获取办法点击这里

本接口中涉及到用户隐私的字段数据仅有自有平台及线下平台订单返回。具体字段详情见下面表格;


通过从后往前翻页的方式可以避免漏单问题。

字段描述字段名
客户网名
nick_name
收件人姓名receiver_name
收件地址receiver_address
收件人手机receiver_mobile
收件人固话
receiver_telno
客户姓名customer_name
证件号码id_card

2.调用场景

2.1 举例说明:财务系统、SAP、数据分析等系统的对接

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境http://47.92.239.46/openapi
正式环境http://wdt.wangdian.cn/openapi

  3.2 公共请求参数

名称字段类型长度
必须描述
卖家账号sidString
卖家账号, 由旺店通分配
接口账号keyString
由旺店通分配appkey, 在发送的数据中对应 key 字段
saltString
由旺店通分配appsecret,是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt.
接口名称methodString
调用的接口名称
版本号vString
1.0
秒级时间戳timestampInt
秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。
签名signString
签名
分页大小page_sizeInt
分页大小,分页查询必传
分页编号page_noInt
分页编号,分页查询必传,标准接口page_no从0开始
是否计算查询结果的总条数calc_totalInt
是否计算查询结果的总条数, 需要计算则1, 否则填0         

    3.3 业务请求参数

名称字段类型长度
必须描述
查询参数

params

Map<String, Object>
Y

查询参数

分页

pager

pager
Y

分页

params

名称字段类型长度
必须描述
开始时间

start_time

String

40y起始时间, status_type =1,2,3 按照出库单修改时间查询, status_type=0 按照发货时间查询
结束时间end_timeString40y
结束时间
出库单状态

status_type

Int

4y出库单状态: 默认值为0

1.已取消

2.在企业版状态中对应status=55(已确认),这里为 待分配~延时发货(此条件会返回延时发货状态的订单)

3.按照指定的status状态字段查询

0.延时发货&已完成

出库单状态详细

status

String


y

传status_type=3情况下,按照修改时间和status查询

(status_type=3的情况下,若不传status字段,按照发货时间查询)

出库单状态若多个状态则以“,”隔开:  

5已取消

10待放回(拣货待放回), 小于该值的都是已取消的单子

51 缺货

53 WMS已接单

54 获取电子面单

60 待分配

61 排队中

63 待补货

65 待处理  

70 待发货

73 爆款锁定

75 待拣货

77 拣货中,PDA拣货后

79 已拣货

90 延时发货

110已完成

仓库编号

warehouse_no

String

40n

仓库编号

出库单号

stockout_no

String20n出库单号
店铺编号shop_nosString
n多个店铺编号使用英文逗号分隔
销售订单号src_order_noString40n系统订单号(ERP订单号)
物流单号
logistics_noString40n物流单号(存在匹配的出库单时,可以不传时间条件)
是否返回sn信息need_snbool
n

true:返回

false:不返回

是否按照货位排序positionInt
n等于0为否,不等于0为是,不填为否
是否使用从库查询is_slaveboolean1n

使用:true  不使用:false

(仅对开通从库配置客户生效)

pager

名称字段类型长度
必须描述
分页大小

page_size

Int

4n

分页大小

页号

page_no

Int4n从0开始

4.响应参数

   4.1 公共响应参数

名称字段类型长度
必须描述
状态码

status

Int
y

状态码,0表示调用成功

错误信息

message

String


y

无错误信息不返回

出库单信息

data

Map<String, Object>


n

出库信息

data

名称字段类型长度
必须描述
总数total_countInt11n查询条件总单据数
单据数据orderList<Map<String, Object>>
y出库单相关数据

order

名称字段类型长度
必须描述
出库单ID

stockout_id

Int

11y出库单ID
出库单号order_noString40y
出库单号

系统订单编号

src_order_no

String

40yERP系统订单编号

仓库编号

warehouse_no

String

40
y仓库编号

仓库名称

warehouse_name

String

64
y仓库名称
出库时间

consign_time

String

40
y出库时间,例如:2020-09-23 14:56:18
源单据类别

order_type

Int

4
y

1销售订单

货品数量goods_countDecimal(19,4)
y货品数量
物流单号
logistics_noString50y物流单号
收件人姓名receiver_nameString100
y收件人姓名仅自有平台及线下平台返回,其他平台均不返回
国家receiver_countryInt11y国家
省份IDreceiver_provinceInt11y省份ID,点击查看城市代码表
城市IDreceiver_cityInt11y城市ID,点击查看城市代码表
地区IDreceiver_districtInt11y地区ID,点击查看城市代码表
地址receiver_addressString256
y地址,不包含省市区,仅自有平台及线下平台返回,其他平台均不返回
收件人手机receiver_mobileString40
y收件人手机仅自有平台及线下平台返回,其他平台均不返回
收件人固话receiver_telnoString100
y收件人固话仅自有平台及线下平台返回,其他平台均不返回
收件人邮编receiver_zipString20
y收件人邮编
省市区receiver_areaString128
y省市区空格分隔
出库单备注remarkString255
y出库单备注
重量weightDecimal(19,4)
y实际称得重量KG
截停原因block_reasonInt11y

截停原因:

0正常

1申请退款

2已退款

4地址被修改

8发票被修改

16物流被修改

32仓库变化

64备注修改

128更换货品

256取消退款

物流方式logistics_typeInt6y物流方式,点击物流代码表查看
物流编号logistics_codeString40yERP物流编号(查看路径:旺店通客户端设置--基本设置--物流)
物流公司名称logistics_nameString40
y物流公司名称
店铺id
shop_idInt6y店铺id
仓库id
warehouse_idInt6y仓库id
物流idlogistics_idInt6y物流id
异常原因bad_reasonInt4y异常原因:  

0正常

1无库存记录

2地址发生变化

4发票变化

8仓库变化

16备注变化

32平台更换货品

64退款

大头笔receiver_dtbString128y大头笔
退款状态refund_statusInt4y

退款状态:

0无退款

1申请退款

2部分退款

3全部退款

销售类型trade_typeInt4y

销售类型:

1网店销售

2线下零售

3售后换货

4批发业务

7现款销售

8分销订单

101 订单自定义属性1

102 订单自定义属性2

103 订单自定义属性3

104 订单自定义属性4

105 订单自定义属性5

106 订单自定义属性6

业务员编号salesman_noString40y业务员为"系统"时不返回
业务员姓名fullnameString40
y业务员为"系统"时不返回
订单状态trade_statusInt4y

订单状态:  

4 线下退款

5已取消

6 待转预订单(待审核)

7 待转已完成

10未付款

12待尾款

15等未付

16延时审核

19预订单前处理

20 审核前处理

21自流转待发货

23 异常预订单

24 换货预订单

25 待处理预订单

27待分配预订单 

30待客审

35待财审

55已审核

95已发货

96 成本确认(待录入计划成本,订单结算时有货品无计划成本)

101 已过账

110已完成

订单编号trade_noString40y订单编号
原始单号src_trade_noString255y原始单号(如果有多个,以","分隔且以增序排列,不重复,过长将被裁剪)
客户网名
nick_nameString100
y客户网名仅自有平台及线下平台返回,其他平台均不返回
客户编码customer_noString40
y客户编码
客户姓名customer_nameString100y客户姓名仅自有平台及线下平台返回,其他平台均不返回
下单时间trade_timeString40
y下单时间(毫秒级时间戳,例如:1631861379000)
支付时间pay_timeString40
y支付时间(毫秒级时间戳,例如:1631861379000)
标记名称flag_nameString32
y标记名称
邮费post_amountDecimal(19,4)
y邮费/订单邮费
证件类别id_card_typeInt4
y证件类别
证件号码id_cardString40
y证件号码仅自有平台及线下平台返回,其他平台均不返回
店铺名称shop_nameString128
y店铺名称
店铺编号shop_noString20
y店铺编号
店铺备注shop_remarkString255
y店铺备注
出库单状态statusInt4y

出库单状态:  

5已取消

10待放回(拣货待放回), 小于该值的都是已取消的单子

51 缺货

53 WMS已接单

54 获取电子面单

60 待分配

61 排队中

63 待补货

65 待处理  

70 待发货

73 爆款锁定

75 待拣货

77 拣货中,PDA拣货后

79 已拣货

90 延时发货

110已完成

发票类别invoice_typeInt4
y

发票类别:

0不需要

1普通发票

2增值税发票

发票IDinvoice_idInt11y

发票id:

目前只设0-1,

1表示已开发票

货到付款金额cod_amountDecimal(19,4)
y货到付款金额
发货条件delivery_termInt4y

发货条件:

1款到发货

2货到付款(包含部分货到付款)

3分期付款

平台IDplatform_idInt11y平台ID(请点击平台代码表查看对应关系
订单IDtrade_idInt11y订单ID
审核员编号employee_noString40y审核员编号
优惠金额discountDecimal(19,4)
y优惠金额(订单总优惠)
税额taxDecimal(19,4)
y税额
税率tax_rateDecimal(19,4)
y税率
币种currencyString20y币种
建单时间createdString 40
y系统订单建单时间(毫秒级时间戳,例如:1631861379000)
出库单建单时间stock_check_timeString40y出库单建单时间(毫秒级时间戳,例如:1631861379000)
打印备注print_remarkString1000
y打印备注
买家留言buyer_messageString255
y买家留言
客服备注cs_remarkString1024y客服备注
发票抬头invoice_titleString255y发票抬头
发票内容invoice_contentString255y发票内容
称重预估邮资
post_feeDecimal(19,4)
y

称重预估邮资

(使用根据重量预估的邮费)

包装成本package_feeDecimal(19,4)
y包装成本(使用包装的计划成本)
已付金额receivableDecimal(19,4)
y已付金额(使用应收金额)
总成本价goods_total_costDecimal(19,4)
y总成本价
预估货品成本

goods_total_amount

Decimal(19,4)
y预估货品成本
最后修改时间

modified

String40y最后修改时间,例如:2021-09-23 15:56:18
分销商昵称

fenxiao_nick

String40y分销商昵称
订单标签

trade_label

String255y订单标签
订单来源

trade_from

Int4y

订单来源:

1、API抓单

2、手工建单

3、Excel导入

4、复制订单

5、接口推送

6、补发订单

7、PDA选货开单

8、分销补发订单

分拣波次

picklist_no

String40
y分拣波次
分拣序号

picklist_seq

Int6y分拣序号
物流单打印状态

logistics_print_status

Int4y

0:未打

1:打印中

2:已打印

3:无需打印

物流单列表

logistics_list

List<Map<String, Object>>
y物流单详情
销售出库单详情details_listList<Map<String, Object>>
y销售出库单详情

logistics_list

名称字段类型长度
必须描述
物流单id

rec_id

Int
11y

销售出库单详情id

出库单id

stockout_id

Int

11
y

出库单id

物流单号

logistics_no

String

40
y

物流单号

估算重量

calc_weight

Decimal(19,4)
y估算重量
称重重量
weightDecimal(19,4)
y称重重量
包装
package_name
String
40y包装
物流名称
logistics_nameString40y物流名称
物流IDlogistics_idInteger6y物流ID 
估算邮资postageBigDecimal19,4y估算邮资
备注remarkBigDecimal256y备注
lengthBigDecimal19,4y
widthBigDecimal19,4y
heightBigDecimal19,4y
体积volumeBigDecimal19,4y长*宽*高

details_list

名称字段类型长度
必须描述
销售出库单详情的id

rec_id

Int

11

y销售出库单详情的id
出库单id

stockout_id

Int

11y出库单id
订单明细idsrc_order_detail_idint11Y订单明细id
规格id

spec_id

Int

11y规格id
商家编码spec_noString40Y商家编码
货品数量

goods_count

Decimal(19,4)


y货品数量:  如果按照货位分组就是总货品数量
总成本

total_amount

Decimal(19,4)


y

总成本: 成本价*货品数量

成交价

sell_price

Decimal(19,4)


y成交价(当订单货品发生变更导致价格变化,该值不变,若需获取ERP销售出库明细中的货品成交价取share_price字段)
出库单明细备注

remark

String

255

y出库单明细备注
货品名称

goods_name

String

255

y货品名称
货品编号

goods_no

String

40

y货品编号
规格名称

spec_name

String

100

y规格名称
规格码

spec_code

String

40

y规格码
货品成本

cost_price

Decimal(19,4)


y

货品成本

总重量

weight

Decimal(19,4)

11

y总重量
货品id

goods_id

Int

11

y货品id
规格自定义属性1

prop1

String

255

y规格自定义属性1
规格自定义属性2

prop2

String

255

y规格自定义属性2
规格自定义属性3

prop3

String

255

y规格自定义属性3
规格自定义属性4

prop4

String

255

y规格自定义属性4
规格自定义属性5

prop5

String

255

y规格自定义属性5
规格自定义属性6

prop6

String

255

y规格自定义属性6
平台idplatform_id

Int

6y平台id,点击查看平台代码表
退款状态

refund_status

Int

4

y

退款状态:

0无退款

1取消退款,

2已申请退款

3等待退货

4等待收货

5退款成功---(原始子订单关闭,这里也是退款状态)

单价/货品原单价

market_price

Decimal(19,4)


y单价/货品原单价
货品总优惠

discount

Decimal(19,4)


y货品总优惠
货品成交价share_priceString

y系统销售出库明细对应的货品成交价
总货款/货品成交总价
share_amount

Decimal(19,4)


y总货款/货品成交总价
税率

tax_rate

Decimal(8,4)


y税率
主条码

barcode

String

50

y主条码
单位名称

unit_name

String

20

y单位名称
订单货品(子订单)id

sale_order_id

Int

11y订单货品(子订单)id
是否是赠品

gift_type

Int

11

y

是否是赠品:

0非赠品

1自动赠送

2手工赠送

4周期购赠送

8平台赠送

原始子订单号

src_oid

String

40

y原始子订单号
原始订单号

src_tid

String

40

y原始订单号
订单内部来源

from_mask

Int

11

y

订单内部来源:

1手机

2聚划算

货品类型

goods_type


Int

4

y

货品类型:

0:其它

1:销售货品

2:原材料

3:包装物

4:周转材料

5:虚拟商品

6:固定资产

8:分装箱

货品自定义属性1

good_prop1

String

255

y货品自定义属性1
货品自定义属性2

good_prop2

String

255

y货品自定义属性2
货品自定义属性3

good_prop3

String

255

y货品自定义属性3
货品自定义属性4

good_prop4

String

255

y货品自定义属性4
货品自定义属性5

good_prop5

String

255y货品自定义属性5
货品自定义属性6

good_prop6

String

255

y货品自定义属性6
sn_list

sn_list

String


y当need_sn=true时返回英文逗号分隔的sn
组合装编码suite_no
String
40
y系统订单生成时组合装对应的组合装编码
分摊邮费

share_post_amount

Decimal(19,4)


y分摊邮费
出库货位明细

position_details_list

List<Map<String, Object>>


y出库货位明细

position_details_list

名称字段类型长度
必须描述
货位id

position_id

Int

11

y货位id
货位号

position_no

String

20y货位号
有效期

expire_date

String

40y有效期
批次号batch_noString20Y批次号
当前货位出库总货品数量

position_goods_count

Decimal(19,4)


y当前货位出库货品总量

5.请求示例

json
[{
"start_time": "2019-12-31 00:00:00",
"end_time": "2019-12-31 01:00:00"
}]
PHP
<?php
header("Content-Type: text/html; charset=UTF-8");
date_default_timezone_set("Asia/Shanghai");
require_once('wdtsdk.php');
 
$client = new WdtErpClient("url", "wdtapi3", "appkey", "secret"); 
 
$params=new stdClass();
$params->start_time = '2019-12-11 00:00:00';
$params->end_time = '2019-12-31 00:00:00';
 
 
$pager = new Pager(2, 0, true);
$data = $client->pageCall("wms.stockout.Sales.queryWithDetail", $pager, $params);
 
?>
JAVA
C#

6.响应示例

   6.1 正常响应示例 

JSON
{
  "status": 0,
  "data": {
    "total_count": 1,
    "order": [
      {
        "logistics_name": "国通快递-线下",
        "details_list": [
          {
            "rec_id": 2800703,
            "stockout_id": 1596124,
            "spec_id": 273312,
            "goods_count": 5,
            "goods_amount": 5,
            "paid": 0,
            "remark": "",
            "goods_name": "hcf",
            "goods_no": "hcf",
            "spec_name": "hcf",
            "spec_code": "hcf",
            "spec_no": "hcf",
            "cost_price": 0,
            "weight": 0,
            "total_amount": 0,
            "goods_id": 105064,
            "prop1": "",
            "prop2": "",
            "prop3": "",
            "prop4": "",
            "prop5": "",
            "prop6": "",
            "platform_id": 127,
            "refund_status": 0,
            "tax_rate": 0,
            "barcode": "hcf",
            "sale_order_id": 5021078,
            "gift_type": 0,
            "src_oid": "lj8234892938222122",
            "src_tid": "lj823489293842938242122",
            "from_mask": 0,
            "goods_type": 1,
            "good_prop1": "",
            "good_prop2": "",
            "good_prop3": "",
            "good_prop4": "",
            "good_prop5": "",
            "good_prop6": "",
            "suite_no": "",
            "src_order_detail_id": 5021078,
            "share_post_amount": 0,
            "sell_price": 1,
            "market_price": 1,
            "share_price": 1,
            "discount": 0,
            "share_amount": 5,
            "position_details_list": [
              {
                "stockout_detail_id": 2800703,
                "position_id": -6,
                "position_no": "其它未上架",
                "batch_no": "",
                "expire_date": "",
                "position_goods_count": 5
              }
            ]
          }
        ],
        "consign_time": "2022-07-18 12:15:52",
        "post_amount": 0,
        "fenxiao_nick": "",
        "trade_time": 1657329367000,
        "receiver_dtb": "上海市 闵行区",
        "bad_reason": 0,
        "print_remark": "",
        "employee_no": "lj",
        "discount": 0,
        "tax_rate": 0,
        "trade_id": 2525559,
        "trade_label": "789",
        "shop_remark": "",
        "invoice_id": 0,
        "modified": "2022-07-18 12:16:12",
        "receiver_country": 0,
        "order_type": 1,
        "shop_no": "wtt",
        "picklist_seq": 0,
        "seq_no": 1,
        "receiver_area": "上海 上海市 闵行区 ",
        "customer_no": "KH202206290009",
        "refund_status": 0,
        "receiver_province": 310000,
        "buyer_message": "[兑换订单]",
        "created": 1658117656000,
        "weight": 0,
        "block_reason": 0,
        "tax": 0,
        "logistics_code": "gt",
        "shop_name": "wdtapi3-test",
        "shop_platform_id": 127,
        "pay_time": 1657329367000,
        "shop_id": 392,
        "warehouse_name": "wdtapi3-test2",
        "goods_total_cost": 0,
        "nick_name": "lj",
        "trade_no": "JY20220718000008",
        "warehouse_mapping_code": "",
        "id_card_type": 0,
        "status": 110,
        "package_fee": 0,
        "order_no": "CH2022071818",
        "src_trade_no": "lj823489293842938242122",
        "post_fee": 0,
        "receiver_city": 310100,
        "invoice_title": "",
        "id_card": "",
        "remark": "",
        "sub_platform_id": 0,
        "goods_count": 5,
        "stockout_id": 1596124,
        "cod_amount": 0,
        "flag_name": "无",
        "src_order_no": "JY20220718000008",
        "logistics_id": 920,
        "warehouse_no": "wdtapi3-test2",
        "receiver_telno": "",
        "receiver_zip": "",
        "invoice_content": "",
        "trade_status": 110,
        "receiver_name": "Tony",
        "invoice_type": 0,
        "currency": "",
        "picklist_no": "",
        "logistics_type": 52,
        "trade_from": 1,
        "delivery_term": 1,
        "logistics_no": "2132432423",
        "receiver_district": 310112,
        "goods_total_amount": 5,
        "receivable": 5,
        "receiver_mobile": "18621118833",
        "stock_check_time": 1658117703000,
        "cs_remark": "补发单号(JY20220718000011)",
        "platform_id": 127,
        "receiver_address": "麦积区 马跑泉镇 ",
        "trade_type": 1,
        "logistics_print_status": 1,
        "customer_name": "lj",
        "logistics_list": [
          {
            "rec_id": 28425257,
            "stockout_id": 1596124,
            "logistics_id": 920,
            "logistics_no": "2132432423",
            "calc_weight": 0,
            "weight": 0,
            "postage": 0,
            "remark": "",
            "length": 0,
            "width": 0,
            "height": 0,
            "package_name": "未知",
            "logistics_name": "国通快递-线下",
            "volume": "0.000000000000"
          }
        ],
        "warehouse_id": 630
      }
    ]
  }
}

   6.2 异常响应示例

JSON

{
"status": 100,
"message": "仓库不存在"
}





常用工具