当前位置： API文档

aftersales.refund.Refund.search（退换单查询）

¥标准

1.接口说明

1.1 接口描述：获取ERP销售退货（换货）订单信息
1.2 适用版本：客户端 V1.4.7.3及以上版本
1.3 增量获取：支持
1.4 时间跨度：请求时间最大跨度为30天。

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

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

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

字段描述字段名
买家支付宝账号
pay_account
客户网名
buyer_nick
退款订单中收件人姓名receiver_name
退款订单中收件人电话receiver_telno
客户姓名customer_name

2.调用场景

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

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>
是

查询参数

分页

pager

pager


是

分页

params

名称字段类型长度
必须描述
店铺编号

shop_nos

String

255否

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

原始单号tidString40
否原始单号
客户网名buyer_nickString100否客户网名
系统订单编号trade_noString40否系统订单编号
退换单号refund_no

String

40否退换单号
物流单号
return_logistics_no

String

40否物流单号（退换单上的退回物流单号）
修改起始时间modified_from

String

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

modified_to

String40否

修改结束时间

开始时间

settle_from

String40
否

结算时间

结束时间

settle_to

String40否

结算时间

审核起始时间

agree_from

String40否

审核起始时间

审核结束时间

agree_to

String40否

审核结束时间

退换单状态statusInt4否10:已取消;20:待审核;30:已审核;40已推送:80:已结算;81:待回传;85:待过账;86:已过账;87:成本确认;90:已完成
入库状态

stockin_status

Int

4否0:无需入库;1:待入库;2:部分入库;3:全部入库;4:终止入库
退回仓库编号
return_warehouse_nos

String

1000否退回仓库编号，用英文逗号分隔
退换单类型type

Int

4否1:售前退款;2:退货;3:换货;4:退款不退货;6:保价退款
模糊查询fuzzy_queryboolean1否默认false,业务单号进行模糊查询匹配，匹配数量大于1条时会报错
是否为拦截件

return_mask_manual_intercept

boolean1否

0：否   1：是

不传不判断

是否拒收

refund_mask_reject_return

boolean1否

0：否   1：是

不传不判断

pager

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

4.响应参数

  4.1 公共响应参数

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

Map<String, Object>


是单据数据

data

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

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

order

List<Map<String, Object>>


是

单据数据

数据总条数

total_count

Int


是

单据数据总条数

order

名称字段类型长度
必须描述
退换单idrefund_idInt11是退换单id
原始单号src_tidsString255是原始单号（平台订单号）
退换单号refund_noString40是退换单号
备注

remark

String255是备注
退换单类型

type

Int4是

1:售前退款;2:退货;3:换货;4:退款不退货;6:保价退款

入库状态stockin_statusInt4是0:无需入库;1:待入库;2:部分入库;3:全部入库;4:终止入库
标记名称flag_nameString32是标记名称
退回货品数量return_goods_countInt11是退回货品数量
退款订单中收件人电话receiver_telnoString100
是退款订单中收件人电话（仅自有平台及线下平台返回，其他平台均不返回）
退款订单中收件人姓名receiver_nameString100是退款订单中收件人姓名（仅自有平台及线下平台返回，其他平台均不返回）
修改时间modifiedString40是修改时间
便签数量note_countInt6是便签数量
店铺编号shop_noString20是店铺编号
建单方式from_typeInt4是

0:API抓单;1:手工建单;2:Excel导入;3:分销商推送

建单时间createdstring40是建单时间
结算时间settle_timestring40是

若无结算时间，返回空字符串

审核时间check_timestring
是未审核，返回空字符串
退货物流单号return_logistics_noString40是退货物流单号
系统订单号列表trade_no_listString255是系统订单号列表
平台退款金额guarantee_refund_amount

Decimal(19,4)


是平台退款金额（担保退款金额）
退货金额return_goods_amount

Decimal(19,4)


是退货金额
物流公司名称return_logistics_nameString40
是物流公司名称
退换说明

reason_name

String255是退换说明
退款原因

refund_reason

String255是退款原因
客户网名buyer_nickString100是客户网名（仅自有平台及线下平台返回，其他平台均不返回）
建单者
operator_nameString40是建单者
实际退款金额actual_refund_amount

Decimal(19,4)


是实际退款金额
驳回原因revert_reason_nameString255是驳回原因
退回仓库编号return_warehouse_noString40是退回仓库编号
线下退款金额direct_refund_amount

Decimal(19,4)


是线下退款金额（非担保退款金额）
收款金额receive_amount

Decimal(19,4)


是收款金额，买家支付给卖家
客户姓名customer_nameString40是客户姓名（仅自有平台及线下平台返回，其他平台均不返回）
分销商昵称fenxiao_nick_nameString40否分销商昵称，若无值则字段不返回
退换单状态statusInt4是10:已取消;20:待审核;30:已审核;40已推送:80:已结算;81:待回传;85:待过账;86:已过账;87:成本确认;90:已完成
店铺idshop_idInt11是店铺id
订单idtrade_idInt11是订单id
原始退换单号
raw_refund_nosString
255
是原始退换单号
支付订单号
pay_idString
40
是支付订单号
分销退换单号
provider_refund_noString
40
是分销原始单号
店铺平台id
shop_platform_idInt

是店铺平台id
原始单号
tid_listString

是原始单号
子平台id
sub_platform_idInt
是子平台id
退回仓库id
return_warehouse_idInt
是退回仓库id
平台id
platform_idInt
是平台id
奇门货主编号
wms_owner_noString40
是奇门货主编号
退回仓库类型warehouse_typeInt4是退回仓库类型 1:普通（内部）,2:自流转,3:平台,4:京东沧海.6:抖音云仓,125:代发仓,126:分销委外
拦截原因bad_reasonInt11是拦截原因
最后修改时间modified_dateString40是最后修改时间
退换信息return_mask_infoString255是退换信息
处理状态process_statusInt4是

处理状态

0：待递交

15：已递交

25：待回传

35：已回传

退款原因idreason_idInt11是退款原因id
驳回原因idrevert_reasonInt11是驳回原因id
客户idcustomer_idInt11是客户id
发货方式consign_modeInt
是

0：并行

1：交替

2：顺延

退款创建时间refund_timeString40
是

退款创建时间，格式: yyyy-MM-dd HH:mm:ss

分销原始单号fenxiao_tidString40
是

分销原始单号

分销商编码fenxiao_nick_noString40
是

分销商编码

退换单详情detail_listList<Map<String, Object>>
是退换单详情
金额明细amount_detail_listList<Map<String, Object>>
是金额明细
换出订单

swap_order

Map<String,Object>
否非换货类型的单据不返回

detail_list

名称字段类型长度
必须描述
退换单明细Idrec_id
Int11是明细唯一键
退换单idrefund_id
Int11是退换单id
原始子单号oid
String40是原始子单号
订单明细idtrade_order_id
Int11是订单明细id
平台idplatform_idInt11是平台id，见附件
原始单号
tidString40是原始单号
系统订单编号trade_noString40是系统订单编号
数量num

Decimal(19,4)


是实际发出数量
价格price

Decimal(19,4)


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

original_price

Decimal(19,4)


是原价, 系统订单明细标价
成本价checked_cost_price

Decimal(19,4)


是成本价
退款数量

refund_num

Decimal(19,4)


是退款数量
退款总额

total_amount

Decimal(19,4)


是

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

退款金额refund_amount

Decimal(19,4)


是已经退款的总金额
担保退款is_guaranteebool1
是

是否担保退款

是:true；否:false

货品编号goods_noString40是货品编号
货品名称goods_nameString255是货品名称
规格名spec_nameString100是规格名
商家编码spec_noString40是商家编码
平台货品idgoods_idString40是平台货品id
平台规格idspec_idString40是平台规格id
系统货品idsys_goods_idInt11是系统货品id（旺店通货品档案中货品维度自增生成的id）
系统规格idsys_spec_idInt11是系统规格id（旺店通货品档案中单品维度自增生成的id）
规格码spec_codeString40是规格码
条码
barcodeString50是条码
入库数量stockin_num

Decimal(19,4)


是退货入库数量
备注remarkString255是备注
平台规格名称api_spec_nameString100是平台规格名称
平台货品名称api_goods_nameString255
是平台货品名称
最后修改时间modifiedString40是最后修改时间
组合装编号suite_noString40是组合装编号（单据中若不包含组合装，该字段不返回）
组合装名称suite_nameString255是组合装名称（单据中若不包含组合装，该字段不返回）
原始退款单号raw_refund_nosString
是

按照oid和platform_id匹配原始退款单数据, 包含已取消的原始退款单号，

多个原始退款单号之间使用英文逗号隔开
原始退款单号raw_refund_noString40是原始退款单递交时刷新该值，取值与客户端保持一致
订单idsales_trade_idInt11是订单id
总折扣金额discountDecimal(19,4)
是总折扣金额
已支付金额paidDecimal(19,4)
是已支付金额
组合装idsuite_idInt
是组合装id
组合装数量suite_numDecimal(19,4)
是组合装数量
创建时间createdString40是创建时间
最后修改时间modified_dateString40是最后修改时间

amount_detail_list

名称字段类型长度
必须描述
金额明细记录idrec_idInt11
是金额明细记录id
退换单idrefund_idInt11是退换单id
退换类型refund_typeInt
11是1: 货款 2:邮费 99:返现
金额流向is_returnInt4是

0:商家->买家

1:买家->商家

退款金额refund_amountDecimal(19,4)
是退款金额
收款金额receive_amountDecimal(19,4)
是收款金额
是否担保支付is_guaranteebool

是

1:担保支付

0:非担保支付

支付账户
account_idInt11
是支付账户
买家账号
pay_accountString128
是买家账号（仅自有平台及线下平台返回，其他平台均不返回）
买家开户人姓名
account_nameString100是买家开户人姓名
开户银行
account_bankString40是开户银行
是否系统自动生成

is_auto

boolean

是是否系统自动生成
备注remarkString255是备注

swap_order

名称字段类型长度
必须描述
换出订单原始单号tid

String

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

String

20是店铺编号
店铺名称shop_name

String

50是店铺名称
仓库名称

warehouse_no

String

40是仓库名称
店铺id
shop_idInt
是店铺id
仓库id
warehouse_id

Int


是仓库id
省份idswap_province

Int

11是省份id
城市idswap_city

Int

11是城市id
地区swap_area

String

40是地区
地区idswap_district

Int

11是地区id
换货新订单物流公司idswap_logistics_id

Int

6是换货新订单物流公司id
换货邮费post_amount

Decimal(19,4)


是换货邮费
其他金额other_amount

Decimal(19,4)


是其他金额
换出订单明细swap_order_detail_list

List<Map<String, Object>>


是换出订单明细

swap_order_detail_list

名称字段类型长度
必须描述
原始子单号oidString40是原始子单号
货品类型target_typeByte6是货品类型（1 单品，2 组合装）
换出货品idtarget_idInt
11是换出货品id
是否残次品defectboolean1是是否残次品
货品名称goods_nameString255是货品名称
货品编号goods_noString40是货品编号
规格名称spec_nameString100是规格名称
规格码spec_codeString40是规格码
商家编码merchant_noString40
是商家编码,换出货品为组合装则此编码为组合装的商家编码
零售价
price

Decimal(19,4)


是零售价
总价
total_amount

Decimal(19,4)


是总价
数量num

Decimal(19,4)


是数量
备注remarkString255是备注


5.请求示例

Json格式请求报文
[{
"modified_from": "2020-01-01 00:00:00",
"modified_to": "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->modified_from= "2020-01-01 00:00:00";
$parMap->modified_to= "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": [{
            "warehouse_type": 1,
            "provider_refund_no": "",
            "detail_list": [{
                "rec_id": 1137182,
                "refund_id": 1130899,
                "platform_id": 127,
                "oid": "lj2323823489293842938343422",
                "tid": "lj8234232389293842938422344",
                "trade_no": "A18449",
                "checked_cost_price": 0,
                "num": 1,
                "price": 1,
                "original_price": 1,
                "refund_num": 1,
                "total_amount": 1,
                "refund_amount": 0,
                "is_guarantee": true,
                "goods_no": "hcf",
                "goods_name": "hcf",
                "spec_name": "hcf",
                "spec_no": "hcf",
                "spec_code": "hcf",
                "barcode": "hcf",
                "stockin_num": 0,
                "remark": "",
                "api_goods_name": "hcf",
                "sales_trade_id": 2740715,
                "api_spec_name": "hcf",
                "trade_order_id": 5271780,
                "modified": 1686712380000,
                "goods_id": "hcf",
                "spec_id": "hcf",
                "sys_goods_id": 105064,
                "sys_spec_id": 273312,
                "discount": 0,
                "paid": 0,
                "suite_id": 0,
                "suite_no": "",
                "suite_name": "",
                "suite_num": 0,
                "created": "2023-06-14 11:05:17",
                "modified_date": "2023-06-14 11:13:00",
                "raw_refund_no": "TKljcs2202180006",
                "raw_refund_nos": "TKljcs2202180006"
            }],
            "refund_no": "TK2306140001",
            "bad_reason": 0,
            "return_telno": "",
            "type": 2,
            "trade_id": 2740715,
            "modified": 1686712380000,
            "shop_no": "wdtapi3-test",
            "created": 1686711917000,
            "trade_no_list": "A18449",
            "return_logistics_no": "238943957239",
            "return_goods_amount": 1,
            "modified_date": "2023-06-14 11:13:00",
            "shop_platform_id": 127,
            "refund_id": 1130899,
            "shop_id": 711,
            "src_tids": "lj8234232389293842938422344",
            "actual_refund_amount": 0,
            "refund_time": "2022-06-08 00:00:00",
            "receive_amount": 0,
            "pay_id": "1495759864643715076",
            "status": 30,
            "check_time": "2023-06-14 11:13:00",
            "return_mask_info": "",
            "tmp_data": 624,
            "tid_list": "lj8234232389293842938422344",
            "remark": "",
            "sub_platform_id": 0,
            "stockin_status": 1,
            "flag_name": "无",
            "return_goods_count": 1,
            "receiver_telno": "18621578833",
            "receiver_name": "Tony",
            "refund_reason": "1",
            "return_warehouse_id": 624,
            "note_count": 0,
            "from_type": 0,
            "raw_refund_nos": "TKljcs2202180006",
            "amount_detail_list": [],
            "consign_mode": 0,
            "guarantee_refund_amount": 0,
            "return_logistics_name": "中通",
            "settle_time": "",
            "reason_id": 0,
            "buyer_nick": "lj",
            "operator_name": "系统",
            "revert_reason": 0,
            "return_warehouse_no": "wdtapi3-test",
            "direct_refund_amount": 0,
            "platform_id": "127",
            "sync_return": true,
            "customer_name": "lj",
            "reason_name": "无",
            "customer_id": 17588392,
            "return_mask": 0,
            "revert_reason_name": "无"
        }]
    }
}

   6.2 异常响应示例

JSON

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


常用工具