当前位置： API文档

vip_api_refund_query.php（查询原始退款单）

¥增值

1.接口说明

1.1 接口描述：获取旺店通ERP的原始退款单信息
1.2 适用版本：客户端 V2.4.5.0及以上版本
1.3 增量获取：按照ERP原始退款单的最后修改时间增量获取数据，请求时输入start_time和end_time作为时间跨度的筛选条件。
1.4 时间跨度：start_time和end_time最大跨度为30天，开始时间和结束时间取值范围为闭区间取值，例如2018-11-01 00:00:00至2018-11-30 23:59:59，建议根据获取数据量的多少适当减小时间跨度。
1.5注意事项：本接口不返回淘系及系统供销平台订单数据，相关平台规则单击这里。淘系及系统供销平台敏感数据获取办法单击这里。其他平台的敏感信息会根据平台规则同步调整。

2.调用场景

2.1 数量分析系统对接

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境https://sandbox.wangdian.cn/openapi2/vip_api_refund_query.php
正式环境https://api.wangdian.cn/openapi2/vip_api_refund_query.php

    3.2 公共请求参数

名称字段类型长度
必须

描

述

卖家账号sidString
是购买ERP时由旺店通分配给ERP购买方，请从ERP购买方获取。
接口账号appkeyString
是本开放平台“自助对接”功能模块内自助申请，获取方式点击这里
时间戳timestampint
是北京时间1970-01-01 08:00:00起至现在的总秒数，10位int值,旺店通企业版API服务端允许请求最大时间误差为5min，date.timezone = Asia/Shanghai。
签名signString
是API输入参数签名结果，签名算法介绍单击这里

   3.3 业务请求参数

名称字段类型长度
必须描述
平台退款单号
refund_no
varchar
40
否
平台退款单号
原始单号
tid
varchar
40
否
平台订单号
平台id
platform_id
smallint6
否
平台id（必须与tid或refund_no同时使用）
店铺编号
shop_no
varchar40
否
店铺编号（暂不支持批量查询）
开始时间
start_time
datetime

是
按时间增量获取数据,start_time作为开始时间，格式：yyyy-MM-dd HH:mm:ss
结束时间
end_time
datetime

是
按时间增量获取数据,end_time作为开始时间，格式：yyyy-MM-dd HH:mm:ss
分页大小
page_size
int

否
不传值默认从0页开始每页返回的数据条数，输入值范围1~100，不传本参数，输入值默认为40，使用举例单击这里
页号
page_no
int

否

不传值默认从0页开始

时间类型time_typetinyint1否0:最后修改时间，1:退款时间。默认为0

4.响应参数

   4.1 公共响应参数

名称字段类型长度
必须描述
错误码codeint11是状态码:0表示成功,其他表示失败
错误描述messagevarchar255是错误描述
数据条数total_countint11是符合条件的数据条数，用来分页 当page_no = 0时返回
单据节点
trade_list
data[]
是数组形式的订单数据，需要循环读取

     4.2 业务响应参数

trade_list

名称字段类型长度
必须描述
平台id
platform_idsmallint6
是平台id
店铺编号
shop_no
varchar40
是店铺编号
平台退款编号
refund_no
varchar40
是平台退款编号
原始单号
tid
varchar40
是平台订单号
类型
type
tinyint
4
是类型：0.取消订单  1.退款（未发货退款） 2.退货  3.换货  4.退款不退货
平台状态
status
tinyint
4
是平台状态 0表示为空，1取消退款，2已申请退款，3等待退货，4等待收货，5退款成功，10换货待处理，20待买家退货，30买家已退货 待收货，40待买家修改，50待发出换货商品，55待买家收货，60换货改退货，70换货关闭，80换货成功
系统状态
process_status
tinyint
4
是系统状态：0.待递交  10.已取消  15.未递交  20.已递交  
AG操作状态
op_constraint
int
11
是AG操作状态：0.未回传  3.回传AG成功  4.回传AG失败
退款阶段
is_aftersale
tinyint
1
是是否是售后退款单据
客服介入
cs_status
tinyint
4
是客服介入：1.需要客服介入  2.客服已经介入  3.客服初审完成  4.客服主管复审失败  5.客服处理完成
交易类型
guarantee_mode
tinyint
4
是交易类型：1.担保交易  2.非担保交易  3.非担保在线交易
申请退款金额
refund_amount
decimal
(19,4)
是申请退款金额
实际退款金额
actual_refund_amount
decimal
(19,4)
是实际退款金额
退款原因
reason
varchar
255
是退款原因
备注
remark
varchar
255
是备注
退款标记掩码refund_maskint11是退款标记掩码   1024代表 在途退   仅限抖店
物流公司
logistics_name
varchar
40
是物流公司名称
物流单号
logistics_no
varchar
40
是物流单号
退款时间
refund_time
datetime

是退款时间  格式：yyyy-MM-dd HH:mm:ss
修改时间
modified
datetime

是修改时间  格式：yyyy-MM-dd HH:mm:ss
创建时间
created
datetime

是创建时间  格式：yyyy-MM-dd HH:mm:ss
退款成功时间
current_phase_timeout
datetime

是退款成功时间  格式：yyyy-MM-dd HH:mm:ss
店铺idshop_idint
11是默认为'0'，店铺
货品名称titlevarchar255是货品名称
外部退款单is_externaltinyint4是默认为'0'，外部退款单，未经ERP处理过的订单
退款idrefund_idbigint20是自动增量
支付订单号pay_novarchar60是默认为''，支付订单号
货品节点
goods_list
data[ ]

是货品节点
优惠节点
discount_listdata[ ]
是优惠节点

goods_list

名称字段类型长度
必须描述
平台id
platform_idsmallint6
是平台id
平台退款编号
refund_no
varchar40
是平台退款编号
子订单编号
oid
varchar40
是子订单编号

状态

status
tinyint4
是平台状态 0表示为空，1取消退款，2已申请退款，3等待退货，4等待收货，5退款成功，10换货待处理，20待买家退货，30买家已退货 待收货，40待买家修改，50待发出换货商品，55待买家收货，60换货改退货，70换货关闭，80换货成功
平台货品ID
goods_id
varchar40
是平台货品ID
平台规格ID
spec_id
varchar40
是平台规格ID
货品编码
goods_no
varchar40
是货品编码
规格编码
spec_no
varchar40
是规格编码
数量
num
decimal
(19,4)
是数量
单价
price
decimal
(19,4)
是单价
总金额
total_amount
decimal
(19,4)
是总金额
备注
remark
varchar
255
是备注
修改时间
modified
datetime

是修改时间  格式：yyyy-MM-dd HH:mm:ss
创建时间
created
datetime

是创建时间  格式：yyyy-MM-dd HH:mm:ss
货品名称goods_namevarchar255是默认为''，货品名称
规格名spec_namevarchar100是规格名
单据idorder_idint11是默认为'0'，单据id
退货时间return_timedatetime
是默认为'0000-00-00 00:00:00'，退货时间

discount_list

名称
字段类型长度必须描述
明细主键rec_idbigint20是明细主键（系统自增）
平台

platform_id

smallint6
是平台id
原始单号tid
varchar40是原始单号
原始子单号oid
varchar40是原始子订单编号
原始退款单号refund_novarchar40是原始退款单号
优惠名称namevarchar40是优惠名称
金额amountdecimal(19,4)是金额


5.请求示例

PHP
<?php
    require_once("../WdtClient.php");
    $c = new WdtClient;
    $c->sid = '';
    $c->appkey = '';
    $c->appsecret = '';
    $c->gatewayUrl = 'http://sandbox.wangdian.cn/openapi2/vip_api_refund_query.php';
 
    $c->putApiParam('start_time','2018-01-01 00:00:00');
    $c->putApiParam('end_time','2018-01-01 01:00:00');
    $json = $c->wdtOpenApi();
    var_dump($json);
     
?>
JAVA
package com.wangdian.api.refund;
 
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
 
import com.wangdian.api.WdtClient;
 
public class ApiRefundQuery {    //ApiRefundQuery可自定义
 
    public static void main(String[] args) {
        // TODO Auto-generated method stub
        WdtClient client = new WdtClient("传入sid", "传入appkey", "传入appsecret", "传入url");
        //测试环境sid、appkey、密钥请到旺店通开放平台-自助对接-申请测试环境内查看，测试环境url=https://sandbox.wangdian.cn/openapi2/                
        //调用正式环境时请将sid、appkey、appsecret切换为实际参数，参数在旺店通开放平台-自助对接-应用管理内应用状态为已上线的应用中查看，调用正式环境注意切换正式环境url=https://api.wangdian.cn/openapi2/
         
        Map<String, String> params = new HashMap<String, String>();
        params.put("start_time", "2018-12-11 12:00:00");
        params.put("end_time", "2018-12-11 13:00:00");
        params.put("page_size", "30");
        params.put("page_no", "0");
         
        try {
            String response = client.execute("vip_api_refund_query.php", params);
            System.out.println(response);
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }
 
}
C#
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using WdtSdk;
 
namespace ApiRefundQuery       //ApiRefund可自定义
{
    class ApiRefundQuery       //ApiRefund可自定义
    {
        static void Main(string[] args)
        {
            WdtClient client = new WdtClient();
            client.sid = "";
            client.appkey = "";
            client.appsecret = "";
            client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/vip_api_refund_query.php";
 
            client.putParams("start_time", "2018-12-23 06:02:02");
            client.putParams("end_time", "2018-12-23 06:05:02");
 
            string result = client.wdtOpenapi();
            Console.WriteLine(result);
            Console.ReadKey();
        }
    }
}
python
import WdtClient

t = WdtClient.WdtClient('appkey', 'appsecret', 'sid', 'http://sandbox.wangdian.cn/openapi2/')
params = {}
params.update({"start_time": '2021-01-01 00:00:00'})
params.update({"end_time": '2021-01-01 00:59:59'})
params.update({"page_size": '40'})
params.update({"page_no": '0'})

response = t.execute("vip_api_refund_query.php", params)
print(response)

6.响应示例

   6.1 正常响应示例 

JSON
{
    "code": 0,
    "message": "",
    "total_count": "3",
    "trade_list": [{
        "platform_id": "127",
        "shop_no": "jszc2-test",
        "refund_no": "12310054tuihuo",
        "tid": "wjw20190726002",
        "type": "2",
        "status": "4",
        "process_status": "20",
        "guarantee_mode": "1",
        "cs_status": "0",
        "op_constraint": "0",
        "refund_amount": "0.0000",
        "actual_refund_amount": "0.0000",
        "title": "",
        "logistics_name": "顺丰快递",
        "logistics_no": "588123679",
        "refund_time": "2019-07-29 11:36:57",
        "is_aftersale": "1",
        "reason": "",
        "remark": "",
        "modified": "2019-07-29 11:37:54",
        "created": "2019-07-29 11:37:54",
        "current_phase_timeout": "0000-00-00 00:00:00",
        "goods_list": [{
            "platform_id": "127",
            "refund_no": "12310054tuihuo",
            "oid": "wejweqwew222",
            "status": "4",
            "goods_id": "",
            "spec_id": "",
            "goods_no": "",
            "spec_no": "",
            "goods_name": "",
            "spec_name": "",
            "num": "1.0000",
            "price": "0.0000",
            "total_amount": "0.0000",
            "remark": "",
            "modified": "2019-07-29 11:37:54",
            "created": "2019-07-29 11:37:54"
        }]
    }, {
        "platform_id": "127",
        "shop_no": "jszc2-test",
        "refund_no": "wjwceshi0731001",
        "tid": "wjw20190726002",
        "type": "2",
        "status": "4",
        "process_status": "15",
        "guarantee_mode": "1",
        "cs_status": "0",
        "op_constraint": "0",
        "refund_amount": "100.0000",
        "actual_refund_amount": "100.0000",
        "title": "",
        "logistics_name": "",
        "logistics_no": "",
        "refund_time": "2019-07-30 09:47:37",
        "is_aftersale": "1",
        "reason": "",
        "remark": "",
        "modified": "2019-07-31 21:35:26",
        "created": "2019-07-31 21:35:26",
        "current_phase_timeout": "0000-00-00 00:00:00",
        "goods_list": [{
            "platform_id": "127",
            "refund_no": "wjwceshi0731001",
            "oid": "2019-07-30 09:47:37",
            "status": "4",
            "goods_id": "",
            "spec_id": "",
            "goods_no": "",
            "spec_no": "",
            "goods_name": "",
            "spec_name": "",
            "num": "2.0000",
            "price": "0.0000",
            "total_amount": "0.0000",
            "remark": "",
            "modified": "2019-07-31 21:35:26",
            "created": "2019-07-31 21:35:26"
        }]
    }, {
        "platform_id": "127",
        "shop_no": "jszc2-test",
        "refund_no": "wjwceshi07310012",
        "tid": "wjw20190726002",
        "type": "2",
        "status": "4",
        "process_status": "15",
        "guarantee_mode": "1",
        "cs_status": "0",
        "op_constraint": "0",
        "refund_amount": "100.0000",
        "actual_refund_amount": "100.0000",
        "title": "",
        "logistics_name": "",
        "logistics_no": "",
        "refund_time": "2019-07-30 09:47:37",
        "is_aftersale": "1",
        "reason": "",
        "remark": "",
        "modified": "2019-07-31 21:36:11",
        "created": "2019-07-31 21:36:11",
        "current_phase_timeout": "0000-00-00 00:00:00",
        "goods_list": [{
            "platform_id": "127",
            "refund_no": "wjwceshi07310012",
            "oid": "wejweqwew222",
            "status": "4",
            "goods_id": "",
            "spec_id": "",
            "goods_no": "",
            "spec_no": "",
            "goods_name": "",
            "spec_name": "",
            "num": "2.0000",
            "price": "0.0000",
            "total_amount": "0.0000",
            "remark": "",
            "modified": "2019-07-31 21:36:11",
            "created": "2019-07-31 21:36:11"
        }]
    }]
}

   6.2 异常响应示例

JSON
{
    "code": 1060,
    "message": "充值余额为0或应用已欠费，请联系商务充值 "
}



常用工具