当前位置: API文档

wms.stockout.PurchaseReturn.queryWithDetail(采购退货出库单查询)

¥标准

1.接口说明

1.1 接口描述:获取ERP采购退货出库单信息
1.2 适用版本:客户端 V1.4.3.4及以上版本
1.3 时间跨度:start_time和end_time最大跨度为30天
1.4 注意事项:【权限校验】:仓库权限

2.调用场景

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

3.请求参数说明

   3.1 请求地址

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

   3.2 公共请求参数

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

    3.3 业务请求参数

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

查询参数

params

Map<String, Object>


Y

查询参数

分页

pager

Pager


Y

分页

params

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

开始时间

start_time

String

40

N

开始时间,若无出库单号或采购退货单号,则为必填。

结束时间

end_time

String

40

N

结束时间,上同开始时间

时间类型

time_type

Int

40

N

时间类型

1:出库时间

2:创建时间

3:最后修改时间

默认1

仓库编号

warehouse_no

String

40

N

限普通仓库

出库单号

stockout_no

String

40

N

出库单号

采购退货单号

src_order_no

String

40

N

采购退货单号

出库单状态

status

String 

40

N

由逗号分隔的整数数组

出库单状态:  
5已取消 
48 未确认 
50 待审核
77 拣货中,PDA拣货后
110已完成

pager

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

分页大小

page_size

Int

4

N

分页大小

页号

page_no

Int

4

N

从0开始

4.响应参数

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

状态码

status

Int


Y

返回0为正常

错误信息

message

String


Y

无错误信息不返回

出库单信息

data

Map<String, Object>


N

出库信息

data

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

总数

total_count

Int

11

N

查询条件总单据数

单据数据

order

List<Map<String, Object>>


Y

出库单相关数据

order

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

出库单id

stockout_id

Int

11Y

出库单id

出库单号

order_no

String

40
Y

出库单号

采购退货单号

src_order_no

String

40
Y

采购退货单号

仓库编号

warehouse_no

String

40
Y

仓库编号

发货时间

consign_time

String

40
Y

发货时间(单据未出库该字段不返回

出库单状态

status

Byte


Y

出库单状态

5: 已取消
48: 未确认
50: 待审核
65: 待处理
77: 拣货中
110: 已完成

货品数量

goods_count

Decimal(19,4)


Y

货品数量

物流编号

logistics_no

String

40Y

物流编号

邮费

post_fee

Decimal(19,4)


Y

邮费

收件人姓名

receiver_name

String

40
Y

收货人姓名

省份id

receiver_province

String

40Y

省份,返回值可参考城市代码表

城市id

receiver_city

String

40Y

城市,返回值可参考城市代码表

地区id

receiver_district

String

40Y

地区,返回值可参考城市代码表

收件人地址

receiver_address

String

256
Y

收件人地址

收件人电话

receiver_telno

String

40
Y

收件人电话

备注

remark

String

255
Y

备注

重量

weight

Decimal(19,4)


Y

重量

供应商编号

provider_no

String

20
Y

供应商编号

供应商名称

provider_name

String

64
Y

供应商名称

最后一次引用的采购单号

last_load_purchase_no

String

20
Y

最后一次引用的采购单号

货品种类数
goods_type_count
Int6
Y货品种类数
制单时间
create_time

String


Y制单时间
制单人姓名
operator_name

String


Y制单人姓名(接口创建或者是制单人为系统的返回空字符串)

总成本价

goods_total_cost

Decimal(19,4)


Y

总成本价

总货款

goods_total_amount

Decimal(19,4)


Y

总货款(出库金额)

瞬时成本总额

checked_goods_total_cost

Decimal(19,4)


Y

瞬时成本总额

最后修改时间

modifiedString
Y最后修改时间,

格式: yyyy-MM-dd HH:mm:ss

出库单明细

details_listList<Map<String, Object>>
Y

出库单明细

details_list

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

出库单明细id

rec_id

Int

11Y

出库单明细ID(主键)

出库单id

stockout_id

Int

11Y

出库单ID

商家编码

spec_no

String

40Y

商家编码

货品数量

goods_count

Decimal(19,4)


Y

货品数量

货品总额

total_amount

Decimal(19,4)


Y

货品总额(税前折后单价*数量)

税前折后单价

sell_price

Decimal(19,4)


Y

税前折后单价

备注

remark

String

255
Y

备注

品牌编号

brand_no

String

32
Y

品牌编号

品牌名称

brand_name

String

64
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)


Y

重量

货品类型

goods_type

Int

11
Y

货品类型

单位

goods_unit

String

20
Y

单位

批次号

batch_no

String

40
Y

批次号

有效期

expire_date

String

40
Y如果没有则返回空字符串

是否残次品

defect

boolean

1Y

true:残次品

false:正品

货位编号

position_no

String

20
Y货位编号

总瞬时实际成本

total_checked_cost_price

Decimal(19,4)


Y总瞬时实际成本

自定义属性1

prop1String255
Y自定义属性1
自定义属性2prop2String255
Y自定义属性2

5.请求示例

json格式请求报文

[{
       "start_time": "2019-12-11 00:00:00",
       "end_time": "2019-12-31 00: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");
 
$pager = new Pager(1, 0, true);
 
$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.PurchaseReturn.queryWithDetail", $pager, $params);
 
?>
JAVA

C#

6.响应示例

6.1正常响应示例

json

{
    "status": 0,
    "data": {
        "total_count": 1,
        "order": [{
            "order_no": "CH202209194238",
            "details_list": [{
                "rec_id": 2833903,
                "stockout_id": 1627020,
                "spec_no": "rt0032",
                "defect": false,
                "goods_count": 4,
                "total_amount": 0,
                "sell_price": 0,
                "remark": "",
                "brand_no": "锐太",
                "brand_name": "锐太",
                "goods_name": "锐太销售货品<*#",
                "goods_no": "RT0003",
                "spec_name": "b",
                "spec_code": "b",
                "cost_price": 0,
                "weight": 11,
                "goods_type": 1,
                "goods_unit": "盒",
                "batch_no": "0001",
                "expire_date": "",
                "position_no": "102",
                "total_checked_cost_price": 0,
                "prop1": "",
                "prop2": ""
            }],
            "consign_time": 1663580182000,
            "post_fee": 0,
            "receiver_city": "",
            "goods_type_count": 1,
            "remark": "",
            "goods_count": 4,
            "stockout_id": 1627020,
            "src_order_no": "CR202209190011",
            "warehouse_no": "234234234",
            "receiver_telno": "010-1234567",
            "checked_goods_total_cost": 0,
            "receiver_name": "小K",
            "modified": "2022-09-19 17:36:22",
            "provider_name": "秋天001",
            "provider_no": "20170808002",
            "seq_no": 1,
            "create_time": 1663580182000,
            "receiver_province": "",
            "logistics_no": "",
            "receiver_district": "",
            "weight": 0,
            "goods_total_amount": 0,
            "operator_name": "nff",
            "goods_total_cost": "0.00000000",
            "last_load_purchase_no": "",
            "receiver_address": "北京海淀区花园路2号",
            "status": 110
        }]
    }
}

6.2异常响应示例

json

{
       "status": 100,
       "message": "参数中必须包含起止时间"
}


常用工具