当前位置： API文档

purchase.PurchaseReturn.queryWithDetail（采购退货单及明细查询）

¥标准

1.接口说明

1.1 接口描述：获取ERP的采购退货单信息
1.2 适用版本：客户端 V1.4.4.9及以上版本
1.3 增量获取：支持
1.4 时间跨度：start_time和end_time最大跨度为30天。

1.5注意事项：【权限校验】：仓库权限

如果不填写采购退货单号则必须填写开始时间和结束时间；填写了采购退货单号则起止时间条件失效。

2.调用场景

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

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

名称字段类型长度
必须描述
供应商编号

provider_no

String

20N

供应商编号

采购退货单号

return_no

String20N采购退货单号

采购退货单状态

statusInt4
N

10 已取消,20 编辑中,30 待审核,40 已审核,60 已完成

开始时间

start_time

String40
N

与修改时间比较的开始时间

结束时间

end_time

String40N与修改时间作比较的结束时间
模糊查询fuzzy_queryboolean1N默认false，业务单号进行模糊查询匹配，匹配数量大于1条时会报错

pager

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

page_size

Int

4N

分页大小

页号

page_no

Int4N从0开始

4.响应参数

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

0表示调用成功,在调用错误时候不返回该值。

错误信息messageString
Y

无错误信息不返回

单据数据data

Map<String, Object>


N单据数据

data

响应参数说明示例值或者格式、具体含义、使用方法及注意事项（如隐私数据淘系平台不返回，其他平台正常返回）

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

order

List<Map<String, Object>>


Y

单据数据

数据总条数

total_count

Int


Y

单据数据总条数

order

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

采购退货单id

return_id

Int

11

Y

采购退货单id

审核人

check_operator_name

String

40

Y

审核人

审核时间

check_time

String

40

Y

审核时间

市

city

String

50

Y

市

供应商联系人姓名

contact

String

40

Y

供应商联系人姓名

创建时间

created

String

40

Y

创建时间

制单员

creator_name

String

40

Y

制单员

区

district

String

50

Y

区

货品数量

goods_count

Decimal(19,4)


Y

货品数量

货款

goods_fee

Decimal(19,4)


Y

货款

退货出库量

goods_out_count

Decimal(19,4)


Y

退货出库量

货品种类数

goods_type_count

Int

6

Y

货品种类数

是否占用库存

is_reserved

boolean

1

Y

true : 已占用, false: 未占用

物流方式

logistics_type

Int

11

Y

物流方式，点击查看代码表

物流公司编号

logistics_no

String


Y

ERP内维护的物流公司编号

物流公司id

logistics_idInt6

Y

物流公司id

修改时间

modified

String

40

Y

修改时间

便签条数

note_count

Int

6

Y

便签条数

其他费用

other_fee

Decimal(19,4)


Y

其他费用

外部单号

outer_no

String

40

Y

外部单号

邮费

post_fee

Decimal(19,4)


Y

邮费

供应商名称

provider_name

String

40

Y

供应商名称

省

province

String

50

Y

省

采购员

purchaser_name

String

40

Y

采购员

退货地址

receive_address

String

255

Y

退货地址

备注

remark

String

255

Y

备注

采购退货单号

return_no

String

25

Y

采购退货单号

结算状态

settle_status

Int

4

Y

0:不可结算,1:待结算2:部分结算,3已结算

状态

status

Int

4

Y

状态  10 已取消,20 编辑中,30 待审核,40 已审核,60 已完成

供应商联系电话

telno

String

32

Y

供应商联系电话

类型

type

Int

4

Y

1:退货,2:换货

仓库名称

warehouse_name

String

64

Y

仓库名称

仓库编号

warehouse_no

String

40

Y

仓库编号

仓库id

warehouse_idInt11

Y

仓库id

供应商编号

provider_no

String

40

Y

供应商编号

原采购单号

purchase_no

String

30

Y

只引用一个采购单号时有值，引用多个采购单号或者是未引用采购单返回空字符串

出库状态

stockout_status

Int

4

Y

出库状态

0：未出库

1：部分出库

2：已出库

3：停止出库

采购退货单详情

detail_list

List<Map<String, Object>>


Y

采购退货单详情

detail_list

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

主键id

rec_id
Int11

Y

主键id

商家编码

spec_no

String

40

Y

商家编码

单品ID
spec_idint
Y旺店通系统单品ID
自定义属性2prop1String
Y退货单明细的自定义属性1
自定义属性2prop2String
Y退货单明细的自定义属性2

采购退货单id

return_id

Int

11

Y

采购退货单id

是否残次品

defect

bool

1

Y

是否残次品

供应商货号

provider_goods_no

String

40

Y

供应商货号

退货数量

num

Decimal(19,4)


Y

退货数量

辅助数量

num2

Decimal(19,4)


Y

辅助数量

出库数量

out_num

Decimal(19,4)


Y

出库数量

结算数量

settle_num

Decimal(19,4)


Y

结算数量

单位变换率

unit_ratio

Decimal(19,4)


Y

单位变换率

单价

price

Decimal(19,4)


Y

单价（优惠前）

折扣

discount

Decimal(19,4)


Y

折扣

税率

tax_rate

Decimal(19,4)


Y

税率

税后单价

tax_price

Decimal(19,4)


Y

税后单价（优惠后）

金额

amount

Decimal(19,4)


Y

税前折后金额（税前折后单价*退货数量）

出库金额

out_amount

Decimal(19,4)


Y

出库金额（税前折后单价*出库数量）

备注

remark

String

255

Y

备注

修改时间

modified

String

40

Y

修改时间

创建时间

created

String

40

Y

创建时间

退货单位

unit_name

String

20

Y

退货单位

基本单位

base_unit_name

String

20

Y

基本单位

5.请求示例

Json格式请求报文
[{
"start_time": "2020-01-01 00:00:00",
"end_time": "2020-01-20 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");
 
$parMap = new stdClass();
$parMap->start_time = "2020-01-01 00:00:00";
$parMap->end_time = "2020-01-20 00:00:00";
 
$pager = new Pager(1, 0, true);
 
$response = $client->pageCall("purchase.PurchaseReturn.queryWithDetail", $pager, $parMap);
 
?>

JAVA

C#

6.响应示例

   6.1 正常响应示例 

JSON

{
    "status": 0,
    "data": {
        "total_count": 1,
        "order": [{
            "purchase_no": "",
            "post_fee": 0,
            "city": "0",
            "detail_list": [{
                "rec_id": 2826,
                "return_id": 1752,
                "spec_id": 1,
                "spec_no": "wangdiantong",
                "defect": false,
                "provider_goods_no": "",
                "num": 1,
                "num2": 0.3333,
                "out_num": 0,
                "settle_num": 0,
                "unit_ratio": 3,
                "price": 5,
                "discount": 1,
                "tax_rate": 0,
                "tax_price": 5,
                "amount": 5,
                "out_amount": 0,
                "remark": "",
                "prop1": "",
                "prop2": "",
                "modified": 1660117745000,
                "created": 1660117745000,
                "unit_name": "哒哒哒哒哒",
                "base_unit_name": "箱"
            }],
            "goods_type_count": 1,
            "return_id": 1752,
            "remark": "",
            "goods_count": 1,
            "type": 1,
            "telno": "",
            "logistics_id": 0,
            "is_reserved": true,
            "province": "0",
            "warehouse_no": "wdtapi3-test",
            "stockout_status": 0,
            "outer_no": "",
            "contact": "lcj",
            "purchaser_name": "系统",
            "modified": 1660117751000,
            "provider_name": "LCJtest22222",
            "logistics_type": 0,
            "receive_address": "",
            "other_fee": 0,
            "note_count": 0,
            "provider_no": "LCJtest",
            "check_operator_name": "aaa",
            "goods_out_count": 0,
            "logistics_no": "",
            "created": 1660117745000,
            "settle_status": 0,
            "return_no": "CR202208100006",
            "warehouse_name": "wdtapi3-test",
            "district": "0",
            "goods_fee": 5,
            "creator_name": "aaa",
            "status": 40,
            "warehouse_id": 624,
            "check_time": 1660117751000
        }]
    }
}

   6.2 异常响应示例

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




常用工具