taobao.fenxiao.refund.query (批量查询采购退款)

供应商按查询条件批量查询代销采购退款

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
start_date Date 必须 2000-01-01 00:00:00 查询退款单的修改时间开始,格式如:yyyy-MM-dd HH:mm:ss
end_date Date 必须 2000-01-01 00:00:00 查询退款单的修改时间结束,格式如:yyyy-MM-dd HH:mm:ss
page_no Number 可选 1
  • 默认值:1
  • 页码(大于0的整数。无值或小于1的值按默认值1计)
    page_size Number 可选 50
  • 默认值:50
  • 每页条数(大于0但小于等于50的整数。无值或大于50或小于1的值按默认值50计)
    query_seller_refund Boolean 可选 true 是否查询下游消费者的退款信息
    trade_types Number [] 可选 1
  • 最大列表长度:999
  • 查询的经营模式,当不指定时,默认查询代销订单 代销:1 经销:2 寄售(自营寄售):5 平台寄售
    user_role_type Number 可选 1 角色,供应商:2,分销商:1
    channel_codes Number [] 可选 1
  • 最大列表长度:999
  • 渠道市场编码,可批量指定。 当不指定时,按照配置的分销市场生效 渠道编码枚举:1-供销平台(淘宝);2-供销平台(天猫);3-供销平台(天猫超市);5-供销平台(淘乡甜);110001-供销平台(全球购);110007-淘分销;200002-消费电子市场
    refund_flow_types Number 可选 退款流程类型:4:发货前退款;1:发货后退款不退货;2:发货后退款退货;3:售后退款;5:拒收;6:售后退货退款

    响应参数

    名称 类型 示例值 描述
    total_results Number 120 按查询条件查到的记录总数
    refund_list RefundDetail [] 退款列表
    • └ sub_order_id
    • Number
    • 123
    • 分销子订单号,如果是by子单发起退款,就会在退款主单上记录分销子订单号
    • └ is_return_goods
    • Boolean
    • true
    • 是否退货,如果是已发货退货退款/售后退货退款,就是true
    • └ refund_create_time
    • Date
    • 2000-01-01 00:00:00
    • 退款创建时间
    • └ refund_status
    • Number
    • 5
    • 退款状态1:分销商已经申请退款,等待供应商确认2:供应商已经同意退货,等待分销商退货3:分销商已经退货,等待供应商确认收货4:退款关闭5:退款成功 6:供应商拒绝退款12:供应商同意退款,待系统打款 9:没有申请退款 10:供应商拒绝确认收货,待分销商重新修改
    • └ refund_fee
    • String
    • 100
    • 退款的金额(元)
    • └ pay_sup_fee
    • String
    • 20
    • 支付给供应商的金额(元),分销订单子单实付金额-退款金额
    • └ refund_reason
    • String
    • 协商一致退款
    • 退款原因
    • └ refund_desc
    • String
    • 111
    • 退款说明
    • └ distributor_nick
    • String
    • 张三
    • 分销商nick
    • └ supplier_nick
    • String
    • 张三
    • 供应商nick
    • └ modified
    • Date
    • 2000-01-01 00:00:00
    • 退款修改时间。格式:yyyy-MM-dd HH:mm:ss
    • └ purchase_order_id
    • Number
    • 952795279527
    • 分销主订单号
    • └ refund_flow_type
    • Number
    • 1
    • 退款流程类型:4:发货前退款;1:发货后退款不退货;2:发货后退款退货;3:售后退款;5:拒收;6:售后退货退款
    • └ timeout
    • Date
    • 2000-01-01 00:00:00
    • 超时时间
    • └ to_type
    • Number
    • 1
    • 超时类型: 1:供应商同意退款/同意退货超时; 2:供应商确认收货超时
    • buyer_refund
    • BuyerRefund
    • 前台消费者订单对应的退款详情
    • └ sub_order_id
    • Number
    • 123
    • 分销子订单号
    • └ refund_id
    • Number
    • 123
    • 消费者订单对应的退款单号
    • └ biz_order_id
    • Number
    • 123
    • 消费者订单退款涉及的消费者正向子订单号
    • └ refund_create_time
    • Date
    • 2000-01-01 00:00:00
    • 消费者订单退款创建时间
    • └ refund_status
    • Number
    • 9
    • 消费者订单退款状态 1、消费者已经申请退款,等待分销商确认 2、分销商已经同意退货,等待消费者退货 3、消费者已经退货,等待分销商确认收货 4、退款关闭 5、退款成功 6、分销商拒绝退款,待消费者重新修改 7、等待消费者确认重新邮寄的货物
    • └ goods_status_desc
    • String
    • 买家未收到货
    • 货物的状态:买家已收到货买家已退货买家未收到货
    • └ need_return_goods
    • Boolean
    • true
    • 买家是否退货
    • └ return_fee
    • Number
    • 120
    • 退还给消费者的金额(分)
    • └ to_seller_fee
    • Number
    • 120
    • 确认收货后会打款给分销商的金额(分),分摊到子单的实付金额-退款给消费者的金额
    • └ refund_reason
    • String
    • 协商一致
    • 消费者退款原因
    • └ refund_desc
    • String
    • 协商一致退款
    • 消费者退款说明
    • └ buyer_nick
    • String
    • 张三
    • 下游买家nick
    • └ modified
    • Date
    • 2000-01-01 00:00:00
    • 消费者退款修改时间。格式:yyyy-MM-dd HH:mm:ss
    • └ open_buyer_id
    • String
    • AHHJ-454545DHJ
    • 消费者买家id加密key
    • └ return_goods_quantity
    • Number
    • 22222
    • 消费者退货数量
    • └ refund_id
    • Number
    • 46786001252
    • 分销退款单号
    • return_logistics
    • RefundLogistics []
    • 退款明细项,记录退款涉及的订单
    • └ company_code
    • String
    • SF
    • 退货物流公司编码,如顺丰、韵达等
    • └ company_name
    • String
    • 顺丰
    • 退货物流公司名称,如顺丰
    • └ mail_no
    • String
    • 1111111
    • 退货物流运单号
    • refund_items
    • RefundItem []
    • 退款明细项,记录退款涉及的订单
    • └ refund_item_id
    • Number
    • 111111
    • 退款明细ID,针对一笔退款每一个品就映射为一个明细,每一个明细有一个全局唯一的ID
    • └ sub_order_id
    • Number
    • 23232323
    • 分销子订单号
    • └ refund_quantity
    • Number
    • 2
    • 退货数量

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    FenxiaoRefundQueryRequest req = new FenxiaoRefundQueryRequest();
    req.setStartDate(StringUtils.parseDateTime("2000-01-01 00:00:00"));
    req.setEndDate(StringUtils.parseDateTime("2000-01-01 00:00:00"));
    req.setPageNo(1L);
    req.setPageSize(50L);
    req.setQuerySellerRefund(true);
    req.setTradeTypes("1");
    req.setUserRoleType(1L);
    req.setChannelCodes("1");
    req.setRefundFlowTypes(L);
    FenxiaoRefundQueryResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <fenxiao_refund_query_response>
        <total_results>120</total_results>
        <refund_list>
            <refund_detail>
                <sub_order_id>123</sub_order_id>
                <is_return_goods>true</is_return_goods>
                <refund_create_time>2000-01-01 00:00:00</refund_create_time>
                <refund_status>5</refund_status>
                <refund_fee>100</refund_fee>
                <pay_sup_fee>20</pay_sup_fee>
                <refund_reason>协商一致退款</refund_reason>
                <refund_desc>111</refund_desc>
                <distributor_nick>张三</distributor_nick>
                <supplier_nick>张三</supplier_nick>
                <modified>2000-01-01 00:00:00</modified>
                <purchase_order_id>952795279527</purchase_order_id>
                <refund_flow_type>1</refund_flow_type>
                <timeout>2000-01-01 00:00:00</timeout>
                <to_type>1</to_type>
                <buyer_refund>
                    <sub_order_id>123</sub_order_id>
                    <refund_id>123</refund_id>
                    <biz_order_id>123</biz_order_id>
                    <refund_create_time>2000-01-01 00:00:00</refund_create_time>
                    <refund_status>9</refund_status>
                    <goods_status_desc>买家未收到货</goods_status_desc>
                    <need_return_goods>true</need_return_goods>
                    <return_fee>120</return_fee>
                    <to_seller_fee>120</to_seller_fee>
                    <refund_reason>协商一致</refund_reason>
                    <refund_desc>协商一致退款</refund_desc>
                    <buyer_nick>张三</buyer_nick>
                    <modified>2000-01-01 00:00:00</modified>
                    <open_buyer_id>AHHJ-454545DHJ</open_buyer_id>
                    <return_goods_quantity>22222</return_goods_quantity>
                </buyer_refund>
                <refund_id>46786001252</refund_id>
                <return_logistics>
                    <refund_logistics>
                        <company_code>SF</company_code>
                        <company_name>顺丰</company_name>
                        <mail_no>1111111</mail_no>
                    </refund_logistics>
                </return_logistics>
                <refund_items>
                    <refund_item>
                        <refund_item_id>111111</refund_item_id>
                        <sub_order_id>23232323</sub_order_id>
                        <refund_quantity>2</refund_quantity>
                    </refund_item>
                </refund_items>
            </refund_detail>
        </refund_list>
    </fenxiao_refund_query_response>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部