当前位置: API文档

aftersales.refund.Refund.search(退换单查询)

¥标准

1.接口说明

1.1 接口描:获取ERP销售退货(换货)订单信息
1.2 适用版本:客户端 V1.2.5.2及以上版本
1.3 增量获取:不支持
1.4 时间跨度:start_time和end_time最大跨度为30天。

1.5注意事项:【权限校验】:店铺权限 为了达到保护用户隐私数据安全的目的本接口不返回淘系订单数据相关平台规则点击这里淘系数据获取办法点击这里

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

字段描述字段名
买家昵称buyer_nick
收件人姓名receiver_name
收件地址receiver_address
收件人手机receiver_mobile
收件人固话
receiver_telno
客户姓名customer_name
证件号码id_card

2.调用场景

2.1 举例说明:自研商城、分销系统、全渠道等系统对接

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>

查询参数

分页

pager

pager


分页

params




店铺编号

shop_nos

String


由英文逗号分隔的店铺编号

原始单号tidString
原始单号
客户网名buyer_nickString
客户网名
系统订单编号trade_noString
系统订单编号
退换单号refund_no

String


退换单号
修改起始时间modified_from

String


修改起始时间
修改结束时间

modified_to

String

修改结束时间

开始时间

settle_from

String

结算时间(此字段需要客户端升级到1.2.5.2及以上版本支持!!)

结束时间

settle_to

String

结算时间(此字段需要客户端升级到1.2.5.2及以上版本支持!!)

退换单状态statusInt
10:已取消;20:待审核;30:已审核;80:已结算;85:待过账;86:已过账;87:成本确认;90:已完成
入库状态

stockin_status

Int


0:未入库;1:待入库;2:部分入库;3:全部入库;4:终止入库
退换单类型type

Int


1:退款;2:退货;3:换货;4:退款不退货

pager

分页大小page_sizeInt4分页大小
页号page_noInt4从0开始

4.响应参

  4.1 公共响应参数

名称字段类型长度
必须描述
状态码statusint
状态码:0表示成功,在调用错误时不返回该值
错误信息messageString
无错误信息不返回
单据数据data

Map<String, Object>


单据数据

data

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

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

order

List<Map<String, Object>>


单据数据

数据总条数

total_count

int


单据数据总条数

order

名称字段类型长度
必须描述
原始单号tid_listString
原始单号
退换单号refund_noString
退换单号
备注

remark

String
备注
退换单类型

type

Int

见传入参数描述

入库状态stockin_statusInt
见传入参数描述
标记名称flag_nameString
标记名称
退回货品数量return_goods_countint
退回货品数量
退款订单中收件人电话receiver_telnoString
退款订单中收件人电话
退款订单中收件人姓名receiver_nameString
退款订单中收件人姓名
修改时间modifiedtimestamp
修改时间
便签数量note_countint
便签数量
店铺编号shop_noString
店铺编号
建单方式from_typeint

0:API抓单;1:手工建单;2:导入

创建时间createdstring
创建时间
结算时间settle_timestring

使用结算时间查询返回结算时间, 否则返回空字符串(此字段需要客户端升级到1.2.5.2及以上版本支持!!)

退货物流单号return_logistics_noString
退货物流单号
系统订单号列表trade_no_listString
系统订单号列表
担保退款金额guarantee_refund_amount

Decimal(19,4)


担保退款金额
退回货品金额return_goods_amount

Decimal(19,4)


退回货品金额
物流公司名称return_logistics_nameString
物流公司名称
退款原因

reason_name

String
退款原因
客户网名buyer_nickString
客户网名
制单员姓名operator_nameString
制单员姓名
实际退款金额actual_refund_amount

Decimal(19,4)


实际退款金额
驳回原因revert_reason_nameString
驳回原因
退回仓库编号return_warehouse_noString
退回仓库编号
非担保退款金额direct_refund_amount

Decimal(19,4)


非担保退款金额
收款金额receive_amount

Decimal(19,4)


收款金额,买家支付给卖家
客户姓名customer_nameString
客户姓名
退换单状态statusint
见传入参数
退换单详情detail_listList<Map<String, Object>>
退换单详情
换出订单

swap_order

Map<String,Object>
非换货类型不返回
detail_list




原始子单号oid
String
原始子单号
平台idplatform_idInt
平台id,见附件
原始单号
tidString
原始单号
系统订单编号trade_noString
系统订单编号
数量num

Decimal(19,4)


实际发出数量
价格price

Decimal(19,4)


价格, 系统订单明细分摊后价格
原价

original_price

Decimal(19,4)


原价, 系统订单明细成交价
退款数量

refund_num

Decimal(19,4)


退款数量
退款货品总额

total_amount

Decimal(19,4)


退款货品总额, 系统订单明细的分摊后金额

退款金额refund_amount

Decimal(19,4)


已经退款的总金额
是否担保退款is_guaranteebool
是否担保退款
货品编号goods_noString
货品编号
货品名称goods_nameString
货品名称
单品名称spec_nameString
单品名称
商家编码spec_noString
商家编码
规格码spec_codeString
规格码使用该字段需要客户端升级到1.2.3.6及以上版本!!)
条码
barcodeString
条码
退货入库数量stockin_num

Decimal(19,4)


退货入库数量
备注remarkString
备注
平台货品名称api_goods_nameString
平台货品名称
平台规格名称api_spec_nameString
平台规格名称
原始退款单号raw_refund_nosString
多个原始退款单号之间使用英文逗号隔开
swap_order




换出订单原始单号tid

String


换出订单原始单号
店铺编号shop_no

String


店铺编号
店铺名称shop_name

String


店铺名称
仓库名称

warehouse_no

String


仓库名称
换出订单明细swap_order_detail_list

List<Map<String, Object>>


换出订单明细
swap_order_detail_list




原始子单号oidString
原始子单号
货品类型target_typebyte
货品类型
换出货品idtarget_idint

换出货品id
是否残次品defectboolean
是否残次品
货品名称goods_nameString
货品名称
货品编号goods_noString
货品编号
规格名称spec_nameString
规格名称
规格码spec_codeString
规格码
商家编码merchant_noString
商家编码,换出货品为组合装则此编码为组合装的商家编码
价格price

Decimal(19,4)


零售价
总金额total_amount

Decimal(19,4)


总金额
数量num

Decimal(19,4)


数量
备注remarkString
备注

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);
 
?>

6.响应示

   6.1 正常响应示例 

JSON

{
"status": 0,
"data": {
"total_count": 1,
"order": [{
"tid_list": "1321422112312",
"detail_list": [{
"platform_id": 0,
"oid": "AD202003040003",
"tid": "1321422112312",
"trade_no": "ORDER2003040003",
"num": 1.0000,
"price": 0.1000,
"original_price": 0.1000,
"refund_num": 1.0000,
"total_amount": 0.1000,
"refund_amount": 0.1000,
"is_guarantee": false,
"goods_no": "vpubaotest0021",
"goods_name": "vpubaotest",
"spec_name": "",
"spec_no": "G101010313",
"barcode": "",
"stockin_num": 1.0000,
"remark": "",
"api_goods_name": "",
"api_spec_name": "",
"raw_refund_nos": ""
}],
"refund_no": "TK2003040001",
"remark": "",
"type": 2,
"stockin_status": 3,
"flag_name": "无",
"return_goods_count": 1.0000,
"receiver_telno": "13811114444",
"receiver_name": "测试账号",
"modified": 1583302969000,
"note_count": 0,
"shop_no": "LJTest",
"from_type": 1,
"created": 1583302039000,
"return_logistics_no": "q134123513",
"trade_no_list": "ORDER2003040003",
"guarantee_refund_amount": 0.0000,
"return_goods_amount": 0.1000,
"return_logistics_name": "",
"buyer_nick": "7839486",
"operator_name": "api_public",
"actual_refund_amount": 0.1000,
"return_warehouse_no": "08",
"direct_refund_amount": 0.1000,
"receive_amount": 0.0000,
"customer_name": "系统",
"reason_name": "无",
"status": 80,
"revert_reason_name": "无"
}]
}
}

   6.2 异常响应示例

JSON

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

常用工具