当前位置: API文档

aftersales.refund.Refund.searchHistory(历史退换单查询)

¥标准

1.接口说明

1.1 接口描查询已经归档的退换单信息
1.2 适用版本:客户端 V1.2.5.6及以上版本
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




开始时间

start_time

String

40

起始时间, 针对最后变更时间检索。如果退换单号为空则时间条件必填

结束时间

end_time

String

40

结束时间

店铺编号

shop_nos

String

20

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

退换单号refund_no

String

40
退换单号
类型type

Int

4

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

状态statusString4

用逗号分隔开数字的字符串。10:已取消;20:待审核;30:已审核;40已推送wms;80:已结算;85:待过账;86:已过账;87:成本确认;90:已完成

pager

分页大小page_sizeInt4分页大小不能超过2000
页号page_noInt4从0开始

4.响应参

  4.1 公共响应参数

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

Map<String, Object>


单据数据

data

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

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

order

List<Map<String, Object>>


单据数据

数据总条数

total_count

Int


单据数据总条数

order

名称字段类型长度
必须描述
标记id
flag_idInt11标记id
退换原因reasonString255退换原因
原始单列表
tid_listString255长度超过255之后会截取
操作员id
operator_idInt11
操作员id
退换单号
refund_noString40
退换单号
退货人手机号
return_mobileString100退货人手机号
拦截原因
bad_reasonInt11
拦截原因
备注
remarkString255备注
退货人电话
return_telnoString100退货人电话
类型
typeInt4
参照请求参数类型
入库状态
stockin_statusInt4

用逗号分隔开数字的字符串。10:已取消;20:待审核;30:已审核;40已推送wms;80:已结算;85:待过账;86:已过账;87:成本确认;90:已完成

标记名称flag_nameString32标记名称
业务员idsalesman_idInt11业务员id
退回货品数量return_goods_countInt11
退回货品数量
支付状态pay_statusInt4支付状态
固话

receiver_telno

String100
固话
收件人姓名
receiver_nameString
100
收件人姓名
修改时间
modifiedString40
修改时间
退货人姓名
return_nameString 100
退货人姓名
退回仓库id
return_warehouse_idInt6退回仓库id
店铺编号shop_noString40店铺编号
建单方式from_type
Int4
建单方式
创建时间
created
String40创建时间
系统订单号
trade_no_listString255超过255长度将会被截取
退回物流单号

return_logistics_no

String
40
退回物流单号
退货金额
return_goods_amontDecimal(19,4)
退货金额
平台退款金额

guarantee_refund_amount

Decimal(19,4)
平台退款金额
退货物流名称

return_logistics_name

String
40
退货物流名称
退换单主键refund_idInt11
退换单主键
原因id
reason_idInt11
原因id
店铺id
shop_id
Int11店铺id
买家昵称buyer_nickString 100买家昵称
实际退款

actual_refund_amount

Decimal(19,4)
实际退款
驳回原因

revert_reason

Int11
驳回原因
退回仓库编号
return_warehouse_noString40
退回仓库编号
线下退款金额

direct_refund_amount

Decimal(19,4)
线下退款金额
入库单号
stockin_noString40入库单号
收款金额

receive_amount

Decimal(19,4)
收款金额
业务员名称
salesmanString40
业务员名称
状态statusInt 4
参照请求参数
退换信息
return_maskInt40退换信息
退换单明细
detail_listList<Map<String, Object>>
退换单明细
换货信息
swap_order<Map<String, Object>
仅换货类型返回
detail_list




明细唯一键
rec_idInt11明细唯一键
退换单id
refund_idInt11退换单id
平台idplatform_idInt
6平台id
原始子单号oid
String40原始子单号
原始单号
tidString40
原始单号
系统子单idtrade_order_idInt11系统子单id
订单id
trade_idInt11订单id
订单号trade_noString40
订单号
是否担保退款is_guaranteebool1
是否担保退款
数量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_idInt11
单品id
是否残次品defectboolean1是否残次品
退回数量
returned_numDecimal(19,4)
退回数量
退货入库数量
stockin_numDecimal(19,4)
退货入库数量
备注
remarkString255备注
创建时间
createdString 40
创建时间
最后修改时间
modifiedString40
最后修改时间
商家编码spec_noString40
商家编码
规格名称spec_nameString100
规格名称
规格编码spec_codeString40规格编码
货品编号
goods_no
String40
货品编号
货品名称
goods_nameString255货品名称
swap_order




退换单id
refund_id
Int11退换单id
换出订单原始单号tid

String

40换出订单原始单号
店铺idshop_idInt11
店铺id
仓库idwarehouse_idInt11仓库id
店铺编号shop_no

String

20
店铺编号
店铺名称shop_name

String

40店铺名称
仓库编号

warehouse_no

String

40
仓库编号
换货详情
swap_order_detail_listList<Map<String, Object>>
换出订单明细
swap_order_detail_list




退换单id
refund_idInt11
退换单id
原始子单号oidString40原始子单号
货品类型target_typeInt4货品类型
换出货品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格式请求报文

PHP


6.响应示

   6.1 正常响应示例 

JSON


   6.2 异常响应示例

JSON



常用工具