当前位置: API文档

purchase.PurchaseReturn.queryWithDetail(采购退货单及明细查询)

¥标准

1.接口说明

1.1 接口描:获取ERP的采购退货单信息
1.2 适用版本:客户端 V1.2.2.8及以上版本
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/

   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
分页编号,分页查询必传
是否计算查询结果的总条数calc_totalint
是否计算查询结果的总条数, 需要计算则1, 否则填0         

   3.3 业务请求参数

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

params

Map<String, Object>
Y

查询参数

分页

pager

pager
Y

分页

params

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

provider_no

String


N

供应商编号

采购退货单号

return_no

String
N采购退货单号

采购退货单状态

statusint
N

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

开始时间

start_time

String
N

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

结束时间

end_time

String
N与修改时间作比较的结束时间

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

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

审核人

check_operator_name

String
Y审核人

审核时间

check_time

check_time


Y

审核时间

city

String
Y

供应商联系人姓名

contact

String
Y

供应商联系人姓名

创建时间

createddatetime
Y

创建时间

制单员creator_name
String
Y制单员

district

String


Y

货品数量

goods_count

decimal(19,4)


Y

货品数量

货品总价

goods_fee

decimal(19,4)


Y

货品总价

退货出库量

goods_out_count

decimal(19,4)


Y

退货出库量

货品种类数

goods_type_count

int


Y

货品种类数

是否占用库存

is_reserved

boolean


Y

true : 已占用, false: 未占用

物流方式

logistics_type

int


Y

物流方式

修改时间

modified

datetime


Y

修改时间

便签条数

note_count

int


Y

便签条数

其他费用

other_fee

decimal(19,4)


Y

其他费用

外部单号

outer_no

String


Y

外部单号

运费

post_fee

decimal(19,4)


Y

运费

供应商名称

provider_name

String


Y

供应商名称

province

String


Y

采购员

purchaser_name

String


Y

采购员

退货地址

receive_address

String


Y

退货地址

备注

remark

String


Y

备注

采购退货单id

return_id

int


Y

采购退货单id

采购退货单号

return_no

String


Y

采购退货单号

结算状态

settle_status

int


Y

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

状态

status

int


Y

状态

供应商联系电话

telno

String


Y

供应商联系电话

类型

type

int


Y

1:退货,2:换货

仓库名称

warehouse_name

String


Y

仓库名称

采购退货单详情

detail_list

List<Map<String, Object>>


Y

采购退货单详情

detail_list




商家编码

spec_no

String


Y

商家编码

是否残次品

defect

bool


Y

是否残次品

供应商货号

provider_goods_no

String


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

折扣

金额

amount

Decimal(19,4)


Y

金额

出库金额

out_amount

Decimal(19,4)


Y

出库金额

备注

remark

String


Y

备注

修改时间

modified

datetime


Y

修改时间

创建时间

created

datatime


Y

创建时间

基本单位

unit_name

String


Y

基本单位

出库单位

base_unit_name

String


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("aftersales.refund.Refund.search ", $pager, $parMap);
 
?>

JAVA

C#

6.响应示例

   6.1 正常响应示例 

JSON

{
        "status": 0,
        "data": {
                "total_count": 2,
                "order": [{
                        "post_fee": 0.0000,
                        "city": "",
                        "detail_list": [{
                                "return_id": 624,
                                "spec_no": "WJ0010022",
                                "defect": false,
                                "provider_goods_no": "",
                                "num": 4.0000,
                                "num2": 4.0000,
                                "out_num": 0.0000,
                                "settle_num": 0.0000,
                                "unit_ratio": 1.0000,
                                "price": 0.0000,
                                "discount": 0.0000,
                                "amount": 0.0000,
                                "out_amount": 0.0000,
                                "remark": "",
                                "modified": 1582783714000,
                                "created": 1582783714000,
                                "unit_name": "无",
                                "base_unit_name": "无"
                        }, {
                                "return_id": 624,
                                "spec_no": "WJ0010023",
                                "defect": false,
                                "provider_goods_no": "",
                                "num": 2.0000,
                                "num2": 2.0000,
                                "out_num": 0.0000,
                                "settle_num": 0.0000,
                                "unit_ratio": 1.0000,
                                "price": 0.0000,
                                "discount": 0.0000,
                                "amount": 0.0000,
                                "out_amount": 0.0000,
                                "remark": "",
                                "modified": 1582783714000,
                                "created": 1582783714000,
                                "unit_name": "无",
                                "base_unit_name": "无"
                        }, {
                                "return_id": 624,
                                "spec_no": "WJ0010024",
                                "defect": false,
                                "provider_goods_no": "",
                                "num": 2.0000,
                                "num2": 2.0000,
                                "out_num": 0.0000,
                                "settle_num": 0.0000,
                                "unit_ratio": 1.0000,
                                "price": 0.0000,
                                "discount": 0.0000,
                                "amount": 0.0000,
                                "out_amount": 0.0000,
                                "remark": "",
                                "modified": 1582783714000,
                                "created": 1582783714000,
                                "unit_name": "无",
                                "base_unit_name": "无"
                        }, {
                                "return_id": 624,
                                "spec_no": "WJ0010025",
                                "defect": false,
                                "provider_goods_no": "",
                                "num": 2.0000,
                                "num2": 2.0000,
                                "out_num": 0.0000,
                                "settle_num": 0.0000,
                                "unit_ratio": 1.0000,
                                "price": 0.0000,
                                "discount": 0.0000,
                                "amount": 0.0000,
                                "out_amount": 0.0000,
                                "remark": "",
                                "modified": 1582783714000,
                                "created": 1582783714000,
                                "unit_name": "无",
                                "base_unit_name": "无"
                        }],
                        "goods_type_count": 4,
                        "remark": "",
                        "goods_count": 10.0000,
                        "type": 1,
                        "telno": "",
                        "is_reserved": false,
                        "province": "",
                        "outer_no": "",
                        "contact": "",
                        "purchaser_name": "系统",
                        "modified": 1582943529000,
                        "logistics_type": 0,
                        "provider_name": "本厂",
                        "receive_address": "",
                        "other_fee": 0.0000,
                        "note_count": 0,
                        "check_operator_name": "系统",
                        "goods_out_count": 0.0000,
                        "created": 1582783714000,
                        "settle_status": 0,
                        "return_no": "CGT-A-000893",
                        "warehouse_name": "华南测试专用",
                        "district": "",
                        "goods_fee": 0.0000,
                        "creator_name": "YEU测试",
                        "status": 10
                }]
        }
}

   6.2 异常响应示例

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




常用工具