获取退款列表
查询卖家收到的退款列表
查询卖家收到的退款列表
一、请求参数
请求URL:
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| appid | String | 合作伙伴AppId | uwkahf@jfs92 |
| timestamp | String | 当前时间戳 | |
| tb_seller_nick | String | 淘宝卖家店铺登录账号,非店铺名称 | kingdo |
| status | String | 非必填,退款状态,默认查询所有退款状态的数据,除了默认值外每次只能查询一种状态。WAIT_SELLER_AGREE(买家已经申请退款,等待卖家同意) WAIT_BUYER_RETURN_GOODS(卖家已经同意退款,等待买家退货) WAIT_SELLER_CONFIRM_GOODS(买家已经退货,等待卖家确认收货) SELLER_REFUSE_BUYER(卖家拒绝退款) CLOSED(退款关闭) SUCCESS(退款成功) | |
| buyer_nick | String | 非必填,买家昵称 | |
| type | String | 非必填, 交易类型列表,一次查询多种类型可用半角逗号分隔,默认同时查询guarantee_trade, auto_delivery这两种类型的数据 | |
| start_modified | Date | 非必填, 查询修改时间开始。格式: yyyy-MM-dd HH:mm:ss | |
| end_modified | Date | 非必填, 查询修改时间结束。格式: yyyy-MM-dd HH:mm:ss | |
| page_no | int | 非必填,页码。取值范围:大于零的整数; 默认值:1 | |
| page_size | int | 非必填,每页条数。取值范围:大于零的整数; 默认值:40;最大值:100 | |
| use_has_next | boolean | 非必填, 是否启用has_next的分页方式,如果指定true,则返回的结果中不包含总记录数,即total_results为0,但是会新增一个是否存在下一页的的字段,通过此种方式获取增量退款,接口调用成功率在原有的基础上有所提升。 | |
| sign | String | 接口签名 | 如何计算生成见示例代码 |
| refund_id | String | 退款单号 | 比如106322832633563058 |
| sysid | String | 代表不同的应用,具体请咨询客服,否则接口会调用失败 | 100 |
二、请求示例代码
Java
@Test public void getRefundReceive() throws Exception { String tb_seller_nick = Config.TBSellerNick ; //业务参数 Map<String, String> data = new HashMap<String, String>(); data.put("appid", Config.AppId); Long timestamp = System.currentTimeMillis() / 1000; data.put("timestamp", timestamp.toString()); data.put("tb_seller_nick", tb_seller_nick); // 退款状态 ,如果要全部状态的话,不要传入字段status data.put("status", "WAIT_SELLER_AGREE"); data.put("start_modified", "2021-01-01 00:00:00"); data.put("end_modified", "2021-04-01 00:00:00"); data.put("page_no", "1"); data.put("page_size", "30"); data.put("use_has_next", "true"); // data.put("sysid", "103"); // 签名 data.put("sign", Utils.Sign(data,Config.AppSecret)); // 调用服务API doHttpRequest(Config.TaoBaoRefunReceiveUrl ,data);
}三、返回结果
{ "code": 0, "message": "ok", "data": { "has_next": false, "refunds": [{ "buyer_nick": "我是买家", "created": "2021-03-22 14:33:49", "desc": "", "good_status": "BUYER_NOT_RECEIVED", "has_good_return": false, "modified": "2021-03-23 14:34:04", "oid": "1645829892702565830", "order_status": "TRADE_CLOSED", "payment": "0.00", "reason": "不想要或拍多了", "refund_fee": "48.00", "refund_id": "106322832633563058", "refund_phase": "onsale", "seller_nick": "百鞋馆", "status": "SUCCESS", "tid": "1645829892702565830", "title": "真皮男士增高鞋男高帮工装鞋-api23", "total_fee": "48.00", "company_name": "", // 物流公司名称 "sid": "", // 退货运单号 "sku": "", // 商品SKU信息 "attribute": "", // 退款扩展属性 "outer_id": "", //商品外部商家编码 "operation_contraint": "" // 退款约束,可选值:cannot_refuse(不允许操作),refund_onweb(需要到网页版操作) }] , "request_id": "719j2mar72pa", "total_results": 1 }}说明: code为0表示成功,非0为失败,message会包含失败原因。
| 返回字段 | 类型 | 说明 |
|---|---|---|
| good_status | string | 货物状态。可选值BUYER_NOT_RECEIVED (买家未收到货) BUYER_RECEIVED (买家已收到货) BUYER_RETURNED_GOODS (买家已退货) |
| order_status | string | 退款对应的订单交易状态。可选值TRADE_NO_CREATE_PAY(没有创建支付宝交易) WAIT_BUYER_PAY(等待买家付款) WAIT_SELLER_SEND_GOODS(等待卖家发货,即:买家已付款) WAIT_BUYER_CONFIRM_GOODS(等待买家确认收货,即:卖家已发货) TRADE_BUYER_SIGNED(买家已签收,货到付款专用) TRADE_FINISHED(交易成功) TRADE_CLOSED(交易关闭) TRADE_CLOSED_BY_TAOBAO(交易被淘宝关闭) ALL_WAIT_PAY(包含:WAIT_BUYER_PAY、TRADE_NO_CREATE_PAY) ALL_CLOSED(包含:TRADE_CLOSED、TRADE_CLOSED_BY_TAOBAO) 取自”http://open.taobao.com/dev/index.php/%E4%BA%A4%E6%98%93%E7%8A%B6%E6%80%81" |
| status | string | 退款状态。可选值WAIT_SELLER_AGREE(买家已经申请退款,等待卖家同意) WAIT_BUYER_RETURN_GOODS(卖家已经同意退款,等待买家退货) WAIT_SELLER_CONFIRM_GOODS(买家已经退货,等待卖家确认收货) SELLER_REFUSE_BUYER(卖家拒绝退款) CLOSED(退款关闭) SUCCESS(退款成功) |
| has_good_return | bool | 买家是否需要退货”判断, true为退款退货,false仅退款。 |