API文档

aftersales.refund.Refund.searchHistory（历史退换单查询）

¥标准

1.接口说明

1.1 接口描述：查询已经归档的退换单信息

1.2 适用版本：客户端 V1.2.5.6及以上版本

1.3 增量获取：支持

1.4 时间跨度：请求时间最大跨度为30天。

1.5注意事项：【权限校验】：店铺权限

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

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

字段描述	字段名
买家昵称	buyer_nick
收件人姓名	receiver_name
收件人固话	receiver_telno

2.调用场景

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

3.请求参数说明

3.1 请求地址

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

3.2 公共请求参数

名称	字段	类型	必须	描述
卖家账号	sid	String	是	卖家账号, 由旺店通分配
接口账号	key	String	是	由旺店通分配appkey, 在发送的数据中对应 key 字段,获取方式点击这里
盐	salt	String	是	由旺店通分配appsecret，是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt.
接口名称	method	String	是	调用的接口名称
版本号	v	String	是	1.0
秒级时间戳	timestamp	int	是	秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。
签名	sign	String	是	签名
分页大小	page_size	int	否	分页大小，分页查询必传
分页编号	page_no	int	否	分页编号，分页查询必传，标准接口page_no从0开始
是否计算查询结果的总条数	calc_total	int	否	是否计算查询结果的总条数, 需要计算则1, 否则填0

3.3 业务请求参数

名称	字段	类型	长度	必须	描述
查询参数	params	Map<String, Object>		是	查询参数
分页	pager	pager		是	分页

params

名称	字段	类型	长度	必须	描述
开始时间	start_time	String	40	否	起始时间, 针对最后变更时间检索。如果退换单号为空则时间条件必填
结束时间	end_time	String	40	否	结束时间
店铺编号	shop_no	String	20	否	店铺编号
退换单号	refund_no	String	40	否	退换单号
类型	type	Int	4	否	1：售前退款；2：退货；3：换货；4：退款不退货
退换单状态	status	String	4	否	用逗号分隔开数字的字符串。10：已取消；90：已完成

pager

名称	字段	类型	长度	必须	描述
分页大小	page_size	Int	4	否	分页大小（单量较大的卖家，page_size建议200以下）
页号	page_no	Int	4	否	从0开始

4.响应参数

4.1 公共响应参数

名称	字段	类型	必须	描述
状态码	status	Int	否	状态码:0表示成功,在调用错误时不返回该值
错误信息	message	String	是	无错误信息不返回
单据数据	data	Map<String, Object>	是	单据数据

data

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

名称	字段	类型	长度	必须	描述
单据数据	order	List<Map<String, Object>>		是	单据数据
数据总条数	total_count	Int		是	单据数据总条数

order

名称	字段	类型	长度	必须	描述
标记id	flag_id	Int	11	是	标记id
退换原因	reason	String	255	是	退换原因
原始单列表	tid_list	String	255	是	长度超过255之后会截取
操作员id	operator_id	Int	11	是	操作员id
退换单号	refund_no	String	40	是	退换单号
退货人手机号	return_mobile	String	100	是	退货人手机号
拦截原因	bad_reason	Int	11	是	拦截原因
备注	remark	String	255	是	备注
退货人电话	return_telno	String	100	是	退货人电话
类型	type	Int	4	是	1：售前退款；2：退货；3：换货；4：退款不退货
入库状态	stockin_status	Int	4	是	0:无需入库;1:待入库;2:部分入库;3:全部入库;4:终止入库
标记名称	flag_name	String	32	是	标记名称
业务员id	salesman_id	Int	11	是	业务员id
退回货品数量	return_goods_count	Decimal(19,4)		是	退回货品数量
支付状态	pay_status	Int	4	是	支付状态
固话	receiver_telno	String	100	是	固话（仅自有平台及线下平台返回，其他平台均不返回）
收件人姓名	receiver_name	String	100	是	收件人姓名（仅自有平台及线下平台返回，其他平台均不返回）
修改时间	modified	String	40	是	修改时间
退货人姓名	return_name	String	100	是	退货人姓名
退回仓库id	return_warehouse_id	Int	6	是	退回仓库id
店铺编号	shop_no	String	40	是	店铺编号
建单方式	from_type	Int	4	是	0:API抓单;1:手工建单;2:Excel导入;3:分销商推送
建单时间	created	String	40	是	建单时间
系统订单号	trade_no_list	String	255	是	超过255长度将会被截取
退回物流单号	return_logistics_no	String	40	是	退回物流单号
退货金额	return_goods_amount	Decimal(19,4)		是	退货金额
平台退款金额	guarantee_refund_amount	Decimal(19,4)		是	平台退款金额
退货物流名称	return_logistics_name	String	40	是	退货物流名称
退换单主键	refund_id	Int	11	是	退换单主键
结算时间	settle_time	String		是	结算时间
原因id	reason_id	Int	11	是	原因id
店铺id	shop_id	Int	11	是	店铺id
买家昵称	buyer_nick	String	100	是	买家昵称（仅自有平台及线下平台返回，其他平台均不返回）
实际退款	actual_refund_amount	Decimal(19,4)		是	实际退款
驳回原因	revert_reason	Int	11	是	驳回原因
退回仓库编号	return_warehouse_no	String	40	是	退回仓库编号
线下退款金额	direct_refund_amount	Decimal(19,4)		是	线下退款金额
入库单号	stockin_no	String	40	是	入库单号
收款金额	receive_amount	Decimal(19,4)		是	收款金额
业务员名称	salesman	String	40	是	业务员名称
退换单状态	status	Int	4	是	10：已取消；90：已完成
退换信息	return_mask	Int	40	是	退换信息
退换单明细	detail_list	List<Map<String, Object>>		是	退换单明细
换货信息	swap_order	<Map<String, Object>		是	仅换货类型的单据返回

detail_list

名称	字段	类型	长度	必须	描述
明细唯一键	rec_id	Int	11	是	明细唯一键
退换单id	refund_id	Int	11	是	退换单id
平台id	platform_id	Int	6	是	平台id，点击链接查看
原始子单号	oid	String	40	是	原始子单号
原始单号	tid	String	40	是	原始单号
系统子单id	trade_order_id	Int	11	是	系统子单id
订单id	trade_id	Int	11	是	订单id
系统订单号	trade_no	String	40	是	系统订单号
担保退款	is_guarantee	bool	1	是	是否担保退款是：true；否：false
数量	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)		是	已经退款的总金额
单品id	spec_id	Int	11	是	单品id
是否残次品	defect	boolean	1	是	是否残次品是：true；否：false
退回数量	returned_num	Decimal(19,4)		是	退回数量
退货入库数量	stockin_num	Decimal(19,4)		是	退货入库数量
备注	remark	String	255	是	备注
创建时间	created	String	40	是	创建时间
最后修改时间	modified	String	40	是	最后修改时间
商家编码	spec_no	String	40	是	商家编码
规格名称	spec_name	String	100	是	规格名称
规格编码	spec_code	String	40	是	规格编码
货品编号	goods_no	String	40	是	货品编号
货品名称	goods_name	String	255	是	货品名称

swap_order

名称	字段	类型	长度	必须	描述
退换单id	refund_id	Int	11	是	退换单id
换出订单原始单号	tid	String	40	是	换出订单原始单号
店铺id	shop_id	Int	11	是	店铺id
仓库id	warehouse_id	Int	11	是	仓库id
店铺编号	shop_no	String	20	是	店铺编号
店铺名称	shop_name	String	40	是	店铺名称
仓库编号	warehouse_no	String	40	是	仓库编号
换货详情	swap_order_detail_list	List<Map<String, Object>>		是	换出订单明细

swap_order_detail_list

名称	字段	类型	长度	必须	描述
退换单id	refund_id	Int	11	是	退换单id
原始子单号	oid	String	40	是	原始子单号
货品类型	target_type	Int	4	是	货品类型
换出货品id	target_id	Int	11	是	换出货品id
是否残次品	defect	boolean	1	是	是否残次品
货品名称	goods_name	String	255	是	货品名称
货品编号	goods_no	String	40	是	货品编号
规格名称	spec_name	String	100	是	规格名称
规格码	spec_code	String	40	是	规格码
商家编码	merchant_no	String	40	是	商家编码,换出货品为组合装则此编码为组合装的商家编码
零售价	price	Decimal(19,4)		是	零售价
总价	total_amount	Decimal(19,4)		是	总价
数量	num	Decimal(19,4)		是	数量
备注	remark	String	255	是	备注

5.请求示例

Json格式请求报文

[{"start_time":"2018-10-25 10:32:12","end_time":"2018-10-29 10:32:12","type":3}]

PHP

<?php
include 'wdtsdk.php';
 
$client = new WdtErpClient("url", "wdtapi3", "appkey", "secret")
$pars = array
(
    'start_time' => '2018-10-25 10:32:12',
    'end_time' => '2018-10-29 10:32:12'
);
$pager = new Pager(50, 0, true);
$data = $client->pageCall("aftersales.refund.Refund.searchHistory", $pager,  $pars);//分页方法
$php_json = json_encode($data);
echo $php_json;
 
?>

6.响应示例

6.1 正常响应示例

JSON

{
"status": 0,
"data": {
"total_count": 1,
"order": [
{
"flag_id": 0,
"reason": "无",
"tid_list": "AT201810260027",
"operator_id": 21,
"detail_list": [
],
"refund_no": "TK1810260005",
"return_mobile ": "",
"bad_reason": 0,
"remark": "",
"return_telno": "~fSQFZ/yni5sB7AbC9Kt5oA==~1~",
"type": 3,
"stockin_status": 0,
"flag_name": "无",
"salesman_id": 21,
"return_goods_count": 2.0000,
"pay_status": 0,
" receiver_telno": "16619955153",
"receiver_name": "王召红",
"modified": "2018-10-26 14:52:15",
"return_name": "~fSQFZ/yni5sB7AbC9Kt5oA==~1~",
"return_warehouse_id": 12,
"shop_no": "001",
"from_type ": 1,
"created": "2018-10-26 14:49:02",
"trade_no_list": "JY201810260048",
"return_logistics_no": "",
"return_goods_amount": 13.0000,
"guarantee_refund_amount": 0.0000,
"return_logistics_name": "销 售退货专用物流",
"refund_id": 20,
"settle_time": "",
"reason_id": 0,
"shop_id": 10,
"buyer_nick": "~GY2AcukFtGPJiW2+UvWl/y2Ri5KB5++K/7HI+nixOf0=~1~",
"actual_refund_amount": 12.9800,
"revert_reason ": 0,
"return_warehouse_no": "001",
"direct_refund_amount": 13.0000,
"stockin_no": "",
"receive_amount": 0.0200,
"salesman": "W",
"return_mask": 0,
"status": 10
}
]
}
}

6.2 异常响应示例

JSON	{"status":100,"message":"您的查询时间过宽,查询时间不能大于30天"}