当前位置: API文档

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

¥标准

1.接口说明

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

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

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

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

字段描述字段名
客户网名
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退换单号
物流单号
logistics_no

String

40物流单号(退换单上的退回物流单号)
修改起始时间modified_from

String

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

modified_to

String40

修改结束时间

开始时间

settle_from

String40

结算时间

结束时间

settle_to

String40

结算时间

审核起始时间

agree_from

String40

审核起始时间

审核结束时间

agree_to

String40

审核结束时间

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

stockin_status

Int

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

Int

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

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

名称字段类型长度
必须描述
退换单idrefund_idInt11退换单id
原始单号tid_listString255原始单号(平台订单号)
退换单号refund_noString40退换单号
备注

remark

String255备注
退换单类型

type

Int4

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

入库状态stockin_statusInt40:无需入库;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导入

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

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

退货物流单号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分销商昵称,若无值则字段不返回
退换单状态statusInt410:已取消;20:待审核;30:已审核;40已推送:80:已结算;81:待回传;85:待过账;86:已过账;87:成本确认;90:已完成
店铺idshop_idInt11店铺id
订单idtrade_idInt11订单id
原始退换单号
raw_refund_nosString

原始退换单号
退换单详情detail_listList<Map<String, Object>>
退换单详情
换出订单

swap_order

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




退换单明细Idrec_id
Int11明细唯一键
原始子单号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)


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

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_nosString255

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

多个原始退款单号之间使用英文逗号隔开
原始退款单号raw_refund_noString255原始退款单递交时刷新该值,取值与客户端保持一致
amount_detail_list




金额明细记录idrec_idInt11
金额明细记录id
退换单idrefund_idInt11退换单id
退换类型refund_typeInt
111: 货款 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仓库名称
换出订单明细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

{
  "total_count": 1,
  "order": [
    {
      "provider_refund_no": "",
      "tmp_data": 311,
      "detail_list": [
        {
          "sys_goods_id": 354230,
          "original_price": 1.0000,
          "spec_code": "hcf",
          "num": 1.0000,
          "goods_no": "hcf",
          "trade_order_id": 1156953,
          "remark": "",
          "api_spec_name": "hcf",
          "oid": "hcf298382423842",
          "spec_no": "hcf",
          "tid": "lj291423849234822",
          "api_goods_name": "hcf",
          "price": 1.0000,
          "spec_id": "hcf",
          "refund_amount": 1.0000,
          "modified": 1642743135000,
          "barcode": "hcf",
          "goods_name": "hcf",
          "raw_refund_nos": "TK2201190002,lj9wwer54563453,ljkl234923423423,lj9wwer545634532",
          "stockin_num": 0.0000,
          "sys_spec_id": 532982,
          "is_guarantee": true,
          "goods_id": "hcf",
          "rec_id": 26455,
          "total_amount": 1.0000,
          "refund_num": 1.0000,
          "platform_id": 127,
          "trade_no": "ORDER202201190475",
          "raw_refund_no": "lj9wwer545634532",
          "spec_name": "hcf"
        }
      ],
      "tid_list": "lj291423849234822",
      "refund_no": "TK2201210002",
      "remark": "",
      "sub_platform_id": 0,
      "return_telno": "",
      "type": 2,
      "stockin_status": 0,
      "flag_name": "无",
      "return_goods_count": 1.0000,
      "trade_id": 936862,
      "receiver_telno": "1327483274",
      "modified": 1642743135000,
      "receiver_name": "lj",
      "refund_reason": "1",
      "return_warehouse_id": 311,
      "note_count": 0,
      "shop_no": "wdtapi3-test",
      "from_type": 0,
      "raw_refund_nos": "lj9wwer545634532",
      "created": 1642743071000,
      "amount_detail_list": [
        {
          "refund_type": 1,
          "is_guarantee": true,
          "remark": "",
          "pay_account": "",
          "account_bank": "",
          "rec_id": 22607,
          "refund_id": 25629,
          "is_auto": false,
          "is_return": 1,
          "account_id": 0,
          "account_name": "",
          "refund_amount": 1.0000,
          "receive_amount": 0.0000
        }
      ],
      "trade_no_list": "ORDER202201190475",
      "return_logistics_no": "1234568764",
      "return_goods_amount": 1.0000,
      "guarantee_refund_amount": 1.0000,
      "return_logistics_name": "自提物流",
      "shop_platform_id": 127,
      "refund_id": 25629,
      "settle_time": "",
      "shop_id": 290,
      "src_tids": "lj291423849234822",
      "buyer_nick": "lj",
      "operator_name": "系统",
      "actual_refund_amount": 1.0000,
      "return_warehouse_no": "wdtapi3-test",
      "direct_refund_amount": 0.0000,
      "platform_id": "127",
      "sync_return": true,
      "receive_amount": 0.0000,
      "customer_name": "lj",
      "reason_name": "无",
      "return_mask": 0,
      "status": 20,
      "revert_reason_name": "无"
    }
  ]
}

   6.2 异常响应示例

JSON

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

常用工具