API文档

aftersales.refund.RawRefund.searchHistory（历史原始退款单查询）

¥标准

1.接口说明

1.1 接口描述：获取ERP已归档的原始退款单信息

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

1.3 增量获取：支持

1.4 时间跨度：start_time和end_time最大跨度为30天。

1.5注意事项：

1.5.1 满足一下情况之一时间参数非必填

（1）platform_id&refund_no

（2）platform_id&tid

（3）logistics_no

1.5.2【权限校验】：店铺权限

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

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

字段描述	字段名
网名	buyer_nick
支付账号	pay_account

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	是	结束时间
时间条件类型	time_type	Int	4	是	1：修改时间 2：退款时间不传按照修改时间获取数据
原始退单号	refund_no	String	40	否	原始退单号
物流单号	logistics_no	String	40	否	物流单号
平台id	platform_id	Int	6	否	平台id，映射表点击详情查看
店铺编号	shop_no	String	40	否	店铺编号
原始单号	tid	String	40	否	原始单号
原始子单号	oid	String	40	否	原始子单号
明细掩码	detail_mask	Int	11	否	0：不返回原始退款单优惠 1：返回原始退款单优惠默认0

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	11	是	单据数据总条数

order

名称	字段	类型	长度	必须	描述
原始退款单唯一id	refund_id	Int	11	是	原始退款单唯一id
平台id	platform_id	Int	6	是	平台id，点击查看平台代码表
店铺编号	shop_no	String	20	是	店铺编号
店铺名称	shop_name	String	128	是	店铺名称
原始退款单号	refund_no	String	40	是	原始退款单号
原始单号	tid	String	40	是	原始单号
原始子单号	oid	String	40	是	原始子单号
类型	type	byte	4	是	1：售前退款 2：退货 3：换货 4：退款不退货
平台状态	status	byte	4	是	1：取消退款 2：申请退款 3：等待退货 4：等待收货 5：退款成功 7：卖家拒绝退款
处理状态	process_status	byte	4	是	0：待递交 15：已递交 20：递交失败 40：已处理
支付账号	pay_account	String	128	是	支付账号（仅自有平台及线下平台返回，其他平台均不返回）
支付单号	pay_no	String	60	是	支付单号
申请退款金额	refund_amount	Decimal(19,4)		是	申请退款金额
实际退款金额	actual_refund_amount	Decimal(19,4)		是	实际退款金额
退款成功时间	current_phase_timeout	String		是	退款成功时间
标题	title	String	255	是	标题
物流公司名称	logistics_name	String	40	是	物流公司名称
物流单号	logistics_no	String	40	是	物流单号
网名	buyer_nick	String	100	是	网名（仅自有平台及线下平台返回，其他平台均不返回）
退款时间	refund_time	String		是	申请退款时间, yyyy-MM-dd HH:mm:ss格式
是否售后退款单	is_aftersale	boolean		是	是否售后退款单
退款原因	reason	String	255	是	退款原因
退款原因关键字映射对应id	reason_id	Int	11	是	退款原因关键字映射对应id
备注	remark	String	255	是	备注
数量	num	Decimal(19,4)		是	数量
单价	price	Decimal(19,4)		是	单价
退款货品总价格	total_amount	Decimal(19,4)		是	退款货品总价格
平台货品id	goods_id	String	40	是	平台货品id
平台规格id	spec_id	String	40	是	平台规格id
平台货品编号	goods_no	String	40	是	平台货品编号
平台规格编号	spec_no	String	40	是	平台规格编号
最后修改时间	modified	String		是	最后修改时间, yyyy-MM-dd HH:mm:ss格式
创建时间	created	String		是	创建时间, yyyy-MM-dd HH:mm:ss格式
店铺id	shop_id	Int	6	是	店铺id
子平台id	sub_platform_id	Int	11	是	子平台id
店铺平台id	shop_platform_id	Int	11	是	店铺平台id
是否拒收	is_reject	Int	4	是	是否拒收 0：否 1：是
退款版本	refund_version	String	40	是	退款版本
tag	tag	Int	11	是	tag
外部退款单	is_external	Int	4	是	外部退款单，未经ERP处理过的订单
修改掩码	modify_flag	Int	11	是	修改掩码 1：状态 2：金额 16：类型
原始退款单明细	detail_list	List<Map<String, Object>>		是	原始退款单明细
原始退款单优惠明细	discount_list	List<Map<String, Object>>		是	原始退款单优惠明细

detail_list

名称	字段	类型	长度	必须	描述
主单id或明细主键id	refund_id	Int	11	是	主单id或明细主键id
原始子单号	oid	String	40	是	原始子单号
平台id	platform_id	Int	6	是	平台id
原始退款单号	refund_no	String	40	是	原始退款单号
原始单号	tid	String	40	是	原始单号
平台状态	status	Int	4	是	1：取消退款 2：已申请退款 3：已同意 4：待收货 5：退款成功
平台货品名称	goods_name	String	255	是	平台货品名称
平台货品编码	goods_no	String	40	是	平台货品编码
平台货品id	goods_id	String	40	是	平台货品id
平台规格名称	spec_name	String	255	是	平台规格名称
平台规格编码	spec_no	String	40	是	平台规格编码
平台规格id	spec_id	String	40	是	平台规格id
数量	num	Decimal(19,4)		是	数量
总金额	total_amount	Decimal(19,4)		是	总金额
备注	remark	String	255	是	备注
单价	price	Decimal(19,4)		是	单价
类型	type	Int		是	类型 0：该明细取自原始退款单明细 1：该明细取自原始退款单主单
退货时间	refund_time	String	40	是	退货时间
最后修改时间	modified_date	String	40	是	最后修改时间
创建时间	created_date	String	40	是	创建时间

discount_list

名称	字段	类型	长度	必须	描述
原始退款单号	refund_no	String	40	是	原始退款单号
原始单号	tid	String	40	是	原始单号
原始子单号	oid	Sting	40	是	原始子单号
优惠名称	name	String	50	是	优惠名称
金额	amount	Decimal(19,4)		是	金额

5.请求示例

Json格式请求报文

[{"refund_no":"91294632450951678","platform_id":1}]

PHP

<?php
header("Content-Type: text/html; charset=UTF-8");
date_default_timezone_set("Asia/Shanghai");
 
$client = new WdtErpClient("url", "wdtapi3", "appkey", "secret");
 
$parMap = new stdClass();
$parMap->refund_no = '91294632450951678';
$parMap->platform_id = 1;
 
$pager = new Pager(2, 0, true);
 
try {
    $data = $client->pageCall("aftersales.refund.RawRefund.searchHistory", $pager, $parMap);
}catch(WdtErpException $e)
{
    echo $e->getMessage();
}
?>

6.响应示例

6.1 正常响应示例

JSON

{
    "status": 0,
    "data": {
        "total_count": 1,
        "order": [{
            "logistics_name": " ",
            "refund_version": " ",
            "reason": " ",
            "detail_list": [{
                "refund_id": 210348,
                "oid": "202210270002-0",
                "price": 0,
                "platform_id": 127,
                "refund_no": "202210270002",
                "num": 5,
                "remark": " ",
                "total_amount": 0,
                "tid": "202210270002",
                "status": 3,
                "goods_no": "",
                "spec_no": "",
                "goods_id": "",
                "spec_id": "",
                "refund_time": "2022-04-08 09:18:00",
                "modified_date": "2022-10-27 17:47:17",
                "created_date": "2022-10-27 17:46:21",
                "goods_name": "",
                "spec_name": ""
            }],
            "refund_no": "202210270002",
            "num": 5,
            "goods_no": "",
            "remark": " ",
            "sub_platform_id": 0,
            "oid": "202210270002-0",
            "pay_account": "",
            "type": 3,
            "title": " ",
            "spec_no": "",
            "discount_list": [],
            "tid": "202210270002",
            "current_phase_timeout": "",
            "pay_no": "",
            "price": 0,
            "spec_id": "",
            "refund_amount": 0,
            "modified": "2022-10-27 17:47:17",
            "tag": 0,
            "shop_no": "wdtapi3-test",
            "logistics_no": " ",
            "is_aftersale": true,
            "created": "2022-10-27 17:46:21",
            "is_reject": 0,
            "swap_order_id": "",
            "is_external": 0,
            "goods_id": "",
            "shop_platform_id": 127,
            "shop_name": "wdtapi3-test",
            "refund_id": 210348,
            "reason_id": 99,
            "shop_id": 711,
            "buyer_nick": "",
            "actual_refund_amount": 0,
            "total_amount": 0,
            "refund_time": "2022-04-08 09:18:00",
            "process_status": 15,
            "platform_id": 127,
            "modify_flag": 0,
            "status": 3
        }]
    }
}

6.2 异常响应示例

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